springboot 整合xxl-job 入门

名词说明

调度中心：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。类似微服务的注册中心。

执行器：任务的实现者。负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。

安装部署

docker部署

1.下载镜像

    // Docker地址：https://hub.docker.com/r/xuxueli/xxl-job-admin/     (建议指定版本号目前最新版本为2.3.1)
    docker pull xuxueli/xxl-job-admin

  2.创建容器并运行

    docker run -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:{指定版本}
    /**
    * 如需自定义 mysql 等配置，可通过 "-e PARAMS" 指定，参数格式 PARAMS="--key=value  --key2=value2" ；
    * 配置项参考文件：/xxl-job/xxl-job-admin/src/main/resources/application.properties
    * 如需自定义 JVM内存参数 等配置，可通过 "-e JAVA_OPTS" 指定，参数格式 JAVA_OPTS="-Xmx512m" ；
    */
    docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:{指定版本}

3.访问管理后台

调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

项目配置

1.maven依赖引入

pom文件中引入了 “xxl-job-core” 的maven依赖；

    
         com.xuxueli
         xxl-job-core
         ${version.xxljob}
    

2.springboot配置文件application.yml 中xxl-job配置

xxl:
  job:
    ### 执行器通讯TOKEN [选填]：非空时启用；
    accessToken:
    admin:
      ## 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
      addresses: http://10.63.15.154:8152/xxl-job-admin
    executor:
      ## 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      address:
      ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      appname: ${spring.application.name}
      ### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      ip:
      ### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logpath: /data/apps/logs/xxl-job/${spring.application.name}
      ### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
      logretentiondays: 30
      ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      port: 9090

注意：

1、这里的accessToken 要与xxl-job-admin后台配置的要一致。

2、若果服务器多网卡，需要手动指定ip，配置xxl.job.executor.ip。

3.执行器组件配置

通过java类型XxlJobConfig.java配置

package cc.canv.xmf.config;

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

/**
 * @Author: a
 * @Description:
 * @Date: 2022/7/19 13:45
 * @Version: 1.0
 */
@Configuration
@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;

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

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

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        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.BEAN模式方法任务开发

代码如下

package com.moguo.xxljob;

import com.moguo.common.core.base.Result;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

/**
 * @Author: a
 * @Description:
 * @Date: 2022/9/19 13:47
 * @Version: 1.0
 */
@Component
@Slf4j
public class XxlJobDemo {

    @XxlJob("xxlJobDemoJobHandler")
    public Result xxlJobDemoJobHandler(){
        log.info("这是我的第一个xxljob...........");
        return Result.success("xxlJob执行成功");
    }
}

5、springboot项目打包运行。

备注：

执行器支持集群部署，提升调度系统可用性，同时提升任务处理能力。

执行器集群部署时，几点要求和建议：

• 执行器回调地址（xxl.job.admin.addresses）需要保持一致；执行器根据该配置进行执行器自动注册等操作。
• 同一个执行器集群内AppName（xxl.job.executor.appname）需要保持一致；调度中心根据该配置动态发现不同集群的在线执行器列表。

6、配置执行器。

登录调度中心，进入执行器管理菜单

 点击新增

说明：

1. AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
2. 名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
3. 注册方式：调度中心获取执行器地址的方式；
4. 自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
5. 手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
6. 机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；

保存以后，执行器springboot服务运行成功，在列表可以查看。

 7、配置任务

登录调度中心，进入任务管理菜单

 点击新增按钮

配置说明：

1. 基础配置：
   1. - 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;
   2. - 任务描述：任务的描述信息，便于任务管理；
   3. - 负责人：任务的负责人；
   4. - 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
2. 触发配置：
   1. - 调度类型：
      1. 无：该类型不会主动触发调度；
      2. CRON：该类型将会通过CRON，触发任务调度；
      3. 固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；
   2. - CRON：触发任务执行的Cron表达式；
   3. - 固定速度：固件速度的时间间隔，单位为秒；
3. 任务配置：
   1. - 运行模式：
      1. BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
      2. GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
      3. GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
      4. GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
      5. GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
      6. GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
      7. GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
   2. - JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
   3. - 执行参数：任务执行所需的参数；
4. 高级配置：
   1. - 路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
      1. FIRST（第一个）：固定选择第一个机器；
      2. LAST（最后一个）：固定选择最后一个机器；
      3. ROUND（轮询）：；
      4. RANDOM（随机）：随机选择在线的机器；
      5. CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
      6. LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
      7. LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
      8. FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
      9. BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
      10. SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
   2. - 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
   3. - 调度过期策略：
      1. - 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
      2. - 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
   4. - 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
      1. 单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
      2. 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
      3. 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
   5. - 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
   6. - 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

8、测试

任务管理列表，点击执行一次按钮

提示 执行一次成功。点击查询日志

 

 显示成功。

结束

        本次整合参考xxl-job官网手册（分布式任务调度平台XXL-JOB）完成，文档很详细，实现起来也不复杂。过程中花了点时间的两个点是：1、没有仔细阅读配置说明，执行器的配置文件accessToken和调度中心服务的accessToken没有对应，导致执行器一直注册失败。2、还是配置问题，我的执行器和调度中心不在同一台服务器上，部署执行器的服务器上有docker容器，导致注册到调度中心的执行器地址为容器的ip，任务执行失败。