
XXL-JOB官网:分布式任务调度平台XXL-JOB
配置文件
xxl:
job:
admin:
# 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
addresses: http://127.0.0.1:8080/xxl-job-admin
# 执行器通讯TOKEN [选填]:非空时启用;
accessToken:
executor:
# 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
appname:
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip:
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 9999
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logpath: /data/applogs/xxl-job/jobhandler
# 执行器日志保存天数 [选填] :值大于3时生效,启用执行器Log文件定期清理功能,否则不生效;
logretentiondays: -1
JobHandler业务实现类
package org.etoak;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
@JobHandler(value = "MyJobHandler")
public class MyJobHandler extends IJobHandler {
@Override
public ReturnT execute(String taskParam) {
System.out.println(">>>>>>>>>定时任务begin*********************");
return SUCCESS;
}
}
正常向xxl-admin注册jobHandler的方式有两种,官网这样描述
如果已经正确进行上述配置,可将执行器项目编译打部署,系统提供多种执行器Sample示例项目,选择其中一个即可,各自的部署方式如下。
- xxl-job-executor-sample-springboot:项目编译打包成springboot类型的可执行JAR包,命令启动即可;
- xxl-job-executor-sample-frameless:项目编译打包成JAR包,命令启动即可;
要么是以web容器运行,要么以jar包运行,最终的目的就是要java进程一直保持运行。
其实通过XxlJobSpringExecutor可以自动扫描带@JobHandler的IJobHandler实现类来向xxl-admin进行注册,但是有些业务场景需要手动注册
手动注册代码如下:
// ...
// 配置需要注册的实现类(多个,比如: com.etoak.实现类1,org.etoak.实现类2)
// 反射生成实现类的实例clazz
// ...
// 有@JobHandler的类实例,注册为jobHandler
JobHandler jobHandlerAnnotation = clazz.getAnnotation(JobHandler.class);
if (jobHandlerAnnotation != null) {
String jobHandlerAnnotationName = jobHandlerAnnotation.value();
if (StringUtils.hasLength(jobHandlerAnnotationName)) {
BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
//注册Bean
defaultListableBeanFactory.registerBeanDefinition(jobHandlerAnnotationName, beanDefinitionBuilder.getBeanDefinition());
IJobHandler handler = (IJobHandler) o;
if (XxlJobExecutor.loadJobHandler(jobHandlerAnnotationName) != null) {
logger.error(">>>>>>>>>>>>>>>>>>>>>JobHandler名称【{}】已被注册,请检查!", jobHandlerAnnotationName);
}
XxlJobExecutor.registJobHandler(jobHandlerAnnotationName, handler);
logger.info(">>>>>>>>>>>>>>>>>>>>>注册JobHandler成功【{}】", jobHandlerAnnotationName);
} else {
logger.error(">>>>>>>>>>>>>>>>>>>>>【{}】的@JobHandler字段value为空,请检查!", clazzName);
}
}