XXl-Job定时任务

最新推荐文章于 2025-05-17 18:58:19 发布

InterceptWall

最新推荐文章于 2025-05-17 18:58:19 发布

阅读量995

点赞数

CC 4.0 BY-SA版权

分类专栏：工具安装使用文章标签： java

本文链接：https://blog.csdn.net/InterceptWall/article/details/114986361

工具安装使用专栏收录该内容

8 篇文章

订阅专栏

1. 概念

XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用

2. 优缺点

优点：

		* 支持集群部署；
		* 提供运维界面维护成本小；
		* 自带错误预警；
		* 相对elastic-job来说不需要额外的组件（zookeeper）；
		* 支持调度策略；
		* 支持分片；
		* 文档齐全

缺点：相对Quartz来说需要多部署调度中心

总结：针对目前项目情况，利大于弊

3. 特性

执行失败可以查看日志
支持邮件报警
路由策略支持轮询等策略，可以减轻执行服务器的压力
轮询时间等参数修改后立即生效
执行器有问题或新增，快速识别
调度中心高可用，调度中心可以集群部署（集群部署的机器时钟必须同步），如果调度中心没有做负载在执行器的配置中需要配多个地址，如果调度中心配置负载则执行器配置负载地址即可
执行器高可用（执行器可以集群部署）

4. 依赖jar包

<dependency>
	<groupId>com.xuxueli</groupId>
	<artifactId>xxl-job-core</artifactId>
	<version>2.0.1</version>
</dependency>

5. 依赖配置

5.1 properties文件配置

# 为了实现自动组成到调度中心，所以这里必填
# 调度中心部署地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
 
# 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
 
# 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=
 
# 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
 
# 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
 
# 日志管理
# 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
# 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
xxl.job.executor.logretentiondays=-1

5.2 类配置

import com.xxl.job.core.executor.XxlJobExecutor;
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.ComponentScan;
import org.springframework.context.annotation.Configuration;
 
 
/**
 * xxl-job config
 * 配置类有两点需要注意：
 * 1. 组件扫描使用 @ComponentScan 注解，扫描指定得包，将其中的任务处理器加载至 Spring 容器。
 * 2. 获取执行器实例 xxlJobExecutor() 方法会实例化一个 XXL-JOB 执行器对象，执行器初始化时调用它的
 * 	  start() 方法，执行器销毁时调用它的 destroy() 方法。
 * @author xuxueli 2017-04-28
 */
@Configuration
@ComponentScan(basePackages = "定时任务所在包")
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
 
    @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(initMethod = "start", destroyMethod = "destroy")
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        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 ;
    }
}

6.任务管理配置

6.1 执行器

- 任务绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能
- 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;

6.2 任务描述

任务的描述信息，便于任务管理

6.3 路由策略

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

6.4 Cron表达式

触发任务执行的Cron表达式

6.5 运行模式

JobHandler：运行模式为 “BEAN模式” 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值

1. BEAN模式：任务以JobHandler方式维护在执行器端
    	需要结合 "JobHandler" 属性匹配执行器中任务
2. GLUE模式(Java)：任务以源码方式维护在调度中心
    	该模式的任务实际上是一段继承自JobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里的其他服务；
3. GLUE模式(Shell)：任务以源码方式维护在调度中心
    	该模式的任务实际上是一段 "shell" 脚本
4. GLUE模式(Python)：任务以源码方式维护在调度中心
    	该模式的任务实际上是一段 "python" 脚本；
5. GLUE模式(PHP)：任务以源码方式维护在调度中心
    	该模式的任务实际上是一段 "php" 脚本
6. GLUE模式(NodeJS)：任务以源码方式维护在调度中心
    	该模式的任务实际上是一段 "nodejs" 脚本
7. GLUE模式(PowerShell)：任务以源码方式维护在调度中心
    	该模式的任务实际上是一段 "PowerShell" 脚本

6.6 阻塞处理策略

调度过于密集，执行器来不及处理时的处理策略

1. 单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
2. 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
3. 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务

6.7 其他配置

1. 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
2. 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
3. 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；
4. 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
5. 负责人：任务的负责人；
6. 执行参数：任务执行所需的参数；