定时任务框架选型Quartz/Xxl-Job

2022-03-18 一只程序猿粑粑

加入收藏

以前公司平台中集成了定时任务功能，但平台内部实现比较简单，使用方式有些受限，比如说无法跟踪定时任务执行状态，无法自动解决集群状态下的任务争抢问题，因此考虑升级一下任务实现方式，搜集一番后，Quartz和Xxl-Job都能满足现在的需求；

以下就对两种定时任务框架进行简单说明。

Quartz

传送门

github地址：
https://github.com/quartz-scheduler/quartz

Maven坐标

<!-- Quartz Core -->
<dependency>
  <groupId>org.quartz-scheduler</groupId>
  <artifactId>quartz</artifactId>
  <version>2.3.0</version>
</dependency>

可以查看jar包的依赖情况如下：

如果不是maven项目，单独下载jar包使用的情况，不要漏掉jar包；可通过官网下载的方式获取到所有的jar包；

官网不知道怎么回事儿，超级慢；

我一般的做法是，本地建立一个单独的maven项目，加入相关maven依赖，然后通过下面的maven命令获取到所有pom.xml文件中的jar包；然后再复制到自己需要放的地方；

mvn dependency:copy-dependencies -DoutputDirectory=lib

配置文件

最终编译后的位置：WEB-INF/classes/quartz.properties

下面是一个最基本的配置项内容：

org.quartz.scheduler.instanceName = MyScheduler
org.quartz.threadPool.threadCount = 3
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore

其中

此配置创建的调度器有以下特点:

org.quartz.scheduler.instanceName -这个调度程序的名称将是“MyScheduler”。
org.quartz.threadPool.threadCount- 线程池中有3个线程，这意味着最多可以同时运行3个任务。
org.quartz.jobStore.class - Quartz的所有数据，比如任务和触发器的细节，都保存在内存中(而不是数据库中)。即使你有一个数据库，并且想要在Quartz上使用它，我建议你先让Quartz和RamJobStore一起使用，然后再用数据库打开一个全新的维度。

任务信息

任务信息处理类实现了org.quartz.Job 接口；如下

public class HelloJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) 
        throws JobExecutionException {
        System.out.println("hello @ " 
                           + LocalDateTime
                           .now()
                           .format(DateTimeFormatter
                                   .ofPattern("yyyyMMddHHmmss")));
    }
}

任务调度

一旦使用
StdSchedulerFactory.getDefaultScheduler()获得一个调度器，您的应用程序将不会终止，直到您调用schedul. shutdown()，因为将有活动线程。

注意代码示例中的静态导入 ；

这些将在下面的代码示例中发挥作用。

更详细地配置文件说明在这儿：

https://github.com/quartz-scheduler/quartz/blob/master/docs/configuration.adoc

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.*;
import static org.quartz.TriggerBuilder.*;
import static org.quartz.SimpleScheduleBuilder.*;

public class QuartzTest {

    public static void main(String[] args) throws InterruptedException {

        try {
            // Grab the Scheduler instance from the Factory
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

            // and start it off
            scheduler.start();

            // define the job and tie it to our HelloJob class
            JobDetail job = newJob(HelloJob.class)
                    .withIdentity("job1", "group1")
                    .build();

            // Trigger the job to run now, and then repeat every 40 seconds
            Trigger trigger = newTrigger()
                    .withIdentity("trigger1", "group1")
                    .startNow()
                    .withSchedule(simpleSchedule()
                            .withIntervalInSeconds(10)
                            .repeatForever())
                    .build();

            // Tell quartz to schedule the job using our trigger
            scheduler.scheduleJob(job, trigger);

            Thread.sleep(60 * 60 * 1000);

            scheduler.shutdown();

        } catch (SchedulerException se) {
            se.printStackTrace();
        }
    }
}

集群下的任务调度

数据库表

表文件在jar包的
org.quartz.impl.jdbcjobstore，可根据数据库类型选择不同的数据库文件；

配置文件

quartz也提供了数据库方面的任务配置及集群下的任务处理；

#==============================================================
#Configure Main Scheduler Properties
#org.quartz.scheduler.instanceName【相同业务部署保持该配置一致】
#==============================================================
org.quartz.scheduler.instanceName = quartzScheduler
org.quartz.scheduler.instanceId = AUTO

#==============================================================
#Configure JobStore
#org.quartz.jobStore.tablePrefix：表名前缀
#org.quartz.jobStore.dataSource：对应org.quartz.dataSource.xxx下面的配置信息
#==============================================================
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate
org.quartz.jobStore.tablePrefix = QRTZ_
org.quartz.jobStore.isClustered = true
org.quartz.jobStore.clusterCheckinInterval = 10000
org.quartz.jobStore.dataSource = myDS

