xxl-job 安装与使用

概述

XXL-Job是一个开源的分布式任务调度框架，用于快速构建稳定、高效、可扩展的定时任务系统。它提供了丰富的任务调度功能，包括定时任务、周期任务、延迟任务、一次性任务等，并支持任务参数化、任务依赖、任务分组等高级特性。

安装

1、下载

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

中央仓库地址

<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${最新稳定版本}</version>
</dependency>

环境

Maven3+
Jdk1.8+
Mysql5.7+

2、安装

下载项目源码并解压，进入 /xxl-job/doc/db 目录下获取“调度数据库初始化SQL脚本”

/xxl-job/doc/db/tables_xxl_job.sql

进入本地数据库执行 tables_xxl_job.sql，初始化“调度数据库”

截屏2023-11-25 17.20.59.png

3、配置数据库

打开项目进入 xxl-job-admin服务修改properties 文件

截屏2023-11-25 17.23.40.png

配置介绍

### 调度中心JDBC链接
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
### 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为     "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
xxl.job.i18n=zh_CN
## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

4、启动 xxl-job-admin 服务

启动服务

截屏2023-11-25 17.39.26.png

成功启动后，登录调度中心,访问地址：http://localhost:8080/xxl-job-admin ，默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

截屏2023-11-25 17.36.57.png

集成使用

1、项目集成

• pom中jar包的引入：

   <dependency>
        <groupId>com.xuxueli</groupId>
        <artifactId>xxl-job-core</artifactId>
        <version>{选择自己合适的版本}</version>
    </dependency>
  

• 执行器配置 创建配置类

截屏2023-12-12 13.54.59.png

• 在调度中心添加执行器实例：

  
  截屏2023-11-25 17.50.31.png

• 在调度中心任务管理模块，添加Cron表达式，路由策略等等信息

截屏2023-11-25 17.51.22.png

• 路由策略介绍

路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
    FIRST（第一个）：固定选择第一个机器；
    LAST（最后一个）：固定选择最后一个机器；
    ROUND（轮询）：；
    RANDOM（随机）：随机选择在线的机器；
    CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
    LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
    LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
    FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
    BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
    SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片         参数开发分片任务；
任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

• 项目中创建方法执行类 SampleXxlJobHandler，实现调度任务

@Slf4j
@Component
public class SampleXxlJobHandler {
    @Resource
    CourseApprovalsDaoService courseApprovalsDaoService;
    /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("sampleJobHandler")
    public void sampleJobHandler() throws Exception {
        log.info("当前时间 --->" + System.currentTimeMillis());
    }

    /**
     * 2、分片广播任务
     */
    @XxlJob("sliceJobHandler")
    public void sliceJobHandler() throws Exception {
        // 分片参数
       int shardTotal = XxlJobHelper.getShardTotal();
        int shardIndex = XxlJobHelper.getShardIndex();
        log.info("分片参数：当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);
        // 查询需要 执行的SQL 数据
        List<CourseApprovalsPO> courseApprovalsPOList = null;
        if (shardTotal == 1){
            // 如果没有分片就直接查询所有数据
            courseApprovalsPOList = courseApprovalsDaoService.selectAll();
        }else {
            //
            courseApprovalsPOList = courseApprovalsDaoService.selectByMod(shardIndex,shardTotal);
        }
        log.info("处理任务数量："+ courseApprovalsPOList.size());
        Long startTime = System.currentTimeMillis();
        courseApprovalsPOList.forEach(item->{
            try {
                item.setCountry("RU");
                boolean b = courseApprovalsDaoService.updateById(item);
                log.info("更新完毕 b--->" + b);
            }catch (Exception e){
                e.getStackTrace();
            }
        });

        log.info("任务结束时间："+ new Date());

        log.info("任务耗时："+ (System.currentTimeMillis()-startTime)+"毫秒");
    }
}

特点

• 简单易用：提供了简单易用的API和界面，方便用户快速上手和使用。
• 分布式：支持分布式部署，可以部署在多台服务器上，实现负载均衡和高可用性。
• 多种任务类型：支持定时任务、周期任务、延迟任务、一次性任务等多种任务类型，满足不同业务需求。
• 任务参数化：支持任务参数化，方便对任务进行灵活配置和管理。
• 任务依赖：支持任务依赖，可以实现多个任务之间的依赖关系和串行执行。
• 任务分组：支持任务分组，可以将相关任务分组管理，方便统一管理和维护。
• 日志和监控：提供了完善的日志和监控功能，方便用户对任务执行情况进行实时监控和异常处理。
• 可扩展性：支持插件化扩展，可以方便地扩展和定制化功能。

总之，XXL-Job是一个功能强大、简单易用、可扩展的分布式任务调度框架，适用于各种规模的应用场景，可以帮助用户快速构建稳定、高效、可扩展的定时任务系统。

---

文章持续更新中、希望对各位有所帮助、有问题可留言 大家共同学习 !