玩转XXL-JOB：打造高效的定时任务解决方案

技术派项目源码地址 :

• Gitee :技术派 - https://gitee.com/itwanger/paicoding
• Github :技术派 - https://github.com/itwanger/paicoding

架构设计思想

1、将调度行为抽象形成“调度中心”公共平台，而平台自身并不承担业务逻辑，“调度中心”负责发起调度请求

2、将任务抽象成分散的JobHandler，交由“执行器”(可以理解为就是我们的服务实例)统一管理，“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。即调度和任务两部分可以相互解耦，提高系统整体稳定性和扩展性；

XXL-JOB 安装与使用

下载代码

Releases · xuxueli/xxl-job - Github下载

• 下载完打开后目录如下:

• doc：文档资料，包括"调度数据库"建表脚本
• xxl-job-core：公共 Jar 依赖
• xxl-job-admin：调度中心，项目源码，spring boot 项目，可以直接启动
• xxl-job-executor-samples：执行器，sample 示例项目，可以直接启动。

导入相关数据库

• 导入成功后的表如下 :

修改相关配置

启动项目并访问控制台

• 直接启动 **XxlJobAdminApplication** 即可
• 启动成功之后，在浏览器端直接访问web页面URL：http://127.0.0.1:8089/xxl-job-admin/
• 注意端口号是你自己所设置的, 账号/密码 : admin / 123456

SpringBoot整合xxl-job实现定时任务

引入依赖

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

修改配置文件

# Xxl-Job分布式定时任务调度中心
xxl:
  job:
    admin:
      # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。
      # 注意这里的端口号
      addresses: http://127.0.0.1:8089/xxl-job-admin
      # addresses: http://192.168.110.2:9090/xxl-job-admin
    # 执行器通讯TOKEN [选填]：非空时启用 系统默认 default_token
    accessToken: default_token
    executor:
      # 执行器的应用名称
      appname: pai-coding
      # 执行器注册 [选填]：优先使用该配置作为注册地址
      address: ""
      # 执行器IP [选填]：默认为空表示自动获取IP
      ip: ""
      # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999
      port: 9998
      # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logpath:
      #logpath: /data/logs/mls/job
      # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
      logretentiondays: 7

• admin-addresses属性中的端口号一定要注意，
• 这里需要和你上面的xxl-job admin模块中的配置server.port相对应。

编写xxl-job的config配置文件

package com.itheima.mp.config;

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author Ccoo
 * 2024/8/21
 */
@Configuration
@Data
@Slf4j
public class XxlJobConfig {

	@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() {
		XxlJobHelper.log(">>>>>>>>>>> xxl-job config init.>>>>>>>>>>>");
		log.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;
	}

}

• 启动项目看是否整合成功

代码编写执行任务

// 注解内部属性是任务名称
@XxlJob("xxlTest")
public void xxlTest() {
	log.info("=============== xxl-job task test start.===============");
	log.info("=============== xxl-job task test end.===============");
}

在xxl-job任务调度中心中添加执行器

• 过一会刷新页面就会发现注册成功!

在xxl-job任务调度中心中添加任务管理

测试xxl-job

• 将任务状态设置为 running 然后执行一次

• 执行结果如图

查看调度日志

查看运行总报表

总结

• 只要在技术派项目里将需要定时调度的方法加上**@XxlJob**注解
• 然后在**xxl-job**控制台将对应的调度方法注册上去, 设置好调度的频率
• 剩下的就交给**xxl-job**来调度即可