SpringBoot项目接入分布式任务调度平台xxl-job（2.0.2）说明
简介
如果是单体项目，定时任务写到项目中就能满足需要，当需要部署集群的时候就会出现问题，接入统一的任务调试平台是一个不错的选择。接入xxl-job挺简单的，只需要几步，好记性不如烂笔头，记录一下步骤，方便以后使用。
本次使用软件的相关版本：
xxl-job版本：2.0.2
spring-boot：2.3.6.RELEASE
操作步骤：
1、在需要接入项目的pom.xml中添加xxl-job的引用
<!--xxl-job--> <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.0.2</version> </dependency>
2、在application.yml中添加xxl-job相关配置
# XXL-JOB相关配置
xxl:
job:
accessToken:
admin:
addresses: http://192.168.110.180:8888/xxl-job-admin
executor:
appname: ai-data-mining-service
address:
ip:
port: 9993
logpath: ./log
logretentiondays: 10
解释一下其中的名词
accessToken：是安全令牌，用于验证执行器（executor）和调度中心（admin）之间的通信，这里为空，意味着没有设置安全令牌；
addresses：是xxl-job调度中心的地址；
appname：是要接入的项目的执行器的名称，用于标识该执行器；
address：是执行器的地址，通常用于手动注册执行器，留空表示自动获取；
ip：执行器的 IP 地址，通常用于手动注册执行器的 IP 地址，留空表示自动获取；
port：执行器的端口号，用于执行器服务的监听端口；
logpath：日志存储路径，执行器运行的日志文件将存储在这个路径中；
logretentiondays：日志保留天数，表示日志文件的保留时间，单位为天。
3、在项目中添加配置类
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* XXL作业配置
*
* @author
* @date
*/
@Configuration
@Slf4j
public 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、实现xxl-job的IJobHandler接口
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.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
/**
* @author
* @date
*/
@JobHandler(value = "DmAiPromptWordsJob")
@Component
@RequiredArgsConstructor
@Slf4j
public class DmAiPromptWordsJobHandler extends IJobHandler {
@Override
public ReturnT<String> execute(String s) throws Exception {
log.info("项目日志打印");
XxlJobLogger.log("xxl-job日志打印");
return ReturnT.SUCCESS;
}
}
其中@JobHandler(value = "DmAiPromptWordsJob")，注解用来标识这个类是一个 xxl-job 的任务处理器
5、在xxl-job管理界面中新增执行器，如下图：
注册方式，选择“自动注册”
6、在对应的执行器中添加任务管理，如下图：
重点填写红色框的部分即可；
总结
按照步骤操作之后，定时任务就自动运行了，这样的话部项目署集群也不受影响了，目前xxl-job也存在集群的问题，后续再研究。
