千家信息网

SpringBoot项目集成xxljob的示例分析

发表于:2024-10-11 作者:千家信息网编辑
千家信息网最后更新 2024年10月11日,小编给大家分享一下SpringBoot项目集成xxljob的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!xxlj
千家信息网最后更新 2024年10月11日SpringBoot项目集成xxljob的示例分析

小编给大家分享一下SpringBoot项目集成xxljob的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!

xxljob介绍

XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。

被称为任务调度中心,可做定时任务。

优点特性如下:

1、简单:支持通过Web页面对任务进行CRUD操作,操作简单,一分钟上手;
2、动态:支持动态修改任务状态、启动/停止任务,以及终止运行中任务,即时生效;
3、调度中心HA(中心式):调度采用中心式设计,"调度中心"自研调度组件并支持集群部署,可保证调度中心HA;
4、执行器HA(分布式):任务分布式执行,任务"执行器"支持集群部署,可保证任务执行HA;
5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时,也支持手动录入执行器地址;
6、阻塞处理策略:调度过于密集执行器来不及处理时的处理策略,策略包括:单机串行(默认)、丢弃后续调度、覆盖之前调度;
7、任务超时控制:支持自定义任务超时时间,任务运行超时将会主动中断任务;
8、任务失败重试:支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;其中分片任务支持分片粒度的失败重试;
9、任务失败告警;默认提供邮件方式失败告警,同时预留扩展接口,可方便的扩展短信、钉钉等告警方式;
10、任务进度监控:支持实时监控任务进度;
11、Rolling实时日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志;
12、自定义任务参数:支持在线配置调度任务入参,即时生效;
13、数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性;
14、邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;

官网地址:XXL开源社区 | 项目

代码配置过程

1.引入xxl-job的依赖

     com.xuxueli     xxl-job-core     2.0.1

2.编写配置文件

xxl:  job:    admin:      addresses: http://d-xxljob.dmsd.tech:8081/job-admin-dev  #xxljob调度中心部署  例如:http://127.0.0.1:8080/xxl-job-admin    executor:      appname: testJob #xxljob配置的执行器名称,      ip:             #执行器IP,默认为空表示自动获取IP      port: 9999 #xxljob配置的端口号,默认为9999      logpath: /data/xxl-job/jobhandler  #执行器运行日志文件存储磁盘路径      logretentiondays: -1  #调度中心日志表数据保存天数,过期日志自动清理;限制大于等于7时生效,否则, 如-1,关闭自动清理功能    accessToken: #调度中心通讯TOKEN [选填]:非空时启用

3. 编写配置类

/** * xxl-job 定时器配置,读取配置文件中的内容 * * @author 张有博 * @version 0.0.1 * @since 2021年11月14日 */@Configuration@ComponentScan(basePackages = "com.dmsdbj.integral.zentao.provider.job")//配置需要扫描的job类@Slf4jpublic class XxlJobConfig {     @Value("${xxl.job.admin.addresses}")    private String adminAddresses;     @Value("${xxl.job.executor.appname}")    private String appName;     @Value("${xxl.job.executor.ip}")    private String ip;     @Value("${xxl.job.executor.port}")    private int port;     @Value("${xxl.job.accessToken}")    private String accessToken;     @Value("${xxl.job.executor.logpath}")    private String logPath;     @Value("${xxl.job.executor.logretentiondays}")    private int logRetentionDays;       @Bean(initMethod = "start", destroyMethod = "destroy")    public XxlJobSpringExecutor xxlJobExecutor() {        log.info(">>>>>>>>>>> xxl-job config init.");        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);        xxlJobSpringExecutor.setAppName(appName);        xxlJobSpringExecutor.setIp(ip);        xxlJobSpringExecutor.setPort(port);        xxlJobSpringExecutor.setAccessToken(accessToken);        xxlJobSpringExecutor.setLogPath(logPath);        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);         return xxlJobSpringExecutor;    } }

4.新建Job文件夹,将自己写的类放到此文件夹下

XxlJobConfig类,要扫描的包做对应

5. 编写业务代码

package com.dmsdbj.integral.zentao.provider.job; import com.xxl.job.core.biz.model.ReturnT;import com.xxl.job.core.handler.IJobHandler;import com.xxl.job.core.handler.annotation.JobHandler;import com.xxl.job.core.log.XxlJobLogger;import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Component; /** * XXLJob的测试类,需要继承IJobHandler类 * * @author Promsing(张有博) * @version 1.0.0 * @since 2021/11/14 - 19:51 */@Slf4j@Component@JobHandler(value = "TestJob") //与xxl-job上的jobHandler做对应public class TestJob extends IJobHandler {    /**     * execute handler, invoked when executor receives a scheduling request     *     * @param param     * @return     * @throws Exception     */    @Override    public ReturnT execute(String param)  {        XxlJobLogger.log(this.getClass().getSimpleName() + "--start");        try {            System.out.println("业务代码1");            System.out.println("业务代码2");            System.out.println("业务代码3");            System.out.println("业务代码4");            System.out.println("业务代码5");        } catch (Exception e) {            log.error(e.getMessage(), e);            throw e;        }        XxlJobLogger.log(this.getClass().getSimpleName() + "--end");        return ReturnT.SUCCESS;    }}

登录xxl-Job并配置

1.执行器管理--新增执行器

2.任务管理--新增任务

配置的参数如下:

这里推荐一个解析Cron的网站:在线Cron表达式生成器

测试:

断点调试

查看调度日志:

xxlJob的配置过程不是很复杂,但是需要细心。

以上是"SpringBoot项目集成xxljob的示例分析"这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注行业资讯频道!

0