springboot整合xxl-job 分布式任务调度

2022-11-10 21:59:52 浏览数 (2)

什么是xxl-job

  • xxl-job是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
  • 官网:https://www.xuxueli.com/xxl-job/

特性

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

快速入门

  • 下载需要的版本 https://github.com/xuxueli/xxl-job/
  • 下载jar包,进行解压,使用idea打开
  • 打开doc,找到sql文件,在mysql中运行该脚本文件

注意:调度中心支持集群部署,集群情况下各节点务必连接同一个mysql实例,如果mysql做主从,调度中心集群节点务必强制走主库

  • 调度中心访问地址:http://localhost:8085/xxl-job-admin (该地址执行器将会使用到,作为回调地址),这里我们把端口修改为8085
  • 使用账号admin 密码123456 进行登录

这时候,调度中心已经大功告成了,可以使用了,接下来就是与springboot进行整合

springboot进行整合

  • 导入pom
代码语言:javascript复制
		<dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.3.0</version>
        </dependency>
  • appliaction.yml中加上如下配置
代码语言:javascript复制
xxl:
  job:
    accessToken:
    admin:
      addresses: http://127.0.0.1:8095/xxl-job-admin 
    executor:
      address:
      appname: xxl-job-invoice-api
      ip:
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30
      port: 10001
代码语言:javascript复制
addresses:调度中心地址[选填],如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调",为空则关闭自动注册

appname:执行器 [选填],执行器心跳注册分组依据,为空则关闭自动注册
ip:默认为空表示自动获取,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用,地址信息用于 “执行器注册” 和 “调度中心请求并触发任务”
port:执行器端口号 [选填],小于等于0则自动获取,默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口
logpath:执行器运行日志文件存储磁盘路径 [选填] ,需要对该路径拥有读写权限,为空则使用默认路径
logretentiondays:执行器日志保存天数 [选填] ,值大于3时生效,启用执行器Log文件定期清理功能,否则不生效

accessToken:执行器通讯[选填],非空时启用
  • 执行器配置
代码语言:javascript复制
@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;
    }
}
  • 这时配置已经做好了,可以编写定时任务了
代码语言:javascript复制
package com.xxl.job.executor.service.jobhandler;

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;

import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;

/**
 * XxlJob开发示例(Bean模式)
 *
 * 开发步骤:
 *      1、任务开发:在Spring Bean实例中,开发Job方法;
 *      2、注解配置:为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
 *      3、执行日志:需要通过 "XxlJobHelper.log" 打印执行日志;
 *      4、任务结果:默认任务结果为 "成功" 状态,不需要主动设置;如有诉求,比如设置任务结果为失败,可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果;
 *
 * @author xuxueli 2019-12-11 21:52:51
 */
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i  ) {
            XxlJobHelper.log("beat at:"   i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }
}
  • 我们去调度中心进行配置执行器
  • 配置任务

到这里,spring boot整合xxl-job已经可以上线使用了

xxl-job 原理

  • xxl-job 架构设计
  • 总体分两个部分
  1. 调度中心:负责管理调度信息,按照调度配置发出调度请求,自身不承担业务代码。调度系统和任务解耦,提高了系统可用性和稳定性。通调度性能不在受限于任务模块。
  2. 执行器:负责接收调度中的请求并执行任务逻辑。任务模块专注于任务的执行操作,开发和运维更加简单和高校。
  • 设计思想

调度和任务两个部分相互解耦,全异步化和轻量化,可以提高系统的稳定性和扩展性。

  • 执行器注册
  1. 执行器启动主要是把自己注册到调度中心然后保存在数据库(xxl_job_registry表),并定时发送心跳,保持续约。执行器正常关闭,也主动告知调度中心注销,这种是主动注册。
  2. 如果执行器网络故障,调度中心就不知道执行器的情况,如果把任务路由给一个不可用的执行器,就会导致任务失败。所以调度中心需要不断的对执行器探活(RocketMQ的NameServer 管理broker一样),调度中心会启动一个后台线程定时调用执行器接口,如果发现异常就下线。
  • 调度中心和任务执行
  1. JobRegistryMonitorHelper 不停的更新注册表,把超时的执行器剔除(每隔30s执行一次)
  2. 创建线程池 调度器线程ScheduleThread:计算预读取的任务数(默认6000),然后while 循环不停的获取到期的任务 时间轮线程池
  3. 获取任务锁:第一步获取数据库排它锁,如果没有成功说明其他的调度中心在加载任务
  4. 查询任务:获取锁后, 查询任务
  5. 调度任务
  6. 任务触发,选择执行器:按照配置的路由策略,不通路由策略获取方式也不一样
  7. 远程执行:拿到执行器之后,runExecutor 触发远程的执行器
  8. 执行器处理远程调用,回调
  • mysql 排它锁的获取

实现手动加锁,如果 select,语句包含主键,for update,效果为行锁,否则为表锁,xxl-job 创建 xxl_job_lock,表用于实现分布式锁。

代码语言:javascript复制
CREATE TABLE `xxl_job_lock` (
  `lock_name` varchar(50) NOT NULL COMMENT '锁名称',
  PRIMARY KEY (`lock_name`)
) ENGINE=InnoDB;

INSERT INTO `xxl_job_lock` ( `lock_name`) VALUES ( 'schedule_lock');
  • 实现数据库锁的代码
代码语言:javascript复制
Connection conn = null;
Boolean connAutoCommit = null;
PreparedStatement preparedStatement = null;

boolean preReadSuc = true;
try {

 conn = XxlJobAdminConfig.getAdminConfig().getDataSource().getConnection();
 connAutoCommit = conn.getAutoCommit();
 conn.setAutoCommit(false);

 preparedStatement = conn.prepareStatement(  "select * from xxl_job_lock where lock_name = 'schedule_lock' for update" );
 preparedStatement.execute();

 // do something
} catch (Exception e) {
                        
} finally {

    // commit
    if (conn != null) {
        try {
            conn.commit();
        } catch (SQLException e) {
                                
        }
        try {
            conn.setAutoCommit(connAutoCommit);
        } catch (SQLException e) {
                                
        }
        try {
            conn.close();
        } catch (SQLException e) {
                                
        }
    }

    // close PreparedStatement
    if (null != preparedStatement) {
        try {
            preparedStatement.close();
        } catch (SQLException e) {
            
        }
    }
}
  • xxl-job原理原链接

https://www.modb.pro/db/235546

0 人点赞