> 技术文档 > 微服务篇-深入了解 XXL-JOB 分布式任务调度的具体使用(XXL-JOB 的工作流程、框架搭建)

微服务篇-深入了解 XXL-JOB 分布式任务调度的具体使用(XXL-JOB 的工作流程、框架搭建)


🔥博客主页: 【小扳_-CSDN博客】
❤感谢大家点赞👍收藏⭐评论✍

 

文章目录

        1.0 XXL-JOB 调度中心概述

        1.2 XXL-JOB 工作流程

        1.3 Cron 表达式调度

        2.0 XXL-JOB 框架搭建

        2.1 XXL-JOB 调度中心的搭建

        2.2 XXL-JOB 执行器的搭建

        2.3 使用调度中心调度执行器

        3.0 对 XXL-JOB 分布式任务调度使用总结

        3.1 在分片广播的方式中下发任务,如何保证任务不重复执行?


        1.0 XXL-JOB 调度中心概述

        XXL-JOB 将任务调度抽象为“调度中心”,而将具体的任务执行交给“执行器”来完成。这种分

离的设计使得调度逻辑与业务逻辑解耦,提高了系统的稳定性和可扩展性。

官网:XXL开源社区 | 首页

以下是关于 XXL-JOB 的一些详细介绍:

        1)简单易用:支持通过 Web 界面进行任务的 CRUD(创建、读取、更新、删除)操作,用

户可以快速上手。

        2)动态管理:能够动态地修改任务状态、启动或停止任务,并即时生效。

高可用性(HA):调度中心和执行器都支持集群部署,确保系统的高可用性和任务执行的可靠

性。

        3)注册中心:执行器会自动注册到调度中心,调度中心会发现并触发这些注册的任务。

        4)弹性伸缩:执行器机器的上下线会影响下次调度时的任务分配,实现动态扩容缩容。

        5)丰富的路由策略:如轮询、随机、一致性哈希等,用于在执行器集群中选择执行任务的节

点。

        6)故障转移:如果某个执行器故障,系统会自动切换到其他健康的执行器继续执行任务。

        7)阻塞处理策略:当调度过于密集时,提供了单机串行、丢弃后续调度、覆盖之前调度等多

种处理方式。

        8)任务超时控制与失败重试:支持设置任务超时时间及失败后的重试机制。

        9)分片广播任务:可以在多个执行器实例之间分割任务,以提高并发处理能力。

        10)事件触发:除了 Cron 表达式外,还支持基于事件触发的任务执行。

        11)实时日志查看:提供在线查看任务执行结果和完整日志的功能。

        12)GLUE 功能:允许在线编写、编译和发布任务逻辑代码。

        13)国际化:提供多语言支持,默认为中文。

        14)安全加密:调度中心和执行器之间的通信数据进行了加密。

        1.2 XXL-JOB 工作流程

        1)用户在调度中心(Web 界面)配置任务,包括指定执行器、定义任务逻辑等。

        2)调度中心根据设定的时间规则(例如 Cron 表达式)触发任务。

        3)调度请求被发送给对应的执行器,执行器接收到请求后执行相应的任务逻辑。

        4)执行结果会被报告回调度中心,供用户监控和查询。

        1.3 Cron 表达式调度

        在使用调度任务技术的时候,,特别师调度框架,里面都支持使用日历的方式来设置任务制

定的时间、频率等,通常情况下都会使用 cron 表达式来表达。

        Cron 表达式是一个字符串,用来设置定时规则,由七部分组成,每部分中间用空格隔开,每

部分如下表达:

 

        另外, cron 表达式还可以包含一些特殊符号来设置更加灵活的定时规则, 如下表所示:

举个栗子:

        具体使用的方式

(1)0 0 2 1 * ? 表示在每月的1日的凌晨2点调整任务(2)0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业 ★★★(3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作(4)0 0 10,14,16 * * ? 每天上午10点,下午2点,4点(5)0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时(6)0 0 12 ? * WED 表示每个星期三中午12点(7)0 15 10 * * ? 每天上午10:15触发(8)0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发(9)0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发(10)0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发(12)0 15 10 L * ? 每月最后一日的上午10:15触发(13)0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发

        2.0 XXL-JOB 框架搭建

        总体来说,主要分为两个步骤:调度中的搭建、执行器的搭建。

        2.1 XXL-JOB 调度中心的搭建

        1)快速使用 XXL-JOB,可以首先到 Gitee 或者是 Github 上拉取开源代码:

        Github:https://github.com/xuxueli/xxl-job

        Gitee:http://gitee.com/xuxueli0323/xxl-job

