xxl-job分布式任务调度平台

XXL-JOB

首选可以先去XXL-JOB官网了解下项目
本文基于XXl_JOB中2.1.2介绍,配置在easyboot中使用方法

源码仓库地址

源码仓库地址	下载
https://github.com/xuxueli/xxl-job	Download
http://gitee.com/xuxueli0323/xxl-job	Download

环境

• Maven3+
• Jdk1.7+
• Mysql5.7+

然后创建数据库，将对应的sql脚步初始化
初始化脚本在doc/db下

并且修改application.properties对应的数据库连接信息.
xxl-job2.1.2基于Spring boot 1.5开发

EasyBoot如何接入XXL-JOB

首先你在yaml配置文件中添加如下配置

xxl:
  job:
    # 执行器通讯TOKEN [选填]：非空时启用；
    access-token:
    admin:
      # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；(注意要修改为对应调度中心的地址)
      address: http://localhost:8080/xxl-job-admin
    executor:
      # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      app-name: easyboot-xxl-job-executor
      # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      ip:
      # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      port: 8888
      # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      log-path: logs/easyboot-xxl-job-executor/task-log
      # 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
      log-retention-days: -1

关于上面字段中文意思可以去参考 XXL-JOB官网

然后新增XxlJobProps.java类

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import com.zf.easyboot.modules.xxlJob.config.props.XxlJobProps;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author 疯信子
 * @version 1.0
 * @date 2020/1/8.
 */
@Slf4j
@Configuration
@EnableConfigurationProperties(XxlJobProps.class)
@RequiredArgsConstructor(onConstructor_ = @Autowired)
public class XxlJobConfig {
    private final XxlJobProps xxlJobProps;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        log.info(">>>>>>>>>>> xxl-job config init.>>>>>");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(xxlJobProps.getAdmin().getAddress());

        xxlJobSpringExecutor.setAppName(xxlJobProps.getExecutor().getAppName());
        xxlJobSpringExecutor.setIp(xxlJobProps.getExecutor().getIp());
        xxlJobSpringExecutor.setPort(xxlJobProps.getExecutor().getPort());
        xxlJobSpringExecutor.setLogPath(xxlJobProps.getExecutor().getLogPath());
        xxlJobSpringExecutor.setLogRetentionDays(xxlJobProps.getExecutor().getLogRetentionDays());

        xxlJobSpringExecutor.setAccessToken(xxlJobProps.getAccessToken());

        return xxlJobSpringExecutor;
    }

}	

XxlJobProps.java

	import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author 疯信子
 * @version 1.0
 * @date 2020/1/8.
 */
@Data
@ConfigurationProperties(prefix = "xxl.job")
public class XxlJobProps {
    /**
     * 调度中心配置
     */
    private XxlJobAdminProps admin;

    /**
     * 执行器配置
     */
    private XxlJobExecutorProps executor;

    /**
     * 与调度中心交互的accessToken
     */
    private String accessToken;

    @Data
    public static class XxlJobAdminProps {
        /**
         * 调度中心地址
         */
        private String address;
    }

    @Data
    public static class XxlJobExecutorProps {
        /**
         * 执行器名称
         */
        private String appName;

        /**
         * 执行器 IP
         */
        private String ip;

        /**
         * 执行器端口
         */
        private int port;

        /**
         * 执行器日志
         */
        private String logPath;

        /**
         * 执行器日志保留天数，-1
         */
        private int logRetentionDays;
    }
}

以上配置就可以完成Easyboot对接XXL-JOB接入

下面就可以简单创建一个Task任务测试下

import cn.hutool.core.date.DateUtil;
import cn.hutool.core.util.RandomUtil;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import com.xxl.job.core.util.ShardingUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

/**
 * @author 疯信子
 * @version 1.0
 * @date 2020/1/8.
 */
@Component
@Slf4j
public class DemoTask {

    @XxlJob("demoTask")
    public ReturnT<String> demoJobHandler(String param) throws Exception {
        log.info("【param】= {}", param);
        XxlJobLogger.log("demo task run at : {}", DateUtil.now());
        return RandomUtil.randomInt(1, 11) % 2 == 0 ? ReturnT.SUCCESS : ReturnT.FAIL;
    }

    /**
     * 分片广播任务
     * @param param
     * @return
     * @throws Exception
     */
    @XxlJob("shardingJobHandler")
    public ReturnT<String> shardingJobHandler(String param) throws Exception {

        // 分片参数
        ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
        XxlJobLogger.log("分片参数：当前分片序号 = {}, 总分片数 = {}",
                shardingVO.getIndex(), shardingVO.getTotal());

        log.info("分片参数：当前分片序号 = {}, 总分片数 = {}",
                shardingVO.getIndex(), shardingVO.getTotal());

        // 业务逻辑
        for (int i = 0; i < shardingVO.getTotal(); i++) {
            if (i == shardingVO.getIndex()) {
                XxlJobLogger.log("第 {} 片, 命中分片开始处理", i);
            } else {
                XxlJobLogger.log("第 {} 片, 忽略", i);
            }
        }

        return ReturnT.SUCCESS;
    }


}

项目开启成功，观察控制台是否打印xxl-job config init.

XXL-JOB任务配置

我们先打开配置的XXL-JOB的调度中心xxl-job-admin项目
http://localhost:8080/xxl-job-admin/toLogin
账号/密码“admin/123456”, 登录后运行界面如下图所示。

首先我们移动到执行器管理中新增执行器

备注：
上面中AppName对应是EeasyBoot中yml配置文件中
app-name: easyboot-xxl-job-executor
完成之后，刷新就可以新建连接器对应的服务器ip地址
下面就可以移动到对应任务管理菜单中，
新增任务

注意JobHandler对应的就是我们java中的@XxlJob(“shardingJobHandler”)中的名字。以上就完成了Easyboot接入XXL-JOB接入。
下面补充一张XXL-JOB架构图

XXL-JOB架构图

以上代码都可以从我开源的项目获取对应的源码

项目源码

	后端代码	前端代码
github	https://github.com/zengfen0708/easy-boot	https://github.com/zengfen0708/easy-boot-web
码云（没翻墙的用户下载）	https://gitee.com/zf0708/easyboot	https://gitee.com/zf0708/easy-boot-web

反馈交流

本人是第一次分享项目,该项目还存在很多不足,欢迎各位大佬指点,Pull Requests，和我一起完善该项目

QQ 群号：769191321