SpringBoot整合xxl-job

1.官方文档

中文文档: www.xuxueli.com/xxl-job/

2.下载xxl-job源码

2.1下载地址

Gitee地址:gitee.com/xuxueli0323…

Github地址:github.com/xuxueli/xxl…

2.2使用Idea打开项目

项目结构如下

模块名称	模块说明
xxl-job-admin	调度中心,提供管理平台UI界面,真实开发场景中一般将其进行单独打包部署
xxl-job-core	公共依赖模块，项目整合xxl-job时,需要导入该依赖
xxl-job-executor-samples	demo案例

3.使用xxl-job

3.1导入sql文件

sql中已包含数据库名称信息,不需要单独创建数据库

3.1.1

表信息说明(刚开始看肯定一头雾水，可在操作xxljob案例之后再来熟悉)

表名	说明
xxl_job_group	保存执行器信息,新添加的执行器均在此表中保存
xxl_job_info	用户保存任务信息，包括任务所属执行器，执行频次，过期策略等
xxl_job_lock	任务调度锁
xxl_job_log	保存调度结果、执行结果、调度入参、调度机器和执行器
xxl_job_log_report	用于记录任务执行的成功次数，失败次数，一般以天为维度
xxl_job_logglue	任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能
xxl_job_registry	执行器注册表，维护在线的执行器和调度中心机器地址信息
xxl_job_user	系统用户表，用于登录admin控制台，使用MD5加密

3.2修改xxl-job-admin配置文件信息

3.2.1主要修改内容

3.2.1.1 数据源信息

修改为3.1导入的数据源信息

### xxl-job, datasource
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
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3.2.1.2 修改报警邮箱配置（可不配）

QQ邮箱：

### 主机、端口
spring.mail.host=smtp.qq.com
spring.mail.port=25
### 邮箱地址
spring.mail.username=xxx@qq.com
### 邮箱地址
spring.mail.from=xxx@qq.com
### QQ授权码（非QQ密码），具体方法可百度
spring.mail.password=xxx

163邮箱：

### 主机、端口
spring.mail.host=smtp.163.com
spring.mail.port=25
### 邮箱地址
spring.mail.username=xxx@163.com
### 邮箱地址
spring.mail.from=xxx@163.com
### 邮箱密码
spring.mail.password=xxx

3.2.1.3 修改accessToken（可不配置，配置时执行器配置需要与此一致，后续后讲）

### xxl-job, access token
### 有配置时可加上，默认为空（）
xxl.job.accessToken=default_token

配置示例

### web
server.port=8326
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource
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
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000

### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=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

### xxl-job, access token
### 有配置时可加上，默认为空（）
xxl.job.accessToken=default_token

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days
xxl.job.logretentiondays=30

4.运行xxl-job-admin

真实环境一般将其打jar包单独部署

4.1打jar包

4.1.1 使用idea将xxl-job-admin打jar包

4.1.2 找到打包后的target目录，运行cmd命令

4.1.3 访问admin控制台

http://localhost:配置文件端口号/xxl-job-admin/

5.SpringBoot项目集成xxl-job

下载的xxl-job-executor-samples模块中有执行器案例，可进行参考

真实的开发场景中（以微服务架构为例）每一个单独的服务都会单独注册一个注册器到调度中心（xxl-job-admin）

5.1创建SpringBoot项目并导入依赖

xxl-job核心依赖

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

示例项目完整依赖

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.4</version>
        <relativePath/>
    </parent>

    <dependencies>
        <!--定时调度项目-->
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.3.1</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

5.2创建配置文件

一般只需要配置调度中心地址，appname即可

server:
  port: 8989

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

5.3添加配置类

package com.xxljob.config;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.slf4j.Slf4j;
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;

/**
 * xxl-job config
 *
 * @author wanglele 2023-06-27
 */
@Configuration
@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() {
        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);
        log.info("----- xxl-job config end -----");
        return xxlJobSpringExecutor;
    }
}

5.4创建任务

一个工程可创建多个任务,根据 @XxlJob("sendMessage")进行区分

5.4.1简单任务（Bean模式）

5.4.1.1 编写任务代码

@Component
@Slf4j
public class MyXxlJob {
    /**
     * 简单模式（Bean模式）
     *
     * @throws Exception
     */
    @XxlJob("sendMessage")
    public void myJobHandler() throws Exception {
        log.info("开始执行..........");
        log.info("发送短信，发送时间:" + DateUtil.format(new Date(), "yyyy-MM-dd HH:mm:ss"));
        log.info("执行完成..........");
    }
}

5.4.1.2创建执行器

5.4.1.3添加任务并启动

JobHandler与@XxlJob()注解的值保持一致,相当于任务的唯一Id

5.4.1.4启动SpringBoot项目,查看控制台和调度日志

成功运行