SpringBoot整合Xxl-job實現(xiàn)定時任務的全過程
前言
? XXL-JOB是一個分布式任務調(diào)度平臺,其核心設計目標是開發(fā)迅速、學習簡單、輕量級、易擴展。現(xiàn)已開放源代碼并接入多家公司線上產(chǎn)品線,開箱即用。
如果是單機并且定時任務不多的情況,可以選擇Timer注解@Scheduled或者Cron工具類等方式來實現(xiàn),但是這有個缺點,那就是定時任務會寫死在代碼中,一旦啟動,就不能暫?;蛘咝薷摹H绻薷牡脑?,整個還項目要重新編譯,這屬實非常的麻煩。
? 本篇文章將會介紹如何通過xxl-job來實現(xiàn)任務的調(diào)度
一、部署調(diào)度中心
1、項目下載
下面是調(diào)度中心代碼的gitee地址,可以colon到本地
http://gitee.com/xuxueli0323/xxl-job
2、初始化數(shù)據(jù)
在下載好的項目中的doc/db目錄下有一個tables_xxl_job.sql文件,先放到自己的數(shù)據(jù)庫中執(zhí)行,其實就是初始化好調(diào)度中心需要的表結(jié)構(gòu)和數(shù)據(jù)
3、修改properties配置文件
用IDE打開clone好的項目,然后修改xxl-job-admin模塊下的properties配置文件,只需要將連接數(shù)據(jù)庫的url、username、password修改成你自己的就可以。修改好之后就可以啟動xxl-job-admin調(diào)度中心了。然后打開http://localhost:8080/xxl-job-admin/就可以看到控制面板:
二、部署SpringBoot項目
1、引入依賴
<dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.2.0</version> </dependency>
2、創(chuàng)建配置類
@Configuration public class XxlJobConfig { private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class); @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() { logger.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; } }
3、修改配置文件
xxl: job: admin: addresses: http://127.0.0.1:8080/xxl-job-admin #部署的調(diào)度中心的url executor: appname: xxl-job-volunteer-executor #執(zhí)行器的名字 ip: port: 9999 #調(diào)度中心調(diào)用執(zhí)行器時使用的端口 logpath: /data/apploggs/xxl-job/jobhandler #日志路徑 logretentiondays: 30 #日志保留天數(shù) accessToken:
4、創(chuàng)建執(zhí)行器
@Component public class XxlJobSample { // myDemoJob是任務的名字,也是Spring中bean的名字 @XxlJob("myDemoJob") public ReturnT<String> myDemoJob(String value) { System.out.println("myDemoJob:定時任務觸發(fā):" + value); return ReturnT.SUCCESS; } }
5、啟動SpringBoot項目
啟動成功后會看到下面兩行日志信息, 可以看到成功連接到了調(diào)度中心然后注冊了將要被調(diào)度任務
>>>>>>>>>>> xxl-job register jobhandler success, name:myDemoJob, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@1f94dd63[class com.volunteer.component.XxlJobSample#myDemoJob] >>>>>>>>>>> xxl-job remoting server start success, nettype = class com.xxl.job.core.server.EmbedServer, port = 9999
三、通過調(diào)度中心進行任務調(diào)度
1、添加執(zhí)行器
輸入配置文件中配置的appName,名稱可以隨意
2、添加任務
新增調(diào)度任務
查看調(diào)度任務
3、任務調(diào)度中心發(fā)起任務調(diào)度
在SpringBoot項目中可以看到控制臺輸出如下信息:
2022-01-16 11:54:05.039 INFO 7836 --- [Pool-1148366645] c.xxl.job.core.executor.XxlJobExecutor : >>>>>>>>>>> xxl-job regist JobThread success, jobId:7, handler:com.xxl.job.core.handler.impl.MethodJobHandler@1f94dd63[class com.volunteer.component.XxlJobSample#myDemoJob] myDemoJob:定時任務觸發(fā):testParam 2022-01-16 11:55:38.059 INFO 7836 --- [ Thread-22] com.xxl.job.core.thread.JobThread : >>>>>>>>>>> xxl-job JobThread stoped, hashCode:Thread[Thread-22,10,main]
四、小結(jié)
至此,SpringBoot整合Xxl-job就完成了,剛才的示例代碼其實對于原來的項目還是有一定的侵入性的,上面僅僅演示了BEAN運行模式,說白了就是調(diào)用加了@XxlJob的方法。其實在創(chuàng)建任務的時候還可以嘗試使用GLUE(Java)這一運行模式,這種方式其實就是執(zhí)行你輸入的Java代碼,這種方式可以不用在原有的項目之上新增依賴或者配置,對于定時任務,只需要編寫一個接口用于觸發(fā),然后GLUE(Java)任務定時的去請求暴露的接口即可
下面是代碼片段:
public class DemoGlueJobHandler extends IJobHandler { @Override public void execute() throws Exception { XxlJobHelper.log("定時任務執(zhí)行了一次"); HttpRequest.post("http://localhost:8088/oos/test") .header(Header.USER_AGENT, "xxl-job")//頭信息,多個頭信息多次調(diào)用此方法即可 .timeout(20000)//超時,毫秒 .execute(); } }
上面的代碼其實會在執(zhí)行器中進行執(zhí)行,可以實現(xiàn)在Test里面跑一下,沒有問題后再貼過來(還要注意復制import等信息)
以上就是今天的全部內(nèi)容了,想了解更多,可以閱讀官方文檔
總結(jié)
到此這篇關于SpringBoot整合Xxl-job實現(xiàn)定時任務的文章就介紹到這了,更多相關SpringBoot整合Xxl-job實現(xiàn)定時任務內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
一文解決System.in關閉后無法再繼續(xù)使用流的問題
這篇文章主要給大家介紹如何解決System.in關閉后無法再繼續(xù)使用流的問題,文中有詳細的解決方法和代碼示例,具有一定的參考價值,需要的朋友可以參考下2023-07-07SpringBoot集成Swagger2實現(xiàn)Restful(類型轉(zhuǎn)換錯誤解決辦法)
這篇文章主要介紹了SpringBoot集成Swagger2實現(xiàn)Restful(類型轉(zhuǎn)換錯誤解決辦法),需要的朋友可以參考下2017-07-07SpringBoot 動態(tài)配置郵箱發(fā)件人過程解析
這篇文章主要介紹了SpringBoot 動態(tài)配置郵箱發(fā)件人過程解析,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-08-08