From aaa15b403a89490a33a45d68c8b7cfa34d87b175 Mon Sep 17 00:00:00 2001 From: 疯狂的狮子li <15040126243@163.com> Date: 星期三, 20 十月 2021 13:22:45 +0800 Subject: [PATCH] add [重大更新]增加 ruoyi-job 任务调度模块(基于xxl-job) --- ruoyi-job/src/main/java/com/ruoyi/job/config/XxlJobConfig.java | 44 ++++ ruoyi-extend/ruoyi-xxl-job-admin/pom.xml | 1 ruoyi-admin/pom.xml | 5 ruoyi-admin/src/main/resources/application-prod.yml | 54 ++++- ruoyi-job/src/main/java/com/ruoyi/job/service/SampleService.java | 254 ++++++++++++++++++++++++++++ ruoyi-job/src/main/java/com/ruoyi/job/config/properties/XxlJobProperties.java | 38 ++++ ruoyi-job/pom.xml | 39 ++++ pom.xml | 21 ++ ruoyi-admin/src/main/resources/application-dev.yml | 53 ++++- 9 files changed, 477 insertions(+), 32 deletions(-) diff --git a/pom.xml b/pom.xml index be718eb..f14bbd7 100644 --- a/pom.xml +++ b/pom.xml @@ -209,6 +209,13 @@ <version>${lock4j.version}</version> </dependency> + <!-- xxl-job-core --> + <dependency> + <groupId>com.xuxueli</groupId> + <artifactId>xxl-job-core</artifactId> + <version>${xxl-job-core-version}</version> + </dependency> + <dependency> <groupId>com.yomahub</groupId> <artifactId>tlog-spring-boot-configuration</artifactId> @@ -237,10 +244,23 @@ <version>${tlog.version}</version> </dependency> + <dependency> + <groupId>com.yomahub</groupId> + <artifactId>tlog-xxl-job</artifactId> + <version>${tlog.version}</version> + </dependency> + <!-- 瀹氭椂浠诲姟 @deprecated 3.5.0鍒犻櫎 杩佺Щ鑷硏xl-job --> <dependency> <groupId>com.ruoyi</groupId> <artifactId>ruoyi-quartz</artifactId> + <version>${ruoyi-vue-plus.version}</version> + </dependency> + + <!-- 瀹氭椂浠诲姟 --> + <dependency> + <groupId>com.ruoyi</groupId> + <artifactId>ruoyi-job</artifactId> <version>${ruoyi-vue-plus.version}</version> </dependency> @@ -294,6 +314,7 @@ <module>ruoyi-framework</module> <module>ruoyi-system</module> <module>ruoyi-quartz</module> + <module>ruoyi-job</module> <module>ruoyi-generator</module> <module>ruoyi-common</module> <module>ruoyi-demo</module> diff --git a/ruoyi-admin/pom.xml b/ruoyi-admin/pom.xml index 560051b..2567d0f 100644 --- a/ruoyi-admin/pom.xml +++ b/ruoyi-admin/pom.xml @@ -49,6 +49,11 @@ <dependency> <groupId>com.ruoyi</groupId> + <artifactId>ruoyi-job</artifactId> + </dependency> + + <dependency> + <groupId>com.ruoyi</groupId> <artifactId>ruoyi-oss</artifactId> </dependency> diff --git a/ruoyi-admin/src/main/resources/application-dev.yml b/ruoyi-admin/src/main/resources/application-dev.yml index eb6962f..867a1fd 100644 --- a/ruoyi-admin/src/main/resources/application-dev.yml +++ b/ruoyi-admin/src/main/resources/application-dev.yml @@ -1,4 +1,41 @@ -# 鏁版嵁婧愰厤缃� +--- # 鐩戞帶閰嶇疆 +spring: + boot: + admin: + # Spring Boot Admin Client 瀹㈡埛绔殑鐩稿叧閰嶇疆 + client: + # 澧炲姞瀹㈡埛绔紑鍏� + enabled: true + # 璁剧疆 Spring Boot Admin Server 鍦板潃 + url: http://localhost:9090/admin + instance: + prefer-ip: true # 娉ㄥ唽瀹炰緥鏃讹紝浼樺厛浣跨敤 IP + username: ruoyi + password: 123456 + +--- # xxl-job 閰嶇疆 +xxl: + job: + # 璋冨害涓績鍦板潃锛氬璋冨害涓績闆嗙兢閮ㄧ讲瀛樺湪澶氫釜鍦板潃鍒欑敤閫楀彿鍒嗛殧銆� + admin-addresses: http://localhost:9100/xxl-job-admin + # 鎵ц鍣ㄩ�氳TOKEN锛氶潪绌烘椂鍚敤 + access-token: xxl-job + # 鎵ц鍣ㄩ厤缃� + executor: + # 鎵ц鍣ˋppName锛氭墽琛屽櫒蹇冭烦娉ㄥ唽鍒嗙粍渚濇嵁锛涗负绌哄垯鍏抽棴鑷姩娉ㄥ唽 + appname: xxl-job-executor + # 鎵ц鍣ㄧ鍙e彿 鎵ц鍣ㄤ粠9101寮�濮嬪線鍚庡啓 + port: 9101 + # 鎵ц鍣ㄦ敞鍐岋細榛樿IP:PORT + address: + # 鎵ц鍣↖P锛氶粯璁よ嚜鍔ㄨ幏鍙朓P + ip: + # 鎵ц鍣ㄨ繍琛屾棩蹇楁枃浠跺瓨鍌ㄧ鐩樿矾寰� + logpath: ./logs/xxl-job + # 鎵ц鍣ㄦ棩蹇楁枃浠朵繚瀛樺ぉ鏁帮細澶т簬3鐢熸晥 + logretentiondays: 30 + +--- # 鏁版嵁婧愰厤缃� spring: datasource: type: com.alibaba.druid.pool.DruidDataSource @@ -179,17 +216,3 @@ # # 璁㈤槄妯″紡 # subscriptionMode: "MASTER" ---- # 鐩戞帶閰嶇疆 -spring: - boot: - admin: - # Spring Boot Admin Client 瀹㈡埛绔殑鐩稿叧閰嶇疆 - client: - # 澧炲姞瀹㈡埛绔紑鍏� - enabled: true - # 璁剧疆 Spring Boot Admin Server 鍦板潃 - url: http://localhost:9090/admin - instance: - prefer-ip: true # 娉ㄥ唽瀹炰緥鏃讹紝浼樺厛浣跨敤 IP - username: ruoyi - password: 123456 diff --git a/ruoyi-admin/src/main/resources/application-prod.yml b/ruoyi-admin/src/main/resources/application-prod.yml index 13a2da8..b66db3e 100644 --- a/ruoyi-admin/src/main/resources/application-prod.yml +++ b/ruoyi-admin/src/main/resources/application-prod.yml @@ -1,4 +1,41 @@ -# 鏁版嵁婧愰厤缃� +--- # 鐩戞帶閰嶇疆 +spring: + boot: + admin: + # Spring Boot Admin Client 瀹㈡埛绔殑鐩稿叧閰嶇疆 + client: + # 澧炲姞瀹㈡埛绔紑鍏� + enabled: true + # 璁剧疆 Spring Boot Admin Server 鍦板潃 + url: http://172.30.0.90:9090/admin + instance: + prefer-ip: true # 娉ㄥ唽瀹炰緥鏃讹紝浼樺厛浣跨敤 IP + username: ruoyi + password: 123456 + +--- # xxl-job 閰嶇疆 +xxl: + job: + # 璋冨害涓績鍦板潃锛氬璋冨害涓績闆嗙兢閮ㄧ讲瀛樺湪澶氫釜鍦板潃鍒欑敤閫楀彿鍒嗛殧銆� + admin-addresses: http://172.30.0.92:9100/xxl-job-admin + # 鎵ц鍣ㄩ�氳TOKEN锛氶潪绌烘椂鍚敤 + access-token: xxl-job + # 鎵ц鍣ㄩ厤缃� + executor: + # 鎵ц鍣ˋppName锛氭墽琛屽櫒蹇冭烦娉ㄥ唽鍒嗙粍渚濇嵁锛涗负绌哄垯鍏抽棴鑷姩娉ㄥ唽 + appname: xxl-job-executor + # 鎵ц鍣ㄧ鍙e彿 鎵ц鍣ㄤ粠9101寮�濮嬪線鍚庡啓 + port: 9101 + # 鎵ц鍣ㄦ敞鍐岋細榛樿IP:PORT + address: + # 鎵ц鍣↖P锛氶粯璁よ嚜鍔ㄨ幏鍙朓P + ip: + # 鎵ц鍣ㄨ繍琛屾棩蹇楁枃浠跺瓨鍌ㄧ鐩樿矾寰� + logpath: ./logs/xxl-job + # 鎵ц鍣ㄦ棩蹇楁枃浠朵繚瀛樺ぉ鏁帮細澶т簬3鐢熸晥 + logretentiondays: 30 + +--- # 鏁版嵁婧愰厤缃� spring: datasource: type: com.alibaba.druid.pool.DruidDataSource @@ -178,18 +215,3 @@ # readMode: "SLAVE" # # 璁㈤槄妯″紡 # subscriptionMode: "MASTER" - ---- # 鐩戞帶閰嶇疆 -spring: - boot: - admin: - # Spring Boot Admin Client 瀹㈡埛绔殑鐩稿叧閰嶇疆 - client: - # 澧炲姞瀹㈡埛绔紑鍏� - enabled: true - # 璁剧疆 Spring Boot Admin Server 鍦板潃 - url: http://172.30.0.90:9090/admin - instance: - prefer-ip: true # 娉ㄥ唽瀹炰緥鏃讹紝浼樺厛浣跨敤 IP - username: ruoyi - password: 123456 diff --git a/ruoyi-extend/ruoyi-xxl-job-admin/pom.xml b/ruoyi-extend/ruoyi-xxl-job-admin/pom.xml index f71190d..fe00af9 100644 --- a/ruoyi-extend/ruoyi-xxl-job-admin/pom.xml +++ b/ruoyi-extend/ruoyi-xxl-job-admin/pom.xml @@ -75,7 +75,6 @@ <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> - <version>${xxl-job-core-version}</version> </dependency> </dependencies> diff --git a/ruoyi-job/pom.xml b/ruoyi-job/pom.xml new file mode 100644 index 0000000..05a297f --- /dev/null +++ b/ruoyi-job/pom.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <parent> + <artifactId>ruoyi-vue-plus</artifactId> + <groupId>com.ruoyi</groupId> + <version>3.2.0</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <packaging>jar</packaging> + <artifactId>ruoyi-job</artifactId> + + <description> + 浠诲姟璋冨害 + </description> + + <dependencies> + + <!-- 閫氱敤宸ュ叿--> + <dependency> + <groupId>com.ruoyi</groupId> + <artifactId>ruoyi-common</artifactId> + </dependency> + + <!-- xxl-job-core --> + <dependency> + <groupId>com.xuxueli</groupId> + <artifactId>xxl-job-core</artifactId> + </dependency> + + <dependency> + <groupId>com.yomahub</groupId> + <artifactId>tlog-xxl-job</artifactId> + </dependency> + + </dependencies> + +</project> diff --git a/ruoyi-job/src/main/java/com/ruoyi/job/config/XxlJobConfig.java b/ruoyi-job/src/main/java/com/ruoyi/job/config/XxlJobConfig.java new file mode 100644 index 0000000..a4e7060 --- /dev/null +++ b/ruoyi-job/src/main/java/com/ruoyi/job/config/XxlJobConfig.java @@ -0,0 +1,44 @@ +package com.ruoyi.job.config; + +import com.ruoyi.job.config.properties.XxlJobProperties; +import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; +import com.yomahub.tlog.springboot.lifecircle.TLogXxljobEnhanceInit; +import lombok.AllArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; + +/** + * xxl-job config + * + * @author Lion Li + */ +@Slf4j +@EnableConfigurationProperties(XxlJobProperties.class) +@AllArgsConstructor +public class XxlJobConfig { + + private final XxlJobProperties xxlJobProperties; + + @Bean + public XxlJobSpringExecutor xxlJobExecutor() { + log.info(">>>>>>>>>>> xxl-job config init."); + XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); + xxlJobSpringExecutor.setAdminAddresses(xxlJobProperties.getAdminAddresses()); + xxlJobSpringExecutor.setAccessToken(xxlJobProperties.getAccessToken()); + XxlJobProperties.Executor executor = xxlJobProperties.getExecutor(); + xxlJobSpringExecutor.setAppname(executor.getAppname()); + xxlJobSpringExecutor.setAddress(executor.getAddress()); + xxlJobSpringExecutor.setIp(executor.getIp()); + xxlJobSpringExecutor.setPort(executor.getPort()); + xxlJobSpringExecutor.setLogPath(executor.getLogPath()); + xxlJobSpringExecutor.setLogRetentionDays(executor.getLogRetentionDays()); + return xxlJobSpringExecutor; + } + + @Bean + public TLogXxljobEnhanceInit tLogXxljobEnhanceInit(){ + return new TLogXxljobEnhanceInit(); + } + +} \ No newline at end of file diff --git a/ruoyi-job/src/main/java/com/ruoyi/job/config/properties/XxlJobProperties.java b/ruoyi-job/src/main/java/com/ruoyi/job/config/properties/XxlJobProperties.java new file mode 100644 index 0000000..d7b8dbe --- /dev/null +++ b/ruoyi-job/src/main/java/com/ruoyi/job/config/properties/XxlJobProperties.java @@ -0,0 +1,38 @@ +package com.ruoyi.job.config.properties; + +import lombok.Data; +import lombok.NoArgsConstructor; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * xxljob閰嶇疆绫� + * + * @author Lion Li + */ +@Data +@ConfigurationProperties(prefix = "xxl.job") +public class XxlJobProperties { + + private String adminAddresses; + + private String accessToken; + + private Executor executor; + + @Data + @NoArgsConstructor + public static class Executor { + + private String appname; + + private String address; + + private String ip; + + private int port; + + private String logPath; + + private int logRetentionDays; + } +} diff --git a/ruoyi-job/src/main/java/com/ruoyi/job/service/SampleService.java b/ruoyi-job/src/main/java/com/ruoyi/job/service/SampleService.java new file mode 100644 index 0000000..20afa2e --- /dev/null +++ b/ruoyi-job/src/main/java/com/ruoyi/job/service/SampleService.java @@ -0,0 +1,254 @@ +package com.ruoyi.job.service; + +import com.xxl.job.core.context.XxlJobHelper; +import com.xxl.job.core.handler.annotation.XxlJob; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Service; + +import java.io.BufferedInputStream; +import java.io.BufferedReader; +import java.io.DataOutputStream; +import java.io.InputStreamReader; +import java.net.HttpURLConnection; +import java.net.URL; +import java.util.Arrays; +import java.util.concurrent.TimeUnit; + +/** + * XxlJob寮�鍙戠ず渚嬶紙Bean妯″紡锛� + * <p> + * 寮�鍙戞楠わ細 + * 1銆佷换鍔″紑鍙戯細鍦⊿pring Bean瀹炰緥涓紝寮�鍙慗ob鏂规硶锛� + * 2銆佹敞瑙i厤缃細涓篔ob鏂规硶娣诲姞娉ㄨВ "@XxlJob(value="鑷畾涔塲obhandler鍚嶇О", init = "JobHandler鍒濆鍖栨柟娉�", destroy = "JobHandler閿�姣佹柟娉�")"锛屾敞瑙alue鍊煎搴旂殑鏄皟搴︿腑蹇冩柊寤轰换鍔$殑JobHandler灞炴�х殑鍊笺�� + * 3銆佹墽琛屾棩蹇楋細闇�瑕侀�氳繃 "XxlJobHelper.log" 鎵撳嵃鎵ц鏃ュ織锛� + * 4銆佷换鍔$粨鏋滐細榛樿浠诲姟缁撴灉涓� "鎴愬姛" 鐘舵�侊紝涓嶉渶瑕佷富鍔ㄨ缃紱濡傛湁璇夋眰锛屾瘮濡傝缃换鍔$粨鏋滀负澶辫触锛屽彲浠ラ�氳繃 "XxlJobHelper.handleFail/handleSuccess" 鑷富璁剧疆浠诲姟缁撴灉锛� + * + * @author xuxueli 2019-12-11 21:52:51 + */ +@Slf4j +@Service +public class SampleService { + + + /** + * 1銆佺畝鍗曚换鍔$ず渚嬶紙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銆佸垎鐗囧箍鎾换鍔� + */ + @XxlJob("shardingJobHandler") + public void shardingJobHandler() throws Exception { + + // 鍒嗙墖鍙傛暟 + int shardIndex = XxlJobHelper.getShardIndex(); + int shardTotal = XxlJobHelper.getShardTotal(); + + XxlJobHelper.log("鍒嗙墖鍙傛暟锛氬綋鍓嶅垎鐗囧簭鍙� = {}, 鎬诲垎鐗囨暟 = {}", shardIndex, shardTotal); + + // 涓氬姟閫昏緫 + for (int i = 0; i < shardTotal; i++) { + if (i == shardIndex) { + XxlJobHelper.log("绗� {} 鐗�, 鍛戒腑鍒嗙墖寮�濮嬪鐞�", i); + } else { + XxlJobHelper.log("绗� {} 鐗�, 蹇界暐", i); + } + } + + } + + + /** + * 3銆佸懡浠よ浠诲姟 + */ + @XxlJob("commandJobHandler") + public void commandJobHandler() throws Exception { + String command = XxlJobHelper.getJobParam(); + int exitValue = -1; + + BufferedReader bufferedReader = null; + try { + // command process + ProcessBuilder 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 log + String line; + while ((line = bufferedReader.readLine()) != null) { + XxlJobHelper.log(line); + } + + // command exit + process.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浠诲姟 + * 鍙傛暟绀轰緥锛� + * "url: http://www.baidu.com\n" + + * "method: get\n" + + * "data: content\n"; + */ + @XxlJob("httpJobHandler") + public void httpJobHandler() throws Exception { + + // param parse + String 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 valid + if (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"); + + // request + HttpURLConnection connection = null; + BufferedReader bufferedReader = null; + try { + // connection + URL realUrl = new URL(url); + connection = (HttpURLConnection) realUrl.openConnection(); + + // connection setting + connection.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 connection + connection.connect(); + + // data + if (isPostMethod && data != null && data.trim().length() > 0) { + DataOutputStream dataOutputStream = new DataOutputStream(connection.getOutputStream()); + dataOutputStream.write(data.getBytes("UTF-8")); + dataOutputStream.flush(); + dataOutputStream.close(); + } + + // valid StatusCode + int statusCode = connection.getResponseCode(); + if (statusCode != 200) { + throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid."); + } + + // result + bufferedReader = 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銆佺敓鍛藉懆鏈熶换鍔$ず渚嬶細浠诲姟鍒濆鍖栦笌閿�姣佹椂锛屾敮鎸佽嚜瀹氫箟鐩稿叧閫昏緫锛� + */ + @XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy") + public void demoJobHandler2() throws Exception { + XxlJobHelper.log("XXL-JOB, Hello World."); + } + + public void init() { + log.info("init"); + } + + public void destroy() { + log.info("destory"); + } + + +} -- Gitblit v1.9.3