概念理解:
xx-job是一个分布式任务调度平台。比如你有AB两个项目。
AB的定时任务就要在xx-job上个注册。同时AB要配置对应的依赖。
所以集成xx-job要分2步骤:第一步:先搭建xx-job服务
第二步,在A项目中导包并引用。
第一步:搭建xx-job服务
0.下载jar
地址:
Xxl-job项目地址:
GitHub地址:https://github.com/xuxueli/xxl-job
Gitee地址:https://gitee.com/xuxueli0323/xxl-job
1导入idea
2执行数据库脚本。创建数据库
3修改项目配置文件
4启动xxjobadmin
5访问地址
http://localhost:8080/xxl-job-admin/
用户名admin 密码123456
第二步:A项目(springboot项目)基本xx-job;
2.1导包:
<!-- SpringBoot集成Xxl-Job --><dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.3.0</version></dependency>
2.2创建配置类
package com.example.springbootjdbc.config;import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** @ClassName: XxlJobConfig* @Description: xxl-job依赖配置* @author:* @date: 2022年12月07日 08:37* @version: 1.0*/
@Configuration //是否开启xxl-job定时任务,注释掉 //@Configuration 则不开启定时任务
@Data
@Slf4j
public class XxlJobConfig {@Value("${xxl.job.admin.addresses}")private String adminAddresses;@Value("${xxl.job.accessToken}")private String accessToken;@Value("${xxl.job.executor.appname}")private String appname;@Value("${xxl.job.executor.address}")private String address;@Value("${xxl.job.executor.ip}")private String ip;@Value("${xxl.job.executor.port}")private int port;@Value("${xxl.job.executor.logpath}")private String logPath;@Value("${xxl.job.executor.logretentiondays}")private int logRetentionDays;@Beanpublic XxlJobSpringExecutor xxlJobExecutor() {XxlJobHelper.log(">>>>>>>>>>> xxl-job config init.>>>>>>>>>>>");System.out.println("=============== xxl-job config init.===============");XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();xxlJobSpringExecutor.setAdminAddresses(adminAddresses);xxlJobSpringExecutor.setAppname(appname);xxlJobSpringExecutor.setAddress(address);xxlJobSpringExecutor.setIp(ip);xxlJobSpringExecutor.setPort(port);xxlJobSpringExecutor.setAccessToken(accessToken);xxlJobSpringExecutor.setLogPath(logPath);xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);return xxlJobSpringExecutor;}
}
2.3修改yml文件 application.yml
# Xxl-Job分布式定时任务调度中心
xxl:job:admin:# 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。addresses: http://localhost:8080/xxl-job-admin# addresses: http://192.168.110.2:9090/xxl-job-admin# 执行器通讯TOKEN [选填]:非空时启用 系统默认 default_tokenaccessToken: default_tokenexecutor:# 执行器的应用名称appname: mls-xxl-job# 执行器注册 [选填]:优先使用该配置作为注册地址address: ""# 执行器IP [选填]:默认为空表示自动获取IPip: ""# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999port: 9999# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;logpath: D:\Codes\logs#logpath: /data/logs/mls/job# 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;logretentiondays: 7
2.4编写测试
package com.example.springbootjdbc.controller.job;import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;/*** @ClassName: XxlJobTest* @Description: XxlJobTest* @author:* @date: 2022年12月07日 12:58* @version: 1.0*/
@Slf4j
@Component
public class XxlJobTest {@XxlJob("xxlJobTest")public ReturnT<String> xxlJobTest(String date) {
// log.info("---------xxlJobTest定时任务执行成功--------");ssXxlJobHelper.log("xxlJobTest定时任务执行成功");return ReturnT.SUCCESS;}}
2.5添加执行器
2.6添加任务
2.7启动项目后执行测试并查看日志
2.9启动项目后执行测试并查看日志后在查看执行日志