0. 引言
實(shí)際開發(fā)中，我們常常遇到需要定時(shí)執(zhí)行的任務(wù)，我們可以利用定時(shí)線程池或schedule框架等來實(shí)現(xiàn)定時(shí)任務(wù)，但這些方式都有效率、性能上的缺陷，在微服務(wù)框架下，我們期望一種更加規(guī)整、輕量、可靠的定時(shí)任務(wù)框架來幫助我們實(shí)現(xiàn)定時(shí)任務(wù)，以及可視化的管理定時(shí)任務(wù)。
在這樣的需求下，國產(chǎn)定時(shí)任務(wù)框架xxl-job應(yīng)運(yùn)而生。
1. xxl-job簡介
xxl-job是分布式的任務(wù)調(diào)度平臺(tái)，以作者名字命名，以其輕量、可視、易上手迅速在微服務(wù)框架下站穩(wěn)腳跟。xxl-job分為服務(wù)端和客戶端，客戶端也就是我們的定時(shí)任務(wù)方法實(shí)現(xiàn)，也稱為執(zhí)行器，而服務(wù)端用來管理定時(shí)任務(wù)配置以及記錄執(zhí)行情況，也稱為調(diào)度器
官方文檔：https://www.xuxueli.com/xxl-job/
2. xxl-job安裝
1、在xxl-job github倉庫](https://github.com/xuxueli/xxl-job/releases)，下載源碼，我這里直接選擇最新版下載
2、在idea中以maven形式打開該項(xiàng)目，其中的xxl-job-admin就是我們要安裝的服務(wù)端，可以看到該服務(wù)端其實(shí)就是一個(gè)springboot項(xiàng)目，xxl-job-core是公共依賴，xxl-job-executor-samples是客戶端的示例代碼
3、在doc文件夾下找到tables_xxl_job.sql文件
利用該文件創(chuàng)建數(shù)據(jù)庫xxl-job
4、在xxl-job-admin項(xiàng)目中的resource文件夾下的application.properties配置文件，修改其數(shù)據(jù)庫地址、服務(wù)端口號(hào)、數(shù)據(jù)庫連接池、預(yù)警發(fā)送郵箱等信息
### web 端口
server.port=8080
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 數(shù)據(jù)庫
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
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 預(yù)警發(fā)送郵箱
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
5、logback.xml是日志配置文件，如果要修改日志保存路徑，可以在此配置，啟動(dòng)項(xiàng)目時(shí)如果沒有配置的日志文件夾會(huì)報(bào)錯(cuò)，所以提前修改好日志路徑
6、本地啟動(dòng)服務(wù)端的話，只需要運(yùn)行該xxl-job項(xiàng)目即可，如果要將服務(wù)端發(fā)布到服務(wù)器上，將其打包，然后放到服務(wù)器上運(yùn)行即可
這里為了照顧部分初學(xué)者，詳細(xì)講解下打包發(fā)布流程，如果掌握的同學(xué)，可直接跳過
2.1 發(fā)布xxl-job-admin到服務(wù)器
1、修改配置文件數(shù)據(jù)庫地址
2、修改預(yù)警發(fā)送郵箱，如果不知道如何獲取郵箱授權(quán)碼的可以參考我這篇文章：https://wu55555.blog.csdn.net/article/details/127156042
不需要預(yù)警可不用配置
3、修改日志路徑
4、打包xxl-job-admin
5、將打包出來的jar包上傳到目標(biāo)服務(wù)器（因?yàn)槭莏ava項(xiàng)目，請(qǐng)?zhí)崆霸诜?wù)器上安裝jdk）
6、創(chuàng)建日志文件夾
mkdir -p /data/logs/xxl-job-2.4.0/log
7、因?yàn)槲覀兣渲玫哪J(rèn)的8080端口，所以需要開啟8080端口，如果沒有開啟防火墻則不用開啟端口
firewall-cmd --add-port=8080/tcp --permanent
firewall-cmd --reload
8、啟動(dòng)xxl-job-admin
# 前臺(tái)啟動(dòng)，關(guān)閉窗口或者ctrl+c會(huì)關(guān)閉項(xiàng)目
java -jar xxl-job-admin-2.4.0.jar
# 后臺(tái)啟動(dòng)，關(guān)閉窗口或者ctrl+c不會(huì)關(guān)閉項(xiàng)目
nohup java -jar xxl-job-admin-2.4.0.jar &
9、訪問項(xiàng)目：服務(wù)器ip:8080/xxl-job-admin，默認(rèn)登陸賬號(hào)密碼：admin/123456
3. 客戶端定時(shí)任務(wù)書寫
1、這里我們創(chuàng)建一個(gè)springboot項(xiàng)目，用來書寫定時(shí)任務(wù)
2、引入依賴，版本與服務(wù)端版本保持一致
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.4.0</version>
</dependency>
3、修改配置文件
# 服務(wù)端地址
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### xxl-job, access token，與服務(wù)端配置的保持一致
xxl.job.accessToken=default_token
### xxl-job executor appname
xxl.job.executor.appname=job-server
# 執(zhí)行器注冊(cè)地址，默認(rèn)使用address，否則使用ip:port，這是注冊(cè)到服務(wù)端的地址
xxl.job.executor.address=
# 執(zhí)行器ip
xxl.job.executor.ip=
# 執(zhí)行器端口
xxl.job.executor.port=9998
### xxl-job executor log-path
xxl.job.executor.logpath=/data/logs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30
4、創(chuàng)建配置類XxlJobConfig
@Configuration
public class XxlJobConfig {
private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
@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() {
logger.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);
return xxlJobSpringExecutor;
}
/**
* 針對(duì)多網(wǎng)卡、容器內(nèi)部署等情況，可借助 "spring-cloud-commons" 提供的 "InetUtils" 組件靈活定制注冊(cè)IP；
*
* 1、引入依賴：
* <dependency>
* <groupId>org.springframework.cloud</groupId>
* <artifactId>spring-cloud-commons</artifactId>
* <version>${version}</version>
* </dependency>
*
* 2、配置文件，或者容器啟動(dòng)變量
* spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
*
* 3、獲取IP
* String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
*/
}
5、我們創(chuàng)建一個(gè)定時(shí)方法，可以看到只需要在需要定時(shí)執(zhí)行的方法上加一個(gè)@XxlJob注解即可，其屬性值是這個(gè)定時(shí)方法的名稱，后續(xù)會(huì)在服務(wù)端配置，要保證唯一
同時(shí)注意定時(shí)任務(wù)類要聲明為bean，即加上@Component
@Component
public class JobService {
@XxlJob("testJob")
public void testJob() throws Exception {
String param = XxlJobHelper.getJobParam();
System.out.println("執(zhí)行定時(shí)任務(wù)，參數(shù)為："+param);
}
}
4. 服務(wù)端配置
xxl-job-admin服務(wù)端有如下幾個(gè)菜單
運(yùn)行報(bào)表：定時(shí)任務(wù)運(yùn)行情況統(tǒng)計(jì)
任務(wù)管理：配置的定時(shí)任務(wù)
調(diào)度日志：每個(gè)定時(shí)任務(wù)的具體執(zhí)行日志
用戶管理：賬號(hào)管理，可針對(duì)執(zhí)行器配置權(quán)限
執(zhí)行器管理：執(zhí)行器就是客戶端，也就是后臺(tái)的定時(shí)任務(wù)方法
1、首先我們需要新增一個(gè)執(zhí)行器，這里選擇自動(dòng)注冊(cè)，有時(shí)我們要進(jìn)行聯(lián)調(diào)，需要指定執(zhí)行器為我們本地的執(zhí)行器，這時(shí)可以用手動(dòng)錄入ip的注冊(cè)形式，地址就是我們之前配置的xxl.job.executor.address或xxl.job.executor.ip+xxl.job.executor.port
注意：這里的appName要與客戶端中配置的xxl.job.executor.appname保持一致
手動(dòng)錄入形式：
2、啟動(dòng)執(zhí)行器項(xiàng)目，即上述創(chuàng)建的job-server項(xiàng)目
3、進(jìn)入任務(wù)管理，執(zhí)行器切換為我們剛新建的執(zhí)行器，然后新建一個(gè)任務(wù)
4、配置任務(wù)名，cron表達(dá)式（這里我配置的每秒執(zhí)行一次），JobHandler就是我們之前在客戶端書寫的定時(shí)任務(wù)名稱，即@XxlJob注解的值
其中各項(xiàng)配置說明如下：
- 調(diào)度類型：
支持3種調(diào)度模式corn表達(dá)式
cron: 自由配置定時(shí)間隔；無：手動(dòng)觸發(fā)執(zhí)行；固定：固定周期執(zhí)行，比如30s執(zhí)行一次
- 運(yùn)行模式
默認(rèn)為BEAN，從執(zhí)行器調(diào)度方法，還可以配置GLUE模式，配置后在列表頁會(huì)出現(xiàn)一個(gè)GULE按鈕，點(diǎn)擊可以進(jìn)入在線書寫對(duì)應(yīng)語言的代碼，相當(dāng)于一個(gè)在線書寫的執(zhí)行器方法，也就是客戶端任務(wù)以源碼的方式維護(hù)在調(diào)度中心，支持java,shell,python等語言
- 任務(wù)參數(shù)
可以設(shè)置固定的任務(wù)參數(shù)，或者留空，也可以在手動(dòng)執(zhí)行的時(shí)候填寫任務(wù)參數(shù)，比如一些按照日期執(zhí)行的定時(shí)任務(wù)，想要回去執(zhí)行歷史日期的，就可以將參數(shù)定為日期，不填就默認(rèn)為當(dāng)天
- 路由策略
當(dāng)存在多個(gè)執(zhí)行器時(shí)就需要配置路由策略，也就是負(fù)載均衡策略，比較常用的就是輪詢
- 子任務(wù)ID
如果需要在當(dāng)前任務(wù)執(zhí)行完成后，聯(lián)動(dòng)觸發(fā)下一個(gè)任務(wù)，則可配置子任務(wù)，ID在列表中可查看到
- 調(diào)度過期策略
支持兩種策略，為什么會(huì)出現(xiàn)過期，我們將在后續(xù)單獨(dú)講解
忽略：調(diào)度過期后，忽略過期的任務(wù)，從當(dāng)前時(shí)間開始重新計(jì)算下次觸發(fā)時(shí)間；
立即執(zhí)行一次：調(diào)度過期后，立即執(zhí)行一次，并從當(dāng)前時(shí)間開始重新計(jì)算下次觸發(fā)時(shí)間；
- 阻塞處理策略
對(duì)于任務(wù)太多太密集，導(dǎo)致執(zhí)行器來不及執(zhí)行時(shí)，所采取的策略，支持如下三種
單機(jī)串行（默認(rèn)）：進(jìn)入等待隊(duì)列，先進(jìn)先出，等著執(zhí)行；
丟棄后續(xù)調(diào)度：丟棄，不管了
覆蓋之前調(diào)度：終止正在運(yùn)行的調(diào)度任務(wù)，并清空等待隊(duì)列，然后運(yùn)行當(dāng)前任務(wù)
- 任務(wù)超時(shí)時(shí)間
任務(wù)運(yùn)行超過超時(shí)時(shí)間就會(huì)直接中斷
- 失敗重試次數(shù)
任務(wù)失敗后進(jìn)行重試的次數(shù)
對(duì)于沒有掌握cron表達(dá)式的同學(xué)，可以通過這個(gè)網(wǎng)站來幫我們書寫cron表達(dá)式，通過勾選即可生成想要的cron表達(dá)式
https://cron.qqe2.com/
5、創(chuàng)建好的任務(wù)默認(rèn)是關(guān)閉的，還需要啟動(dòng)任務(wù)，如果任務(wù)只需要執(zhí)行一次，可以選擇不啟動(dòng)，手動(dòng)點(diǎn)擊執(zhí)行一次即可
6、啟動(dòng)好的項(xiàng)目狀態(tài)為running
7、我們查看job-server就能看到任務(wù)正在執(zhí)行了
8、可以看到這里參數(shù)為空，這是因?yàn)槲覀冊(cè)诜?wù)端配置任務(wù)時(shí)沒有配置參數(shù)，我們通過手動(dòng)執(zhí)行一次，執(zhí)行參數(shù)給大家看下效果
總結(jié)
至此，咱們針對(duì)定時(shí)任務(wù)框架xxl-job的講解就結(jié)束了，自己搭建起來試下吧文章來源：http://www.zghlxwxcb.cn/news/detail-404814.html
文章來源地址http://www.zghlxwxcb.cn/news/detail-404814.html
到了這里，關(guān)于springcloud：快速上手定時(shí)任務(wù)框架xxl-job（十五）的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
