上一篇安裝了 xxl-job的服務端,
https://www.cnblogs.com/a393060727/p/13306981.html
接下來是客戶端安裝。
還是照着官網來。
在我們下載的git代碼中,有個xxl-job-executor-samples子工程,
這個子工程就是當前支持的各種語言的例子,如何接入的,我當前使用的是springboot,所以這只介紹下springboot接入方式。
我測試,只需要配置幾個東西就搞定了。
pom.xml引入核心類包:
<!-- xxl-job任務 --> <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.2.0</version> </dependency>
1、配置文件java類,配置文件原封不動
package com.xxl.job.executor.core.config; import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @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; } /** * 針對多網卡、容器內部署等情況,可借助 "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(); */ }
2、配置文件application.properties
# no web
#spring.main.web-environment=false
# log config
#logging.config=classpath:logback.xml
### 這里接入服務端的地址。
xxl.job.admin.addresses=http://192.168.89.190:48080/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=
### xxl-job 執行應用名稱,最好直接跟服務名稱一致即可
xxl.job.executor.appname=job-a
### 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=9998
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job 日志保留天數
xxl.job.executor.logretentiondays=7
application.yml
server: port: 9090 spring: application: name: job-a
也可以直接一個文件寫完:
server: port: 9090 spring: application: name: job-a xxl.job: admin.addresses: http://192.168.89.190:48080/xxl-job-admin ### xxl-job, access token accessToken: ### 執行器應用名稱 executor.appname: job-a ### 執行器注冊地址:默認使用注冊地址,也可以使用配置的ip:端口 executor: address: ### 執行器服務信息IP、端口 ip: port: 9998 ### 執行器日志路徑 logpath: /home/logs/xxl-job/jobhandler ### 執行器日志清理天數 logretentiondays: 7
這里注意下:
如果將application.properties的內容都寫到application.yml中后,節點都需要配置。。
3、執行類加上注解
import org.springframework.stereotype.Service; import com.xxl.job.core.biz.model.ReturnT; import com.xxl.job.core.handler.annotation.XxlJob; import com.xxl.job.core.log.XxlJobLogger; @Service public class UserJob { /** * 1、簡單任務示例(Bean模式) */ @XxlJob("userJobEat") public ReturnT<String> userJobEat(String param) throws Exception { XxlJobLogger.log("XXL-JOB, userJobEat"); System.out.println("XXL-JOB, userJobEat 時間" + System.currentTimeMillis()); return ReturnT.SUCCESS; } @XxlJob("userJobDrink") public ReturnT<String> userJobDrink(String param) throws Exception { XxlJobLogger.log("XXL-JOB, userJobDrink"); System.out.println("XXL-JOB, userJobDrink 時間" + System.currentTimeMillis()); // TimeUnit.SECONDS.sleep(2); return ReturnT.SUCCESS; } }
配置任務信息。
登錄服務端配置。
配置執行器:執行器管理/新增/填寫信息。。。/保存
這里的appname與配置文件中的 xxl.job.executor.appname 一致,名稱隨意
2、配置任務信息
任務管理
選擇執行器(可以看到當前執行器有多少的任務信息)
點擊新增
配置一個任務信息
這里的JobHandler必須與程序中的名稱一致。
程序中定義的hanbler名稱。
測試:
點擊保存后,查看客戶端日志,可以看到,5s調用一次服務。
在生產的時候,我們可以定義一個標識。。任務未執行完成。多服務器啟動的時候,是個競爭關系,A在執行B則不執行了。當然也可以配置廣播式(實際中比較少用)
測試OK。
當我們任務執行有問題的時候。可以在管理界面做相應操作,重跑或停止任務。。
后台可以查詢到任務執行情況,時間。。