XXL-JOB 使用总结

---

title: XXL-JOB 使用总结
date: 2023-07-14 11:35:19
tags:

• XXL-JOB
• 服务器
  categories:
• 开发技术及框架
  cover: https://cover.png
  feature: false

---

1. 初始化调度数据库

官网及文档：分布式任务调度平台 XXL-JOB

项目地址：

• xuxueli/xxl-job:（分布式任务调度平台 XXL-JOB）
• xxl-job: 一个分布式任务调度平台

在项目 doc/db 目录下存在数据库初始化脚本，执行该脚本初始化数据库

2. 配置部署调度中心

将项目 clone 到本地，一共包括三个模块

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

修改调度中心配置文件，项目根路径 resources 下的 application.properties 文件，以及 logback.xml 文件的日志路径，可根据个人选择修改

配置文件内容说明如下，可根据情况进行修改

### 调度中心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_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
[email protected]
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

然后启动 XxlJobAdmin，访问 http://localhost:8080/xxl-job-admin 管理页面，具体的端口和路径以个人配置为准，该地址为执行器的回调地址

默认用户名密码为 admin/123456，登录后主界面如下

至此调度中心项目已经成功运行

3. 配置部署执行器项目

项目引入 xxl-job-core 依赖

<dependency>
      <groupId>com.xuxueligroupId>
      <artifactId>xxl-job-coreartifactId>
      <version>2.4.0version>
dependency>

配置文件如下：

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

添加配置类 XxlJobConfig

@Configuration
public class XxlJobConfig {

    @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
    public XxlJobSpringExecutor xxlJobExecutor() {
        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;
    }
}

在需要定时执行的方法上加上 @XxlJob("JobHandler") 注解，这里的值为后面定时任务 JobHandler 的值

@RestController
public class TestController {

    @GetMapping("/test")
    @XxlJob("test")
    public String test() {
        System.out.println("test");
        return "test";
    }
}

然后启动项目

4. 执行定时任务

首先需要添加执行器，AppName 即为执行器配置文件的 appname 值，机器地址选择自动注册或手动录入都可以，这里选择自动注册

添加完成后等待一会，就可以看到机器地址已经自动注册了进来，一直为空的话表示自动注册有问题，需要排查一下执行器配置文件的调度中心地址和端口是否正确

然后添加定时任务，选择我们刚刚创建的执行器，这里的 JobHandler 的值为前面 @XxlJob("JobHandler") 的值

保存后，点击执行一次进行测试

在调度日志里可以看到执行成功

5. 部署到服务器

部署项目见：Fan’s Web

这里需要注意的是，将调度中心部署到服务器后，本地执行器虽然能注册到调度中心里，但是执行定时任务失败，连接本地地址超时，将本地项目也部署到服务器即可执行成功