前言:
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。
核心依赖:
<dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version> 2.4 . 0 </version> </dependency> |
任务开发:
1、在Spring Bean实例中,开发Job方法;
2、注解配置:为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
3、执行日志:需要通过 "XxlJobHelper.log" 打印执行日志;
4、任务结果:默认任务结果为 "成功" 状态,不需要主动设置;如有诉求,比如设置任务结果为失败,可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果;
示例代码:
@Component public class SampleXxlJob { /** * 简单任务示例(Bean模式) */ @XxlJob ( "demoJobHandler" ) public void demoJobHandler() throws Exception { XxlJobHelper.log( "XXL-JOB, Hello World." ); } } |
调度中心
新建执行器
后台界面新建调度任务(长期任务,或者平台级任务,使用此方式)
AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式:调度中心获取执行器地址的方式;
自动注册:执行器自动进行执行器注册,调度中心通过底层注册表可以动态发现执行器机器地址;
手动录入:人工手动录入执行器的地址信息,多地址逗号分隔,供调度中心使用;
机器地址:"注册方式"为"手动录入"时有效,支持人工维护执行器的地址信息;
RestFulApi新建调度任务(一次性任务,或者企业级任务,使用此方式)
此方式需要传请求头 XXL-JOB-ACCESS-TOKEN 值同配置文件中xxl.job.accessToken
客户端配置文件参考:
### xxl-job调度中心地址,多个用 "," 英语逗号分割 xxl.job.admin.addresses=http: //192.168.13.178:15000/xxl-job-admin ### xxl-job, access token请求xxljob开放接口时使用 xxl.job.accessToken=default_token ### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册 xxl.job.executor.appname=shop ### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。 xxl.job.executor.address= ### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务" ; xxl.job.executor.ip= ### 执行器端口号 [选填]:小于等于 0 则自动获取;默认端口为 9999 ,单机部署多个执行器时,注意要配置不同执行器端口; xxl.job.executor.port= 9999 ### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径; xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler ### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于 3 时生效; 否则, 如- 1 , 关闭自动清理功能; xxl.job.executor.logretentiondays= 30 |
测试:
1.先确认客户端已成功注册执行器
2.执行调度操作
3.查看执行情况:
4.查看日志