Xxl-Job定时任务案例

前言

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

源码仓库地址:
https://gitee.com/xuxueli0323/xxl-job
https://github.com/xuxueli/xxl-job
官网地址:
https://www.xuxueli.com/xxl-job

一、数据库准备

执行XXL-Job下的sql文件，调度数据库初始化SQL脚本” 位置为：

/xxl-job/doc/db/tables_xxl_job.sql

XXL-Job项目SQL脚本如下图所示：

XXL-Job连接的数据库及表结构

在application.peoperties文件中配置连接本地数据库

二、启动项目

项目访问地址：http://localhost:8080/xxl-job-admin/

当前项目默认有一个sample执行器，项目未启动，所以没有注册到xxl-job-admin上

启动默认执行器后，看到已经成功注册上

XXL-Job默认有一个测试任务1

执行这个测试任务

三、搭建一个SpringBoot定时任务

（1）新建项目，导入XXL-Job核心依赖

<!-- 项目版本号跟下载的xxl-job项目版本号一直即可 -->
<!-- xxl-job-core -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.1-SNAPSHOT</version>
</dependency>

（2）yml文件配置xxl-job

xxl:
  job:
    admin:
      # XXL-Job 访问地址
      addresses: http://127.0.0.1:8080/xxl-job-admin
    accessToken: default_token
    # 配置执行器信息
    executor:
      appname: xxl-Job-Demo   //执行器名称
      address:
      ip:
      port: 9976
      logpath:
      logretentiondays: 30

logging:
  config: classpath:logback.xml

（3）添加XxlJon配置类

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

/**
 * xxl-job config
 *
 * @author xuxueli 2017-04-28
 */
@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;
    }

    /**
     * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
     *
     *      1、引入依赖：
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置文件，或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */


}

（4）在接口方法上添加@XxlJob注解

import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloWorldController {

    @GetMapping("/hello")
    @XxlJob("xxlJobDemoTest") // 任务名称
    public void Hello(){
        System.out.println("Hello World!!!!!!!");
    }
}

（5）在XxlJob项目中添加执行器和任务

开启测试任务后，查看控制台输出

测试成功

---

结语

Xxl-Job分布式调度平台简单来说，为开发人员提供一个定时执行任务的框架。开发人员只需构建执行器（由谁来执行这个任务），将执行器注册到调度平台后，然后再定义执行任务（做什么功能），由调度平台统一管理执行器和任务。