xxl-job定時(shí)任務(wù)配置應(yīng)用及添加到springboot項(xiàng)目中實(shí)現(xiàn)動(dòng)態(tài)API調(diào)用
簡(jiǎn)介
XXL-JOB是一個(gè)分布式任務(wù)調(diào)度平臺(tái),其核心設(shè)計(jì)目標(biāo)是開(kāi)發(fā)迅速、學(xué)習(xí)簡(jiǎn)單、輕量級(jí)、易擴(kuò)展?,F(xiàn)已開(kāi)放源代碼并接入多家公司線上產(chǎn)品線,開(kāi)箱即用。
本篇文章主要是對(duì)xuxueli的xxl-job做一個(gè)簡(jiǎn)單的配置,以及將其添加到自己已有的項(xiàng)目中進(jìn)行api調(diào)用。
xxl-job的安裝與配置
一、xxl-job安裝
1、首先訪問(wèn)Gitee克隆/下載xxl-job的源碼
https://gitee.com/xuxueli0323/xxl-job
2、下載完解壓,在源碼文件夾xxl-job-master\xxl-job-master\doc\db里先導(dǎo)入SQL文件到數(shù)據(jù)庫(kù)


3、在IDEA中打開(kāi)下載好的項(xiàng)目文件,使用maven進(jìn)行編譯即可

xxl-job-admin:調(diào)度中心
xxl-job-core:公共依賴
xxl-job-executor-samples:執(zhí)行器Sample示例(選擇合適的版本執(zhí)行器,可直接使用,也可以參考其并將現(xiàn)有項(xiàng)目改造成執(zhí)行器)
xxl-job-executor-sample-springboot:Springboot版本,通過(guò)Springboot管理執(zhí)行器,推薦這種方式;
xxl-job-executor-sample-frameless:無(wú)框架版本;
二、xxl-job的配置
首先配置調(diào)度中心

### web server.port=9527 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://192.168.3.140: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 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
這塊我設(shè)置了任務(wù)調(diào)度中心的admin端口是9527(端口號(hào)可以自定義),spring.datasource.url地址填你導(dǎo)入sql文件的數(shù)據(jù)庫(kù)。
接著設(shè)置xxl-job-executor-sample-springboot的配置文件

# web port server.port=9528 # no web #spring.main.web-environment=false # log config logging.config=classpath:logback.xml ### xxl-job admin address list, such as "http://address" or "http://address01,http://address02" xxl.job.admin.addresses=http://127.0.0.1:9527/xxl-job-admin ### xxl-job, access token xxl.job.accessToken=default_token ### xxl-job executor appname xxl.job.executor.appname=test ### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null xxl.job.executor.address= ### xxl-job executor server-info xxl.job.executor.ip= xxl.job.executor.port=9999 ### xxl-job executor log-path xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler ### xxl-job executor log-retention-days xxl.job.executor.logretentiondays=30
xxl-job-executor-sample-springboot端口號(hào)為了方便區(qū)分我設(shè)置了9528(端口號(hào)不能與其他端口重復(fù))
到此xxl-job的基本配置就設(shè)置好了
三、啟動(dòng)項(xiàng)目
分別啟動(dòng)xxl-job-admin調(diào)度中心和xxl-job-executor-sample-springboot的啟動(dòng)命令

打開(kāi)鏈接http://localhost:9527/xxl-job-admin/
執(zhí)行器管理新增執(zhí)行器

配置執(zhí)行器時(shí),有幾個(gè)注意的地方
①執(zhí)行器的AppName必須與xxl.job.executor.appname保持一致
②這里新增執(zhí)行器建議手動(dòng)錄入,自動(dòng)注冊(cè)可能存在斷開(kāi)連接的問(wèn)題,機(jī)器地址后的端口號(hào)要與xxl.job.executor.port端口號(hào)保持一致,且要加前綴https://
配置好執(zhí)行器就可以編寫定時(shí)任務(wù)了
在這里使用xuxueli提供定時(shí)任務(wù)示例,具體位置如下:

注解中的值就是任務(wù)配置中的JobHandler
回到任務(wù)調(diào)度中心,打開(kāi)任務(wù)管理,執(zhí)行器選擇剛才新建的測(cè)試執(zhí)行器,點(diǎn)擊右側(cè)新增任務(wù)


這里以BEAN運(yùn)行模式為例,JobHandler中的值填方法上注解@XxlJob的值,Cron表達(dá)式可以根據(jù)需求生成,下面貼一個(gè)cron的鏈接,可以根據(jù)需要去編寫獲取,這里以兩秒鐘執(zhí)行一次為例,配置完后點(diǎn)擊保存。
回到任務(wù)管理,找到配置好的任務(wù),點(diǎn)擊操作----啟動(dòng)

定時(shí)任務(wù)就開(kāi)始啟動(dòng)了,具體效果可以打開(kāi)IDEA的9528服務(wù)看效果

