XXL-JOB任务调度使用

背景

系统项目采用多节点部署，由于代码中有定时任务，多节点会导致任务重复执行，会生成大量冗余数据，因此需要把定时任务功能抽离。现成的任务调度平台有很多，像Quartz、xxl-job等，这次尝试xxl-job。
XXL-JOB官方文档：https://www.xuxueli.com/xxl-job/
以下为记录开发过程。

开发

开发准备

环境：jdk8
语言：kotlin
框架：spring boot 2.4.5

1. 数据库准备

去到代码仓库找到sql文件并创建相关库

/xxl-job/doc/db/tables_xxl_job.sql

2. 使用docker镜像搭建调度中心

docker pull xuxueli/xxl-job-admin:2.3.0
# 需要配置好数据库的链接地址、用户名及密码
docker run -e PARAMS="--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=123456" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:2.3.0

3. maven依赖

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

4. xxl-job配置信息

修改spring的配置文件application.yml，加入以下信息。这里和官网的写法有点不太一样，是因为我不想要这么多的层级关系，方便配置对象的构建。

xxl:
  job:
    admin-addresses: http://127.0.0.1:8080/xxl-job-admin
    executor-appname: xxl-job-executor
    executor-port: 8082

5. xxl-job配置类

XxlJobProperties.kt用于存储配置文件的信息。

import org.springframework.boot.context.properties.ConfigurationProperties

/**
 * @Author  Anson
 * @Date  2021/12/30 11:37
 * @Version 1.0
 */
@ConfigurationProperties(prefix = "xxl.job")
class XxlJobProperties {
    var adminAddresses: String? = null
    var accessToken: String? = null
    var executorAppname: String? = null
    var executorAddress: String? = null
    var executorIp: String? = null
    var executorPort: Int = 0
    var executorLogpath: String? = null
    var executorLogretentiondays: Int = 0
}

XxlJobConfig.kt用于spring boot启用配置注入。直接使用了文档里面的代码，只做了部分调整。

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor
import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

/**
 * @Author  Anson
 * @Date  2021/12/30 11:14
 * @Version 1.0
 */
@Configuration
@EnableConfigurationProperties(XxlJobProperties::class)
class XxlJobConfig(
    private val properties: XxlJobProperties
) {

    @Bean
    fun xxlJobExecutor(): XxlJobSpringExecutor {
        val xxlJobSpringExecutor = XxlJobSpringExecutor()
        xxlJobSpringExecutor.setAdminAddresses(properties.adminAddresses)
        xxlJobSpringExecutor.setAppname(properties.executorAppname)
        xxlJobSpringExecutor.setAddress(properties.executorAddress)
        xxlJobSpringExecutor.setIp(properties.executorIp)
        xxlJobSpringExecutor.setPort(properties.executorPort)
        xxlJobSpringExecutor.setAccessToken(properties.accessToken)
        xxlJobSpringExecutor.setLogPath(properties.executorLogpath)
        xxlJobSpringExecutor.setLogRetentionDays(properties.executorLogretentiondays)
        return xxlJobSpringExecutor
    }
    /**
     * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
     *
     * 1、引入依赖：
     * <dependency>
     * <groupId>org.springframework.cloud</groupId>
     * <artifactId>spring-cloud-commons</artifactId>
     * <version>${version}</version>
    </dependency> *
     *
     * 2、配置文件，或者容器启动变量
     * spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     * 3、获取IP
     * String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */
}

6. 执行器

新建MyJob.kt用于调度中心执行任务。`printLoHandler'名称需与调度中心配置的完全一致。

import com.xxl.job.core.handler.annotation.XxlJob
import org.apache.logging.log4j.LogManager
import org.springframework.stereotype.Component

/**
 * @Author  Anson
 * @Date  2021/12/31 10:08
 * @Version 1.0
 */
@Component
class MyJob{
    private val logger = LogManager.getLogger()

    @XxlJob("printLogHandler")
    fun logHandler() {
        logger.info("[Xxl job Cron job] handler start!")
    }
}

7. 打开调度中心进行配置

http://127.0.0.1:8080/xxl-job-admin
如何配置就不在这里赘述了，有界面比较简单明了。