XXL-JOB分布式任务调度平台

开始 XXL-JOB

XXL-JOB 是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

源码仓库地址：

• https://github.com/xuxueli/xxl-job
• http://gitee.com/xuxueli0323/xxl-job

拉取代码

代码结构如下：

运行 SQL 文件至本地数据库：

修改 xxl-job-admin 模块的 properties 文件：

#数据库信息片段
#都是我自己本机的username和password
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=1
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

启动任务调度中心

xxl-job-admin 模块中，直接运行 XxlJobAdminApplication 即可启动。

启动之后浏览器访问默认地址：http://localhost:8080/xxl-job-admin

默认初始状态下，账号：admin 密码：123456 。

登录成功

如下图：

到此为止，第一阶段 xxl-job-admin 模块的部署就完成啦。

整合 SpringBoot 项目

此部分官方已经给出具体案例，我们只需对赶方案例进行整合或修改即可。

接下来就是如何整合到自己的 SpringBoot 项目中。

引入 maven 依赖

注：此处 version 应于 xxl-job-admin 中版本保持一致。例如，我本机测试下载的时候是 2.4.0 版本。

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version>
</dependency>

引入配置类

只需引入 XxlJobConfig.java 配置类即可：

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;

    @Value("${xxl.job.accessToken}")
    private String accessToken;

    @Value("${xxl.job.executor.appname}")
    private String appname;

    @Value("${xxl.job.executor.address}")
    private String address;

    @Value("${xxl.job.executor.ip}")
    private String ip;

    @Value("${xxl.job.executor.port}")
    private int port;

    @Value("${xxl.job.executor.logpath}")
    private String logPath;

    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;


    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppname(appname);
        xxlJobSpringExecutor.setAddress(address);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

        return xxlJobSpringExecutor;
    }

}

修改 yml 或者 properties 配置文件

yml 或者是 properties 文件大差不差的。

#调度中心部署跟地址，如调度中心集群部署存在多个地址则用逗号分隔
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

#执行器通讯TOKEN
xxl.job.accessToken=default_token

#执行器AppName，执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample

#执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。
xxl.job.executor.address=

#执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP
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

编写测试类

如下：

@Component
public class MyXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);

    @XxlJob("testJobHandler")
    public void testJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        for (int i = 0; i < 5; i++) {
            System.out.println("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
    }
}

注：重要的点就是 @XxlJob 注解的应用。

编写完成后，启动服务！（注意启动顺序，先启动 xxl-job-admin 模块，再启动您的 springboot 服务）

任务调度中心，配置服务

①新增执行器：

其中，AppName 就是刚才 yml 或者 properties 里面配置的 AppName 属性，保持一致。注册方式，选择“自动注册”即可，如果选择“手动录入”，需要找到执行器所配置的地址手动录入。

②新增任务：

③执行任务：

注：测试的时候，”执行一次“即可，如果后续没有问题，点击”启动“保持一致运行。

④查看运行结果：

23:02:54.445 logback [xxl-job, EmbedServer bizThreadPool-358357423] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job regist JobThread success, jobId:2, handler:com.xxl.job.core.handler.impl.MethodJobHandler@460510aa[class com.xxl.job.executor.service.jobhandler.MyXxlJob#testJobHandler]
beat at:0
beat at:1
beat at:2
beat at:3
beat at:4

到此，XXL-JOB 与 SpringBoot 的简单整合入门教程就完成了。

ethodJobHandler@460510aa[class com.xxl.job.executor.service.jobhandler.MyXxlJob#testJobHandler]
beat at:0
beat at:1
beat at:2
beat at:3
beat at:4

到此，XXL-JOB 与 SpringBoot 的简单整合入门教程就完成了。