Spring Boot整合xxl-job实现定时任务

一、下载源码

GitHub - xuxueli/xxl-job: A distributed task scheduling framework.（分布式任务调度平台XXL-JOB）

xxl-job-admin 》调度中心

xxl-job-core 》核心包

下载完之后，在 doc/db 目录下有数据库脚本，在自己本地数据库执行脚本

修改application.properties，配置datasource为你本地的数据库地址，访问端口号等

启动xxl-job-admin，登录地址：http://127.0.0.1:6060/xxl-job-admin

用户名/密码：admin/123456

二、打包xxl-job-core

//命令打包
mvn package

在target文件夹下生成xxl-job-core-2.4.1-SNAPSHOT.jar

三、SpringBoot项目引入xxl-job

（1）pom引包

<!--该包需要手动加到maven本地仓库-->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-codec-http</artifactId>
    <version>4.1.106.Final</version>
</dependency>
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.10.1</version>
</dependency>

（2）修改application.properties

######xxl-job
xxl.job.admin.addresses=http://127.0.0.1:6060/xxl-job-admin
xxl.job.accessToken=default_token
xxl.job.executor.appname=demo
xxl.job.executor.address=
xxl.job.executor.ip=
xxl.job.executor.port=9999
xxl.job.executor.logpath=/home/ap/justsy/logs/xxl-job
xxl.job.executor.logretentiondays=30

（3）创建XxlJobConfig

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class XxlJobConfig {

    @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
    public XxlJobSpringExecutor xxlJobExecutor() {
        // 创建 XxlJobSpringExecutor 执行器
        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;
    }
}

（4）XxlJobHandler

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

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

    /**
     * 更新状态
     **/
    @XxlJob("UpdateStatus")
    public void updateStatus() {
        String jobParam = XxlJobHelper.getJobParam();
        logger.info("任务执行" + jobParam);
    }

}

（5）启动项目

（6）登录任务调度中心

点击“执行器管理”菜单，点击“新增”，输入AppName（对应application.properties文件配置的xxl.job.executor.appname的值），注册方式为“手动录入”，机器地址填写本机地址加端口号（对应application.properties文件配置xxl.job.executor.port的值），点击“保存”；

点击“任务管理”菜单，点击“新增”，其中注意JobHandler的值为XxlJobHandler类中的@XxlJob("UpdateStatus")对应的名称“UpdateStatus”，点击“保存”；

点击“操作”列中的“执行一次”，输入机器地址（执行器管理中的添加的机器地址），点击“保存”；

如果想按照定时任务执行，则启动状态即“状态”列显示“RUNNING”；

控制台会看到任务执行输出：任务执行第一次执行任务，说明执行成功

可在“调度日志”菜单中查看调度结果

最后该定时任务的执行频次、执行规则，甚至执行时传递的参数都可以通过管理平台进行操作，还是太方便。