#XxlJob 使用说明
- 分布式任务调度平台XXL-JOB
- 本地环境 XXL-JOB 部署在127.0.0.1 上,访问地址:127.0.0.1:9056/xxl-job-admin/
账号密码:admin/123456。 - XXL-JOB 需要配置执行器与任务调度
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OQiy92Hq-1641285406108)(xxl-job执行器配置.jpg)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vukI96GH-1641285406109)(xxl-job任务配置.jpg)] - 项目中使用maven 引入相关依赖,该依赖直接放到了pom.xml中中,在项目模块中在单独引用
最外层pom.xml:
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>${xxl.job-core.version}</version>
</dependency>
项目模块单独引用pom.xml:
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
</dependency>
4.项目中通过在bootstrap.yml 中配置,使用XXL-JOB
jhjcn:
job:
### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
adminAddresses: http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用;
accessToken:
executor:
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
appName: xxl-job-executor-sample
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
address:
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip:
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 9999
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logPath: /data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
logRetentionDays: 30
- 执行器组件,配置内容说明,获取配置信息进行容器注入,在项目模块中在单独在config包中引用
/**
* @Deacription
* @Author H,yi
* @Date 2021-12-29
**/
@Slf4j
@ConditionalOnProperty(prefix = "job", value = "enable", matchIfMissing = true)
@Configuration
public class XxlJobConfig {
@Value("${jhjcn.job.adminAddresses}")
private String adminAddresses;
@Value("${jhjcn.job.accessToken}")
private String accessToken;
@Value("${jhjcn.job.executor.appname}")
private String appName;
@Value("${jhjcn.job.executor.address}")
private String address;
@Value("${jhjcn.job.executor.ip}")
private String ip;
@Value("${jhjcn.job.executor.port}")
private int port;
@Value("${jhjcn.job.executor.logpath}")
private String logPath;
@Value("${jhjcn.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
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;
}
}
- 请在XxlJobConfig.java中头部引入注解@ConditionalOnProperty(prefix = “job”, value = “enable”, matchIfMissing = true),使用配置文件进行控制是否开启,
请在需要增加请在xxl-job的nacos中增加以下配置
### enable中的true||false来控制是否启用XxlJobConfig.java中的配置注入
job:
enable: true
- XxlJob简单任务示例(Bean模式)
@XxlJob("demoJobHandler")
public ReturnT<String> jobHandler(String param){
...业务代码
return ReturnT.SUCCESS;
}