Spring Cloud集成XXL-job以及简单封装

本文源码地址：源码地址

说到分布式定时任务，第一反应还是Quartz，毕竟是开源定时任务的大佬。相对来说也比较熟悉，是通过操作API的方式来进行操作。

但是今天我要介绍的是在国内的大佬在Quartz上面增强的的一个分布式定时任务框架：XXL-Job。至于为啥叫这个名字，是因为作者名字叫许雪里。

项目的地址：https://gitee.com/xuxueli0323/xxl-job

下面是大佬提供的Quartz和XXL-job的对比（原文参考：对比）

Quartz的不足

问题一：调用API的的方式操作任务，不人性化；
问题二：需要持久化业务QuartzJobBean到底层数据表中，系统侵入性相当严重。
问题三：调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况加，此时调度系统的性能将大大受限于业务；
问题四：quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务，会导致节点负载悬殊非常大；而XXL-JOB通过执行器实现“协同分配式”运行任务，充分发挥集群优势，负载各节点均衡。
XXL-JOB弥补了quartz的上述不足之处。

XXL-JOB特性

• 简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手
• 动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效
• 调度中心HA（中心式）：调度采用中心式设计，“调度中心”基于集群Quartz实现并支持集群部署，可保证调度中心HA
• 执行器HA（分布式）：任务分布式执行，任务"执行器"支持集群部署，可保证任务执行HA
• 注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址
• 弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务
• 路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等
• 故障转移：任务路由策略选择"故障转移"情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。
• 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度
• 任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务
• 任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试
• 任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式
• 分片广播任务：执行器集群部署时，任务路由策略选择"分片广播"情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务
• 动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度
• 事件触发：除了"Cron方式"和"任务依赖方式"触发任务执行之外，支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务，可根据业务事件灵活触发
• 任务进度监控：支持实时监控任务进度
• Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志
• GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯
• 脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本
• 命令行任务：原生提供通用命令行任务Handler（Bean任务，"CommandJobHandler"）；业务方只需要提供命令行即可
• 任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔
• 一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行
• 自定义任务参数：支持在线配置调度任务入参，即时生效
• 调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞
• 数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性
• 邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件
• 推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用
• 运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等
• 全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行
• 跨平台：原生提供通用HTTP任务Handler（Bean任务，"HttpJobHandler"），业务方只需要提供HTTP链接即可，不限制语言、平台
• 国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文
• 容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用
• 线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入"Slow"线程池，避免耗尽调度线程，提高系统稳定性

下面说下集成思路，我个人比较习惯使用源码集成，下面是大体的starter的项目结构图

首先job-core-provider是直接拷贝的xxl-job-core。这个核心包没有动。

job-admin-center是调度中心

首先配置文件修改：

server:
  port: 8666
  servlet:
    context-path: /xxl-job
  #数据源配置
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      minimum-idle: 10
      maximum-pool-size: 30
      auto-commit: true
      idle-timeout: 30000
      pool-name: HikariCP
      max-lifetime: 900000
      connection-timeout: 10000
      connection-test-query: SELECT 1
  #邮箱配置
  mail:
    host: smtphz.qiye.163.com
    port: 994
    username: [email protected]
    password: zwass1314
    properties:
      mail:
        smtp:
          auth: true
          starttls:
            enable: true
            required: true
          socketFactory:
            class: javax.net.ssl.SSLSocketFactory
  #MVC配置
  mvc:
    servlet:
      load-on-startup: 0
    static-path-pattern: /static/**
  resources:
    static-locations: classpath:/static/
  #freemarker配置
  freemarker:
    templateLoaderPath=classpath: /templates/
    suffix: .ftl
    charset: UTF-8
    request-context-attribute: request
    settings:
      number_format: 0.##########
#通用配置，开放端点
management:
  server:
    servlet:
      context-path: /actuator
  health:
    mail:
      enabled: false
#mybatis配置
mybatis:
  mapper-locations: classpath:/mybatis-mapper/*Mapper.xml
#XXL-job配置
xxl:
  job:
    login:
      username: admin
      password: 123456
    accessToken:
    i18n: zh_CN
    #触发池
    triggerpool:
      fast:
        max: 200
      slow:
        max: 100
    logretentiondays: 30

如果在微服务里面，可以直接注册到注册中心上去，完成权限的统一认证。这里暂时没处理，只是改了几个配置，还是保留单独的验证方式。

job-spring-boot-autoconfigure配置

   
        
            com.yzc
            job-core-provider
            ${project.version}
        
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-configuration-processor
            true
        
        
            org.springframework.boot
            spring-boot-autoconfigure
        
    

核心config配置

@Slf4j
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;


    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        log.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppName(appName);
        if(StringUtils.isBlank(ip)){
            ip = getServerIp();
        }
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);

        return xxlJobSpringExecutor;
    }

    /**
     * 获取本地IP
     * @return
     */
    private String getServerIp(){
        try {
            String ip =  InetAddress.getLocalHost().getHostAddress();
            log.info("Ip："+ip);
            return ip;
        }catch (Exception e){
            return null;
        }
    }
}

装配指定

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.XXLJobConfig

这样吧执行器就构造成了一个starter包，在需要引用的服务里面引入starter

        
            com
            job-spring-boot-starter
            ${project.version}
        

那么构造定时任务有以下2种方式

1、实现接口的方式（已过期，因为一个类不能支出多个定时任务）

@Component
@JobHandler(value = "demoHandler")
public class DemoHandler extends IJobHandler {

    @Override
    public ReturnT execute(String param) throws Exception {
        System.out.println("1111");
        return null;
    }
}

2、纯注解方式

@Component
public class Demo2Handler {

    @XxlJob(value = "demo2Job")
    public ReturnT demo2JobHandler(String param) throws Exception{
        System.out.println("demo2");
        return ReturnT.SUCCESS;
    }

}

配置响应的参数

xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8666/xxl-job
    executor:
      appname: ${spring.application.name}
      ip:
      port: 9999
    accessToken:

启动调度和执行器