Spring Boot整合XXL-JOB保姆级教程

站长

2023年08月16日 12:50 · 阅读数 17

引言： xxljob是一款开源的任务调度框架，它支持分布式、集群、高可用的任务调度服务，可以满足不同场景的任务调度需求。在我们实际的生产环境已经稳定运行了很长时间，并且后台使用更方便，对代码的入侵更小，如果大家感兴趣的话可以尝试一下。

一. xxljob简介

xxljob是一款开源的任务调度框架，它支持分布式、集群、高可用的任务调度服务，可以满足不同场景的任务调度需求。它提供了基于RESTful API的简单、易用的接口，可以方便地实现任务的创建、修改、删除、查询等操作。 xxljob的主要特点如下：

1. 分布式、集群、高可用

xxljob支持分布式、集群、高可用的任务调度服务，可以满足不同场景的任务调度需求。

2. 基于RESTful API的简单、易用的接口

xxljob提供了基于RESTful API的简单、易用的接口，可以方便地实现任务的创建、修改、删除、查询等操作。

3. 支持任务的定时执行和实时执行

xxljob支持任务的定时执行和实时执行，可以满足不同场景的任务调度需求。

4. 支持任务的并发执行

xxljob支持任务的并发执行，可以提高任务的执行效率。

二、xxljob的安装和配置

源码和结构

首先，我们需要下载xxljob的最新版本。

可通过GitHub或Gitee上下载源码：

GitHub地址：github.com/xuxueli/xxl…

Gitee地址：gitee.com/xuxueli0323…

下载完成，用IDE打开项目结构：

Spring Boot整合XXL-JOB保姆级教程

项目结构项目源码结构如下：

xxl-job-admin：调度中心

xxl-job-core：公共依赖

xxl-job-executor-samples：执行器Sample示例;

xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式;

xxl-job-executor-sample-frameless：无框架版本;

部署时，调度中心单独部署，samples中代码可集成到项目中进行使用。

初始化表结构

找到项目源码中doc/db目录下的tables_xxl_job.sql，用来初始化数据库表结构。

会创建一个名为xxl_job的数据库，并且包含了8张以xxl_job开头的表。

Spring Boot整合XXL-JOB保姆级教程

配置部署调度中心

修改调度中心的配置文件

调度中心配置文件地址：/xxl-job/xxl-job-admin/src/main/resources/application.properties

修改配置文件如下：

### 服务部署的端口，
server.port=8080
server.servlet.context-path=/xxl-job-admin

###调度中心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.cj.jdbc.Driver

### 报警邮箱，定时任务报错发报警信息到对应的邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxxx
spring.mail.from=xxxxx
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.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

对调度中心打包部署

## 打包项目
mvn clean compile package install
## 找到打包后的jar包目录下
java -jar xxl-job-admin-2.4.1-SNAPSHOT.jar

修改之后，启动完毕。

访问：http://localhost:8888/xxl-job-admin

这里笔者将端口进行了修改。默认的用户名为：admin，密码为：123456。

登录成功，主界面显示如下：

Spring Boot整合XXL-JOB保姆级教程

三、项目整合和执行器

首先，在项目中引入了xxl-job的依赖：

<dependency>
   <groupId>com.xuxueli</groupId>
   <artifactId>xxl-job-core</artifactId>
   <version>${project.parent.version}</version>
</dependency>

配置好依赖之后，项目中设置配置，代码和配置如下：

@Slf4j
@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() {
        log.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;
    }

}


#xxl-job
xxl:
  job:
    admin:
      addresses: http://xxxxxx:8088/xxl-job-admin
    executor:
      appname: xxx
      ip:
      port: 9010
      logpath: /data/applogs/xxl-job/xxx
      logretentiondays: -1
    accessToken:

之后基于@XxlJob来定义定时任务的JobHandler。如下便新定义了一个JobHandler：

@Slf4j
@Component
public class MyJobHandler {

    @Autowired
    private ISchoolFileConfigService schoolFileConfigService;

    @XxlJob("lessExpireSchoolFileJob")
    public ReturnT<String> lessExpireSchoolFileJob(String param) {
        String jobParam = XxlJobHelper.getJobParam();
        return ReturnT.SUCCESS;
    }
}