Spring Boot 整合 xxl-job

官方文档：https://www.xuxueli.com/xxl-job/
XXL-JOB 是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。
说明：官方文档很重要，而且非常详细，要慢慢适应看官方文档进行学习！
PS：下面搭建和整合流程是基于项目需求进行整理的，和普通学习流程一致，就是有一些命名没那么测试化，自行体会。

xxl-job 环境搭建

1. 下载

下载地址：https://github.com/xuxueli/xxl-job/releases
建议：直接下载最新版，如目前我下的是 2.4.0，之前的 2.3.0 用的有问题。
说明：下载解压后，使用 IDEA 打开。
2. 数据库表导入

SQL 位置：doc/db/tables_xxl_job.sql
说明：导入到自己的数据库中。
3. 修改配置数据

说明：以下两个配置必须修改，否则启动报错！

3.1 修改 application.properties

配置文件位置：xxl-job-admin 下的 src/main/resources/application.properties

1. server.port=7397 #【自选】，修改后，后面自己执行器项目配置中需要对应换改的这个端口
3. # 数据源配置信息，对应改成自己的。
4. spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
5. spring.datasource.username=root
6. spring.datasource.password=luis
7. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
9. # 【重要！说明：此 accessToken xxl-job 配置了默认的，你自己的执行器项目中 accessToken 必须保持一致】
10. xxl.job.accessToken=default_token

复制代码

3.2 修改 logback.xml

日志配置文件位置：xxl-job-admin 下的 src/main/resources/logback.xml

1. [/code][size=3]4. 运行访问[/size]
3. 运行 xxl-job-admin 下的主启动类启动项目，浏览器输入地址访问：http://localhost:7397/xxl-job-admin/toLogin
4. PS：若是免登陆的，则忽略下面账号密码。
5. 默认登陆账号：admin
6. 默认登陆密码：123456
7. [size=3]5. 其他[/size]
9. 这里简单说明下，xxl-job-executor-samples 下有两个示例执行器模板项目，有多种任务使用方式，后续可自行参考模板项目以及官方文档，进行学习使用，下面直接介绍 Spring Boot 中简单使用 XXL-JOB。
10. [size=4]Spring Boot 整合 XXL-JOB[/size]
12. [indent]新建 Spring Boot 项目，准备进行整合。
13. [/indent][size=3]1. 添加 pom[/size]
15. [code]<dependency>
16.     <groupId>com.xuxueli</groupId>
17.     <artifactId>xxl-job-core</artifactId>
18.     <version>2.4.0</version>
19. </dependency>

复制代码

2. 添加配置信息

几个核心配置：服务地址、应用名称、端口、日志路径

1. # xxl-job
2. # 官网：https://github.com/xuxueli/xxl-job/
3. # 地址：http://localhost:7397/xxl-job-admin 【需要先启动 xxl-job】
4. # 账号：admin
5. # 密码：123456
6. xxl:
7.   job:
8.     admin:
9.       ### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
10.       addresses: http://127.0.0.1:7397/xxl-job-admin
11.     executor:
12.       ### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
13.       address:
14.       ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
15.       appname: lottery-job
16.       ### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
17.       ip:
18.       ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
19.       port: 9998
20.       ### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
21.       logpath: D:/1a-Projects/lw-projects/tool-projects/xxl-job-2.3.0/data/applogs/xxl-job/jobhandler
22.       ### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
23.       logretentiondays: 50
24.     ### 执行器通讯TOKEN [选填]：非空时启用；
25.     accessToken: default_token

复制代码

3. 添加配置类

1. @Configuration
2. public class LotteryXxlJobConfig {
4.     private Logger logger = LoggerFactory.getLogger(LotteryXxlJobConfig.class);
6.     @Value("${xxl.job.admin.addresses}")
7.     private String adminAddresses;
9.     @Value("${xxl.job.accessToken}")
10.     private String accessToken;
12.     @Value("${xxl.job.executor.appname}")
13.     private String appname;
15.     @Value("${xxl.job.executor.address}")
16.     private String address;
18.     @Value("${xxl.job.executor.ip}")
19.     private String ip;
21.     @Value("${xxl.job.executor.port}")
22.     private int port;
24.     @Value("${xxl.job.executor.logpath}")
25.     private String logPath;
27.     @Value("${xxl.job.executor.logretentiondays}")
28.     private int logRetentionDays;
30.     @Bean
31.     public XxlJobSpringExecutor xxlJobExecutor() {
32.         logger.info(">>>>>>>>>>> xxl-job config init.");
34.         XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
35.         xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
36.         xxlJobSpringExecutor.setAppname(appname);
37.         xxlJobSpringExecutor.setAddress(address);
38.         xxlJobSpringExecutor.setIp(ip);
39.         xxlJobSpringExecutor.setPort(port);
40.         xxlJobSpringExecutor.setAccessToken(accessToken);
41.         xxlJobSpringExecutor.setLogPath(logPath);
42.         xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
44.         return xxlJobSpringExecutor;
45.     }
47.     /**********************************************************************************************
48.      * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
49.      *
50.      *      1、引入依赖：
51.      *          <dependency>
52.      *             <groupId>org.springframework.cloud</groupId>
53.      *             <artifactId>spring-cloud-commons</artifactId>
54.      *             <version>${version}</version>
55.      *         </dependency>
56.      *
57.      *      2、配置文件，或者容器启动变量
58.      *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
59.      *
60.      *      3、获取IP
61.      *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
62.      **********************************************************************************************/
63.    
64. }

复制代码

4. 添加任务类

1. @Component
2. public class LotteryXxlJob {
4.     private Logger logger = LoggerFactory.getLogger(LotteryXxlJob.class);
5.        
6.     // 简单任务
7.     @XxlJob("lotteryActivityStateJobHandler")
8.     public void lotteryActivityStateJobHandler() throws Exception {
10.         logger.info("我是被 xxl-job 自动调用执行的任务！");
12.     }
14. }

复制代码

5. 启动项目

PS：必须保证 xxl-job 项目先正常启动，并且任务调度中心可访问。此项目必须后启动！
6. 任务调度中心配置任务

说明：必须先创建执行器，再创建任务！

6.1 新增执行器

访问任务调度中心：http://localhost:7397/xxl-job-admin/
进入执行器管理，新增执行器，填写信息：

• AppName ：填自己 Spring Boot 项目中配置的 appname，如上面项目的 lottery-job
  
• 名称：随便写，即执行器名
  
• 注册方式：选自动注入
  

然后保存即可！
6.2 新增任务

进入任务管理，新增任务，填写信息：

• 执行器：选择上步中填写的执行器名称
  
• 任务描述：自行描述
  
• 负责人：xxx
  
• 调度类型：CRON
  
• CRON 表达式：自行定制，如 0/1 * * * * ?，表示每秒执行一次
  
• 运行模式：BEAN
  
• JobHandler：填上面 Spring Boot 项目任务类方法上 @XxlJob 注解中的名称，如：lotteryActivityStateJobHandler
  

然后保存即可！（其中有些配置可自行设置）
7. 任务操作

在任务管理下，可对新增的任务进行操作，如启动、执行一次等
点击启动或执行一次后，可观察 Spring Boot 项目后台任务的日志打印情况，测试验证。
以上，整合完成。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！