xxl-job介绍与使用
生活随笔
收集整理的這篇文章主要介紹了
xxl-job介绍与使用
小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.
XXL-JOB
- 1.概述
- 2.文檔
- 3.環(huán)境
- 4.架構(gòu)
- 5.部署
- 5.1初始化調(diào)度數(shù)據(jù)庫
- 5.2編譯源碼
- 5.3配置部署調(diào)度中心
- 5.3.1配置部署調(diào)度中心
- 5.4 部署項目
- 6.springboot引入xxl-job
- 6.1配置maven
- 6.2配置application.yml
- 6.3新增config配置類
- 6.4業(yè)務(wù)案例
- 6.5在任務(wù)調(diào)度配置
- 7關(guān)于分片或者其他問題
1.概述
XXL-JOB是一個分布式任務(wù)調(diào)度平臺，其核心設(shè)計目標(biāo)是開發(fā)迅速、學(xué)習(xí)簡單、輕量級、易擴展。現(xiàn)已開放源代碼并接入多家公司線上產(chǎn)品線，開箱即用。
2.文檔
- github地址
- 中文文檔
3.環(huán)境
- Maven3+
- Jdk1.8+
- Mysql5.7+
4.架構(gòu)
5.部署
5.1初始化調(diào)度數(shù)據(jù)庫
請下載項目源碼并解壓，獲取 “調(diào)度數(shù)據(jù)庫初始化SQL腳本” 并執(zhí)行即可。 “調(diào)度數(shù)據(jù)庫初始化SQL腳本” 位置為:
/xxl-job/doc/db/tables_xxl_job.sql
5.2編譯源碼
解壓源碼,按照maven格式將源碼導(dǎo)入IDE, 使用maven進行編譯即可，源碼結(jié)構(gòu)如下：
xxl-job-admin：調(diào)度中心 xxl-job-core：公共依賴 xxl-job-executor-samples：執(zhí)行器Sample示例（選擇合適的版本執(zhí)行器，可直接使用，也可以參考其并將現(xiàn)有項目改造成執(zhí)行器）：xxl-job-executor-sample-springboot：Springboot版本，通過Springboot管理執(zhí)行器，推薦這種方式；：xxl-job-executor-sample-frameless：無框架版本；5.3配置部署調(diào)度中心
調(diào)度中心項目：xxl-job-admin
作用：統(tǒng)一管理任務(wù)調(diào)度平臺上調(diào)度任務(wù)，負(fù)責(zé)觸發(fā)調(diào)度執(zhí)行，并且提供任務(wù)管理平臺。
5.3.1配置部署調(diào)度中心
調(diào)度中心配置文件地址：
/xxl-job/xxl-job-admin/src/main/resources/application.properties調(diào)度中心配置內(nèi)容說明：
### 調(diào)度中心JDBC鏈接：鏈接地址請保持和 2.1章節(jié) 所創(chuàng)建的調(diào)度數(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=root_pwd spring.datasource.driver-class-name=com.mysql.jdbc.Driver### 報警郵箱 spring.mail.host=smtp.qq.com spring.mail.port=25 spring.mail.username=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### 調(diào)度中心通訊TOKEN [選填]：非空時啟用； xxl.job.accessToken=### 調(diào)度中心國際化配置 [必填]： 默認(rèn)為 "zh_CN"/中文簡體, 可選范圍為 "zh_CN"/中文簡體, "zh_TC"/中文繁體 and "en"/英文； xxl.job.i18n=zh_CN## 調(diào)度線程池最大線程配置【必填】 xxl.job.triggerpool.fast.max=200 xxl.job.triggerpool.slow.max=100### 調(diào)度中心日志表數(shù)據(jù)保存天數(shù) [必填]：過期日志自動清理；限制大于等于7時生效，否則, 如-1，關(guān)閉自動清理功能； xxl.job.logretentiondays=305.4 部署項目
如果已經(jīng)正確進行上述配置，可將項目編譯打包部署。
調(diào)度中心訪問地址：http://localhost:8080/xxl-job-admin (該地址執(zhí)行器將會使用到，作為回調(diào)地址)
默認(rèn)登錄賬號 “admin/123456”
6.springboot引入xxl-job
6.1配置maven
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>${project.parent.version}</version> </dependency>6.2配置application.yml
# web port server.port=8081 # 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:8080/xxl-job-admin### xxl-job, access token xxl.job.accessToken=default_token### xxl-job executor appname xxl.job.executor.appname=xxl-job-executor-sample ### 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=306.3新增config配置類
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;/*** xxl-job config** @author xuxueli 2017-04-28*/ @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;@Beanpublic 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;}/*** 針對多網(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.4業(yè)務(wù)案例
/*** 1、簡單任務(wù)示例（Bean模式）*/@XxlJob("demoJobHandler")public void demoJobHandler() throws Exception {XxlJobHelper.log("XXL-JOB, Hello World.");for (int i = 0; i < 5; i++) {XxlJobHelper.log("beat at:" + i);TimeUnit.SECONDS.sleep(2);}// default success}/*** 2、分片廣播任務(wù) 用于執(zhí)行大批量任務(wù)，進行分片分擔(dān)壓力*/@XxlJob("shardingJobHandler")public void shardingJobHandler() throws Exception {// 分片參數(shù)int shardIndex = XxlJobHelper.getShardIndex();int shardTotal = XxlJobHelper.getShardTotal();XxlJobHelper.log("分片參數(shù)：當(dāng)前分片序號 = {}, 總分片數(shù) = {}", shardIndex, shardTotal);// 業(yè)務(wù)邏輯for (int i = 0; i < shardTotal; i++) {if (i == shardIndex) {XxlJobHelper.log("第 {} 片, 命中分片開始處理", i);} else {XxlJobHelper.log("第 {} 片, 忽略", i);}}}/*** 3、命令行任務(wù) 一般用于定時清楚日志，重啟服務(wù)*/@XxlJob("commandJobHandler")public void commandJobHandler() throws Exception {String command = XxlJobHelper.getJobParam();int exitValue = -1;BufferedReader bufferedReader = null;try {// command processProcessBuilder processBuilder = new ProcessBuilder();processBuilder.command(command);processBuilder.redirectErrorStream(true);Process process = processBuilder.start();//Process process = Runtime.getRuntime().exec(command);BufferedInputStream bufferedInputStream = new BufferedInputStream(process.getInputStream());bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));// command logString line;while ((line = bufferedReader.readLine()) != null) {XxlJobHelper.log(line);}// command exitprocess.waitFor();exitValue = process.exitValue();} catch (Exception e) {XxlJobHelper.log(e);} finally {if (bufferedReader != null) {bufferedReader.close();}}if (exitValue == 0) {// default success} else {XxlJobHelper.handleFail("command exit value("+exitValue+") is failed");}}/*** 4、跨平臺Http任務(wù) * 參數(shù)示例：* "url: http://www.baidu.com\n" +* "method: get\n" +* "data: content\n";*/@XxlJob("httpJobHandler")public void httpJobHandler() throws Exception {// param parseString param = XxlJobHelper.getJobParam();if (param==null || param.trim().length()==0) {XxlJobHelper.log("param["+ param +"] invalid.");XxlJobHelper.handleFail();return;}String[] httpParams = param.split("\n");String url = null;String method = null;String data = null;for (String httpParam: httpParams) {if (httpParam.startsWith("url:")) {url = httpParam.substring(httpParam.indexOf("url:") + 4).trim();}if (httpParam.startsWith("method:")) {method = httpParam.substring(httpParam.indexOf("method:") + 7).trim().toUpperCase();}if (httpParam.startsWith("data:")) {data = httpParam.substring(httpParam.indexOf("data:") + 5).trim();}}// param validif (url==null || url.trim().length()==0) {XxlJobHelper.log("url["+ url +"] invalid.");XxlJobHelper.handleFail();return;}if (method==null || !Arrays.asList("GET", "POST").contains(method)) {XxlJobHelper.log("method["+ method +"] invalid.");XxlJobHelper.handleFail();return;}boolean isPostMethod = method.equals("POST");// requestHttpURLConnection connection = null;BufferedReader bufferedReader = null;try {// connectionURL realUrl = new URL(url);connection = (HttpURLConnection) realUrl.openConnection();// connection settingconnection.setRequestMethod(method);connection.setDoOutput(isPostMethod);connection.setDoInput(true);connection.setUseCaches(false);connection.setReadTimeout(5 * 1000);connection.setConnectTimeout(3 * 1000);connection.setRequestProperty("connection", "Keep-Alive");connection.setRequestProperty("Content-Type", "application/json;charset=UTF-8");connection.setRequestProperty("Accept-Charset", "application/json;charset=UTF-8");// do connectionconnection.connect();// dataif (isPostMethod && data!=null && data.trim().length()>0) {DataOutputStream dataOutputStream = new DataOutputStream(connection.getOutputStream());dataOutputStream.write(data.getBytes("UTF-8"));dataOutputStream.flush();dataOutputStream.close();}// valid StatusCodeint statusCode = connection.getResponseCode();if (statusCode != 200) {throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid.");}// resultbufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));StringBuilder result = new StringBuilder();String line;while ((line = bufferedReader.readLine()) != null) {result.append(line);}String responseMsg = result.toString();XxlJobHelper.log(responseMsg);return;} catch (Exception e) {XxlJobHelper.log(e);XxlJobHelper.handleFail();return;} finally {try {if (bufferedReader != null) {bufferedReader.close();}if (connection != null) {connection.disconnect();}} catch (Exception e2) {XxlJobHelper.log(e2);}}}/*** 5、生命周期任務(wù)示例：任務(wù)初始化與銷毀時，支持自定義相關(guān)邏輯；*/@XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")public void demoJobHandler2() throws Exception {XxlJobHelper.log("XXL-JOB, Hello World.");}public void init(){logger.info("init");}public void destroy(){logger.info("destroy");}6.5在任務(wù)調(diào)度配置
登錄xxl-job 管理后臺
配置任務(wù)調(diào)度策略，你的定時任務(wù)就開始執(zhí)行了
7關(guān)于分片或者其他問題
大家可以看一下官網(wǎng)或者代碼都有樣例，這里不在詳細(xì)說明
總結(jié)
以上是生活随笔為你收集整理的xxl-job介绍与使用的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
