源码下载地址
https://gitee.com/xuxueli0323/xxl-job
xxl开元社区地址
https://www.xuxueli.com/page/projects.html

项目模块介绍

在这里插入图片描述

架构思想

admin后台负责管理执行器和定时任务的增删改查,执行器管理会保存执行器的地址,可以自动录入,即执行器启动时会自动向后台注册,也可以手动录入
执行器即具体的逻辑代码部分,需要引入核心代码依赖,且需要把任务代码逻辑的类放入spring容器,执行器配置会保存后台的地址,

部署项目

后台管理部署

xxl-job-admin模块打包成jar包启动即可
application.properties配置文件解释

### web 端口号和项目根目录
server.port=8080
server.servlet.context-path=/xxl-job-admin
### 调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
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_pwd
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

调度中心访问地址:http://localhost:8080/xxl-job-admin (该地址执行器将会使用到,作为回调地址)
默认登录账号 “admin/123456”, 登录后运行界面如下图所示,修改密码代码DigestUtils.md5DigestAsHex(xxlJobUser.getPassword().getBytes())

执行器管理

新增配置解读

  • AppName: 为下面执行器配置的xxl.job.executor.appname
  • 名称: 随意
  • 注册方式 : 可以自动,也可以手动
  • 机器地址: 执行器的地址,如果自动没有注册到,就改改为手动填写http://127.0.0.1:9999/,ip和端口分别对应下面执行器配置的xxl.job.executor.ip和xxl.job.executor.port

任务管理

  • 执行器: 即执行器管理添加的执行器
  • 任务描述、负责人、报警邮件等:根据需要填写
  • 调度类型:选CRON接口
  • Cron:定时任务的七子表达式
  • 运行模式:选择BEAN即可,任务以JobHandler方式维护在执行器端;需要结合 “JobHandler” 属性匹配执行器中任务;
  • JobHandler: 任务执行逻辑,下面执行器中执行类的@XxlJob(“testQuartz”)注解的值testQuartz
  • 路由策略:路由策略决定了任务如何被分配给执行器。XXL-JOB提供了多种路由策略,包括轮询、随机、一致性Hash、最不常使用、最近最久未使用、故障转移、忙碌转移、分片广播等。这些策略在任务调度时由调度中心根据任务的配置和执行器的状态来选择。
  • 阻塞处理策略
    1、 单机串行(默认):调度请求进入单机执行器后,会被放入一个FIFO(先进先出)队列中,并以串行方式运行。即,一个任务执行完毕后,才会执行下一个任务。应用场景:适用于任务执行时间不长,且对并发性要求不高的场景。缺点:如果任务执行时间较长,且任务频率较高,可能会导致任务队列积压,影响系统的整体性能。
    2.、丢弃后续调度(推荐):当调度请求进入单机执行器时,如果发现执行器已经存在运行的调度任务,本次请求将会被丢弃,并标记为失败。应用场景:适用于任务执行时间较长,且可以接受任务偶尔失败的场景。这种策略可以防止任务队列积压,保证系统的稳定性。优点:可以有效避免任务并发执行导致的资源争用问题。
    3、覆盖之前调度(不推荐):当调度请求进入单机执行器时,如果发现执行器已经存在运行的调度任务,将会终止正在运行的调度任务,并清空队列,然后运行新的调度请求。应用场景:虽然这种策略在某些特殊场景下可能有用,但通常不推荐使用,因为它会打断正在执行的任务,可能导致数据不一致或其他问题。缺点:可能导致正在执行的任务被意外中断,造成数据丢失或不一致。

部署执行器(需要集成到任务代码的项目中)

需要引入依赖

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

需要添加的配置文件内容

### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用, 如果非空需要和后台的一致;
xxl.job.accessToken=
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=http://localhost:8080/xxl-job-admin
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
xxl.job.executor.logretentiondays=30

配置类

packa quartz;

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;

@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;
    }
}

定时任务代码逻辑类

package quartz;

import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

@Component
public class ExecutorTest {

    @XxlJob("testQuartz")  // 值为在后台新增定时任务时的JobHandler
    public void testQuartz(){
    	String jobParam = XxlJobHelper.getJobParam();  // 获取任务参数
        System.out.println("执行的定时任务");
    }
}
Logo

华为开发者空间,是为全球开发者打造的专属开发空间,汇聚了华为优质开发资源及工具,致力于让每一位开发者拥有一台云主机,基于华为根生态开发、创新。

更多推荐