背景
系統(tǒng)項目采用多節(jié)點部署，由于代碼中有定時任務(wù)碎乃，多節(jié)點會導(dǎo)致任務(wù)重復(fù)執(zhí)行，會生成大量冗余數(shù)據(jù)惠奸，因此需要把定時任務(wù)功能抽離∶肥模現(xiàn)成的任務(wù)調(diào)度平臺有很多，像Quartz、xxl-job等梗掰，這次嘗試xxl-job嵌言。
XXL-JOB官方文檔：https://www.xuxueli.com/xxl-job/
以下為記錄開發(fā)過程。
開發(fā)
開發(fā)準備
環(huán)境：jdk8
語言：kotlin
框架：spring boot 2.4.5
1. 數(shù)據(jù)庫準備
去到代碼倉庫找到sql文件并創(chuàng)建相關(guān)庫
/xxl-job/doc/db/tables_xxl_job.sql
2. 使用docker鏡像搭建調(diào)度中心
docker pull xuxueli/xxl-job-admin:2.3.0
# 需要配置好數(shù)據(jù)庫的鏈接地址及穗、用戶名及密碼
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摧茴，加入以下信息。這里和官網(wǎng)的寫法有點不太一樣埂陆，是因為我不想要這么多的層級關(guān)系蓬蝶，方便配置對象的構(gòu)建。
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啟用配置注入粟按。直接使用了文檔里面的代碼，只做了部分調(diào)整悬襟。
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
}
/**
* 針對多網(wǎng)卡管闷、容器內(nèi)部署等情況，可借助 "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. 執(zhí)行器
新建MyJob.kt用于調(diào)度中心執(zhí)行任務(wù)。`printLoHandler'名稱需與調(diào)度中心配置的完全一致供嚎。
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. 打開調(diào)度中心進行配置
http://127.0.0.1:8080/xxl-job-admin
如何配置就不在這里贅述了黄娘，有界面比較簡單明了。