源码结构:

        2)配置执行 SQL 脚本

        将代码拉取下来之后,先找到 SQL 脚本:

        在数据库中执行该 SQL 脚本:

        3)接着,配置 application.properties 文件

        主要是对数据库进行配置,数据库的连接信息修改为自己的数据库。

        4)启动调用中心

        启动服务之后,访问 \"localhost:8080/xxl-job-admin\",默认端口号是 8080 ,默认的登录账

号密码是:admin/123456

页面展示:

        2.2 XXL-JOB 执行器的搭建

        1)首先在项目中引入依赖:

  org.springframework.boot spring-boot-starter-web    com.xuxueli xxl-job-core 2.3.0 

        2)在 application.yml 配置文件中进行配置

xxl: job: admin: addresses: http://127.0.0.1:8081/xxl-job-admin executor: appname: xxl-job-executor-sample port: 9998

主要参数解析: 

        addresses:表示的是 XXL-JOB 服务器,也就是调度中心的地址。

        appname:表示的是当前的执行器的命名,方便后续在调度中心对执行器的选取。

        port:表示当前执行器的端口,主要作用是:给调用中心发送信息给执行器所用到的端口

号。

        3)创建 XXL-JOB 相关的配置类

        配置一个执行器,将其放到 Spring IOC 容器中。

代码如下:

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 */@Configurationpublic 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、引入依赖: *  * org.springframework.cloud * spring-cloud-commons * ${version} *  * * 2、配置文件,或者容器启动变量 * spring.cloud.inetutils.preferred-networks: \'xxx.xxx.xxx.\' * * 3、获取IP * String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress(); */}

        4)定义执行逻辑任务

        定义一个逻辑任务,使用 @XxlJob(\"demoJobHandler\") 注解,使用该注解标记到方法上,

且在该方法在定义任务逻辑即可。

举个栗子:

import com.xxl.job.core.context.XxlJobHelper;import com.xxl.job.core.handler.annotation.XxlJob;import groovy.util.logging.Slf4j;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@Slf4jpublic 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); System.out.println(\"beat at:\" + i + \" XXL-JOB, Hello World.\"); } // default success } /** * 2、分片广播任务 */ @XxlJob(\"shardingJobHandler\") public void shardingJobHandler() throws Exception { // 分片参数 int shardIndex = XxlJobHelper.getShardIndex(); int shardTotal = XxlJobHelper.getShardTotal(); XxlJobHelper.log(\"分片参数:当前分片序号 = {}, 总分片数 = {}\", shardIndex, shardTotal); logger.info(\"分片参数:当前分片序号 = {}, 总分片数 = {}\", shardIndex, shardTotal); // 业务逻辑 for (int i = 0; i 0) { DataOutputStream dataOutputStream = new DataOutputStream(connection.getOutputStream()); dataOutputStream.write(data.getBytes(\"UTF-8\")); dataOutputStream.flush(); dataOutputStream.close(); } // valid StatusCode int statusCode = connection.getResponseCode(); if (statusCode != 200) { throw new RuntimeException(\"Http Request StatusCode(\" + statusCode + \") Invalid.\"); } // result bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), \"UTF-8\")); StringBuilder result = new StringBuilder(); String line; while ((line = bufferedReader.readLine()) != null) { result.append(line); } String responseMsg = result.toString(); XxlJobHelper.log(responseMsg); return; } catch (Exception e) { XxlJobHelper.log(e); XxlJobHelper.handleFail(); return; } finally { try { if (bufferedReader != null) {  bufferedReader.close(); } if (connection != null) {  connection.disconnect(); } } catch (Exception e2) { XxlJobHelper.log(e2); } } } /** * 5、生命周期任务示例:任务初始化与销毁时,支持自定义相关逻辑; */ @XxlJob(value = \"demoJobHandler2\", init = \"init\", destroy = \"destroy\") public void demoJobHandler2() throws Exception { XxlJobHelper.log(\"XXL-JOB, Hello World.\"); } public void init(){ logger.info(\"init\"); } public void destroy(){ logger.info(\"destroy\"); }}

        2.3 使用调度中心调度执行器

        现在已经完成了调度中心的部署,执行器的定义且任务逻辑的定义。接下来,就可以通过调

用中心来调用执行器了。

        1)在调用中心创建执行器

        这里就不再过多的新增一个执行器了,就拿之前已经创建好的执行器来讲解,需要注意的

