定时任务xxl-job的使用

概述

在应用单实例部署的情况下，定时任务使用SpringTask很方便，有@Schedule注解即可。但是在应用集群部署的情况下，会出现定时任务在多个实例上同时执行的情况。

所以，需要选择一个支持分布式的定时任务框架，大概有如下选择：

Elastic-Job
当当开源，需要依赖zookeeper。
xxl-job
大众点评的某个员工开源，依赖数据库。

xxl-job官网文档

SpringCloudDemo中有相关代码，见：http://git.guahao-inc.com/hsa/hsa-demo/spring-cloud-svc-demo.git

测试环境地址：http://192.168.99.44:8080/xxl-job-admin/

用户名/密码：admin/123456
总体来说，应用向xxl-job-admin注册任务，xxl-job-admin负责调度。

标题开发流程

1.应用引用xxl-job相关jar包，按照规范编写定时任务代码，具体见：应用侧-----编写定时任务
2.程序启动后，到xxl-job-admin管理台配置，添加执行器，配置任务执行参数，配置一次即可。具体见：xxl-job-admin侧----配置

应用侧-----编写定时任务

增加依赖

<dependency>
       <groupId>com.xuxueli</groupId>
       <artifactId>xxl-job-core</artifactId>
       <version>${最新稳定版本}</version>
</dependency>

增加配置

xxl-job 调度中心地址，多台使用","分隔

 xxl.job.admin.addresses=http://127.0.0.1:8089/xxl-job-admin,http://127.0.0.1:8080/xxl-job-admin
 # xxl-job 执行器appname -- 项目名字
 xxl.job.executor.appname=hsa-spp-sdc-demo
 # xxl-job 执行器ip -- 项目ip，不配置由调度中心自动扫描
 xxl.job.executor.ip=
 # xxl-job 执行器host
 xxl.job.executor.port=9998
 # xxl-job 调度中心通讯TOKEN，非空时启用
 xxl.job.accessToken=
 # xxl-job 执行器运行日志文件存储磁盘路径(需要对该路径拥有读写权限)
 # 为空则使用默认路径:/data/applogs/xxl-job/jobhandler
 xxl.job.executor.logpath=hsa-spp-sdc/log
 # xxl-job 执行器运行日志文件保存天数：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效
 xxl.job.executor.logretentiondays=-1

SpringBean配置

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
    @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() {
        logger.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;
    }
}

定时任务代码编写

继承 IJobHandler类，增加注解@JobHandler，重写 execute(String param) 方法

@Slf4j
@JobHandler(value = "demoJobHandler")
@Component
public class DemoJobHandler extends IJobHandler {
    @Override
    public ReturnT<String> execute(String param) throws Exception {
        XxlJobLogger.log("XXL-JOB, Hello World.");
        log.error("定时任务测试");
        for (int i = 0; i < 5; i++) {
            XxlJobLogger.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        return SUCCESS;
    }
}

xxl-job-admin侧----配置

应用侧按照规范，开发完定时任务后，需要到xxl-job-admin管理界面做一些配置，如下：
添加执行器
一般情况下，应用本身就是定时任务的执行器，比如线上A应用部署了4台实例，那么可以让xxl-job-admin自动检测到所有的实例，也可以选择部分实例执行定时任务。

打开执行器管理菜单

新增执行期

添加完成后，可以查看到目前在线的机器，如下：

添加任务

选择刚刚创建的执行器，添加任务

验证
可以手动启动任务，如下：

查看log