#==============================================================
#Configure DataSource
#可以通过配置详细数据源的方式，也可以通过配置连接池的方式
#org.quartz.dataSource.qzDS.jndiURL = JAVA:/comp/env/jdbc/mydb
#我是用的weblogic中间件直接配置weblogic连接池的jndi即可，例如我的jndi名称为jdbc/isp
#因此我的配置如下：
#org.quartz.dataSource.qzDS.jndiURL=jdbc/isp
#
#org.quartz.dataSource.myDS.driver为数据库驱动名称，
#根据项目中实际需要修改为自己的数据库驱动名称即可
#==============================================================
org.quartz.dataSource.myDS.driver = com.ibm.db2.jcc.DB2Driver
org.quartz.dataSource.myDS.URL = 
org.quartz.dataSource.myDS.user = 
org.quartz.dataSource.myDS.password = 
org.quartz.dataSource.myDS.maxConnections = 30

#==============================================================
#Configure ThreadPool
#==============================================================
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount = 5
org.quartz.threadPool.threadPriority = 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true

crontab任务创建

// 构建job信息
JobDetail jobDetail = JobBuilder.newJob(jobClass)
        .withIdentity(jobName, jobGroup)
        .withDescription(description)
        .build();
// 表达式调度构建器
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
scheduleBuilder.withMisfireHandlingInstructionDoNothing();
// 按新的cronExpression表达式构建一个新的trigger
CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(jobName, jobGroup).withSchedule(scheduleBuilder)
        .build();
if (!params.isEmpty()) {
    // 放入参数,运行时的方法可以获取
    jobDetail.getJobDataMap().putAll(params);
}
Date date = scheduler.scheduleJob(jobDetail, trigger);

Xxl-job

说明

XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。

传送门

官网：
https://www.xuxueli.com/xxl-job/

gitee传送门：
https://gitee.com/xuxueli0323/xxl-job/tree/master

maven坐标

<!-- https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

快速入门

git clone https://gitee.com/xuxueli0323/xxl-job.git

获得到目录结构

初始化数据库

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

编译源码

xxl-job-admin：调度中心
xxl-job-core：公共依赖
xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
：
xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
：
xxl-job-executor-sample-frameless：无框架版本；

配置部署调度中心

调度中心项目：xxl-job-admin
作用：统一管理任务调度平台上的调度任务，负责触发调度执行，并且提供任务管理平台。

调度中心配置文件地址：

/xxl-job/xxl-job-admin/src/main/resources/Application.properties【修改数据库配置】

/xxl-job/xxl-job-admin/src/main/resources/logback.xml

完成上述修改后，然后运行XxlJobAdminApplication

运行成功后通过浏览器打开：
http://localhost:8080/xxl-job-admin/，用户名及密码：admin/123456

至此“调度中心”项目已经部署成功。

配置部署执行器项目

执行器项目：
xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
作用：负责接收“调度中心”的调度并执行；可以直接部署执行器，也可以将执行器集成到现有业务项目中。

执行器配置

配置文件地址：

/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/

application.properties

修改：xxl.job.executor.logpath为本地路径

logback.xml

修改日志路径为本地路径

新建任务

触发执行

请点击任务右侧 “执行” 按钮，可手动触发一次任务执行（通常情况下，通过配置Cron表达式进行任务调度触发）。

查看日志

请点击任务右侧 “日志” 按钮，可前往任务日志界面查看任务日志。
在任务日志界面中，可查看该任务的历史调度记录以及每一次调度的任务调度信息、执行参数和执行信息。运行中的任务点击右侧的“执行日志”按钮，可进入日志控制台查看实时执行日志。

磁盘上的日志文件路径在xxl.job.executor.logpath

基础配置：
- 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;
- 任务描述：任务的描述信息，便于任务管理；
- 负责人：任务的负责人；
- 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；

触发配置：
- 调度类型：
    无：该类型不会主动触发调度；
    CRON：该类型将会通过CRON，触发任务调度；
    固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；
    固定延迟：该类型将会以固定延迟，触发任务调度；按照固定的延迟时间，从上次调度结束后开始计算延迟时间，到达延迟时间后触发下次调度；
- CRON：触发任务执行的Cron表达式；
- 固定速度：固件速度的时间间隔，单位为秒；
- 固定延迟：固件延迟的时间间隔，单位为秒；

任务配置：
- 运行模式：
    BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
    GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
    GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
    GLUE模式(Python/ target=_blank class=infotextkey>Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
    GLUE模式(php)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
    GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
    GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
- JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
- 执行参数：任务执行所需的参数；     

高级配置：
- 路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
    FIRST（第一个）：固定选择第一个机器；
    LAST（最后一个）：固定选择最后一个机器；
    ROUND（轮询）：；
    RANDOM（随机）：随机选择在线的机器；
    CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
    LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
    LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
    FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
    BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
    SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
- 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
- 调度过期策略：
    - 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
    - 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
- 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
    单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
    丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
    覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
- 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
- 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

你看，奇怪的知识又增加了！

定时任务框架选型Quartz/Xxl-Job

Quartz

传送门

Maven坐标

配置文件

任务信息

任务调度

集群下的任务调度

数据库表

配置文件

crontab任务创建

Xxl-job

说明

传送门

maven坐标

快速入门

初始化数据库

编译源码

配置部署调度中心

配置部署执行器项目

执行器配置

新建任务

触发执行

查看日志

更多