是,AppName 的命名需要跟在项目中的 application.yml 配置文件中的执行器命令保持一致。

xxl: job: admin: addresses: http://127.0.0.1:8081/xxl-job-admin executor: appname: xxl-job-executor-sample port: 9998

        2)启动项目

        启动项目之后,调度中心就会检测到执行器:

        3)新增任务

        点击新增之后,

        4)配置选择

一、基础配置:

        主要由执行器的选择、任务描述、负责人、报警邮件。

        执行器:希望选择哪一个执行器来执行任务,通过名称来选择。

二、调度配置:

        调度类型有三种:无、CRON、固定速度。一般是通过 CRON 表达是来灵活选择任务的执行

时机。

三、任务配置:

        一般通过 BEAN 的运行模式来指定具体要执行的方法,也就是任务逻辑。

        具体是通过 JobHandler 来确定任务逻辑,指定 @XxlJob(\"demoJobHandler\") 注解中的 demoJobHandler 来确定。 

四、高级配置:

        路由策略:当有多个执行器的时候,则可以通过路由策略来选择要使用哪一个执行器来执行

任务。

主要的路由策略:

        FIRST(第一个):固定选择第一个机器。

        LAST(最后一个):固定选择最后一个机器。

        ROUND(轮询)

        RANDOM(随机):随机选择在线的机器。

        CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某一台机器,且

所有任务均匀散列在不同机器上。

        LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的机器优先被选举。

        LEAST_RECENTLY_USED(最近最久未使用):最久未使用的机器优先被选举。

        FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为

目标执行器并发起调度。

        BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为

目标执行器并发起调度。

        SHARDING_BROADCAST(分片广播):广播触发对应集群中所有机器执行一次任务,同时

系统自动传递分片参数;可根据分片参数开发分片任务。

        调度过期策略:

        阻塞处理策略:

        单机串行:假设当前执行器正在执行任务,调度中心又发送一个任务给当前执行器,那么当

前的执行器可以将任务先放入到队列中。

        丢弃后续调度:假设当前执行器正在执行任务,调度中心又发送一个任务给当前执行器,那

么当前的执行器直接将后续的任务丢弃,继续执行当前正在执行的任务。

        覆盖之前调度:假设当前执行器正在执行任务,调度中心又发送一个任务给当前执行器,那

么当前的执行器直接将正在执行的任务丢弃,接着执行新来的任务。

        任务超时时间和失败重试次数:

        支持自定义任务超时时间,任务运行超时将会主动中断任务;支持自定义任务失败重试次

数,当任务失败时将会按照预设的失败重试次数主动进行重试;

测试配置:

        接着配置完任务之后,就可以启动该任务了。

        执行器执行的结果:

        这就是 XXL-JOB 框架最常见的使用步骤了。

        3.0 对 XXL-JOB 分布式任务调度使用总结

        XXL-JOB 分布式调度服务由调度中心和执行器组成。通过在调度中心配置任务且下发任务给

指定的执行器,再由执行器来执行具体的任务。而通

过 @XxlJob(\"demoJobHandler\") 注解来标记在方法上,在方法中编写具体的逻辑。

 

        3.1 在分片广播的方式中下发任务,如何保证任务不重复执行?

        1)执行器收到作业分片广播的参数:分片总数、分片序号,通过计算任务 ID 除以分片总数

得到一个余数,如果余数等于分片序号,则交给这个执行器去执行该任务,这里保证了不同的执行

器执行不同的任务。

        2)配置调度过期策略为 “忽略”,避免同一个执行器多次重复执行同一个任务。

        3)配置任务阻塞处理策略为 “丢弃后续调度”,注意:丢弃也没事,下一次调度就又可以执行了。

        4)还要保证任务处理的幂等性,可以使用乐观锁来实现或者对已经执行过的任务加上标记,

对已经标记的任务不能再执行。