以此xxl-job的安裝與配置結(jié)束,現(xiàn)在開(kāi)始引入到我們的springboot項(xiàng)目中
xxl-job添加到已有項(xiàng)目
一、引入POM文件
<!-- xxl-job-core -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
</dependency>二、編寫XxlJob的配置文件
因?yàn)樯厦嬗眠^(guò)properties了,這里展示一下使用YML來(lái)進(jìn)行配置
xxl:
job:
accessToken: default_token
admin:
addresses: http://192.168.3.27:9527/xxl-job-admin
executor:
appname: fnTest
address:
ip:
port: 9999
logpath: D:\Work\logs
logretentiondays: 30三、編寫config配置類
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* XXL-JOB配置類
*
* @author 單程車票
*/
@Slf4j
@Configuration
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);
return xxlJobSpringExecutor;
}
}四、配置任務(wù)調(diào)度
還是需要打開(kāi)xxl-job-admin任務(wù)調(diào)度中心服務(wù)
這里還是以上文說(shuō)的9527為例

同樣新增執(zhí)行器

五、編寫自己的定時(shí)任務(wù)
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.util.Date;
@Component
@Slf4j
public class TestJob {
@XxlJob("FnHandler")
public ReturnT<String> wechatActivityJobHandler(String param) {
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
log.info(">>>定時(shí)任務(wù)開(kāi)始出發(fā)<<<param:{}", param);
return ReturnT.SUCCESS;
}
}同樣再回到任務(wù)調(diào)度中心,任務(wù)管理---新增任務(wù)
JobHandler填寫注解@XxlJob中的值,Cron按自身要求編寫,保存
執(zhí)行定時(shí)任務(wù)

至此,xxl-job已經(jīng)添加到項(xiàng)目中了,可以去任務(wù)調(diào)度中心查看任務(wù)日志

這篇文章就先分享到這里了,感謝瀏覽到最后,有問(wèn)題的話,歡迎大家留言。
到此這篇關(guān)于xxl-job定時(shí)任務(wù)配置應(yīng)用以及添加到自己已有的springboot項(xiàng)目中實(shí)現(xiàn)動(dòng)態(tài)API調(diào)用的文章就介紹到這了,更多相關(guān)xxl-job定時(shí)任務(wù)配置內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringBoot集成XXL-JOB實(shí)現(xiàn)靈活控制的分片處理方案
- SpringBoot集成xxl-job實(shí)現(xiàn)超牛的定時(shí)任務(wù)的步驟詳解
- SpringBoot部署xxl-job方法詳細(xì)講解
- springboot整合xxl-job實(shí)現(xiàn)分布式定時(shí)任務(wù)的過(guò)程
- 分布式調(diào)度XXL-Job整合Springboot2.X實(shí)戰(zhàn)操作過(guò)程(推薦)
- SpringBoot整合Xxl-job實(shí)現(xiàn)定時(shí)任務(wù)的全過(guò)程
- SpringBoot整合Xxl-Job的完整步驟記錄
- springboot整合 xxl-job及使用步驟
相關(guān)文章
Java中transient關(guān)鍵字的詳細(xì)總結(jié)
本文要介紹的是Java中的transient關(guān)鍵字,transient是短暫的意思。對(duì)于transient 修飾的成員變量,在類的實(shí)例對(duì)象的序列化處理過(guò)程中會(huì)被忽略,感興趣的朋友可以參考閱讀2023-04-04
java工具類實(shí)現(xiàn)文件壓縮zip以及解壓縮功能
這篇文章主要給大家介紹了關(guān)于java工具類實(shí)現(xiàn)文件壓縮zip以及解壓縮功能的相關(guān)資料,文中主要使用使用的是hutool工具類,Hutool是一個(gè)Java工具類庫(kù),由國(guó)內(nèi)的程序員loolly開(kāi)發(fā),目的是提供一些方便、快捷、實(shí)用的工具類和工具方法,需要的朋友可以參考下2024-02-02
詳解Spring Data JPA動(dòng)態(tài)條件查詢的寫法
本篇文章主要介紹了Spring Data JPA動(dòng)態(tài)條件查詢的寫法 ,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-06-06
Spring中的EurekaServer啟動(dòng)詳解
這篇文章主要介紹了Spring中的EurekaServer啟動(dòng)詳解,初始化eureka,包含eureka集群的同步和發(fā)布注冊(cè),這個(gè)方法時(shí)重寫ServletContextListener#contextInitialized,是eureka啟動(dòng)的入口了,需要的朋友可以參考下2023-11-11
SpringBoot如何利用Twilio?Verify發(fā)送驗(yàn)證碼短信
Twilio提供了一個(gè)名為?Twilio?Verify?的服務(wù),專門用于處理驗(yàn)證碼的發(fā)送和驗(yàn)證,下面我們就來(lái)看看如何使用Twilio?Verify實(shí)現(xiàn)發(fā)送驗(yàn)證碼短信吧2025-03-03
Java使用poi組件導(dǎo)出Excel格式數(shù)據(jù)
這篇文章主要介紹了Java使用poi組件導(dǎo)出Excel格式數(shù)據(jù),需要的朋友可以參考下2020-02-02
Java設(shè)計(jì)模式之java責(zé)任鏈模式詳解
這篇文章主要介紹了JAVA 責(zé)任鏈模式的的相關(guān)資料,文中講解非常細(xì)致,代碼幫助大家更好的理解和學(xué)習(xí),感興趣的朋友可以了解下2021-09-09

