init

2026-06-12 16:14:58 +08:00
parent cf71897528
commit a7ba0f21e5
235 changed files with 33574 additions and 0 deletions
@@ -0,0 +1,44 @@
+/**
+ * BladeX Commercial License Agreement
+ * Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
+ * <p>
+ * Use of this software is governed by the Commercial License Agreement
+ * obtained after purchasing a license from BladeX.
+ * <p>
+ * 1. This software is for development use only under a valid license
+ * from BladeX.
+ * <p>
+ * 2. Redistribution of this software's source code to any third party
+ * without a commercial license is strictly prohibited.
+ * <p>
+ * 3. Licensees may copyright their own code but cannot use segments
+ * from this software for such purposes. Copyright of this software
+ * remains with BladeX.
+ * <p>
+ * Using this software signifies agreement to this License, and the software
+ * must not be used for illegal purposes.
+ * <p>
+ * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
+ * not liable for any claims arising from secondary or illegal development.
+ * <p>
+ * Author: Chill Zhuang (bladejava@qq.com)
+ */
+package org.springblade.xxljob;
+
+import org.springblade.common.constant.LauncherConstant;
+import org.springblade.core.cloud.client.BladeCloudApplication;
+import org.springblade.core.launch.BladeApplication;
+
+/**
+ * 启动器
+ *
+ * @author Chill
+ */
+@BladeCloudApplication
+public class XxlJobApplication {
+	public static void main(String[] args) {
+		BladeApplication.run(LauncherConstant.APPLICATION_XXLJOB_NAME, XxlJobApplication.class, args);
+	}
+
+}
+
@@ -0,0 +1,77 @@
+package org.springblade.xxljob.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 config
+ *
+ * @author xuxueli
+ */
+@Slf4j
+@Configuration(proxyBeanMethods = false)
+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;
+	}
+
+	/**
+	 * 针对多网卡、容器内部署等情况，可借助 "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();
+	 */
+
+
+}
@@ -0,0 +1,256 @@
+package org.springblade.xxljob.handler;
+
+import com.xxl.job.core.context.XxlJobHelper;
+import com.xxl.job.core.handler.annotation.XxlJob;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+
+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、任务开发：在Spring Bean实例中，开发Job方法；
+ * 2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
+ * 3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；
+ * 4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；
+ *
+ * @author xuxueli 2019-12-11 21:52:51
+ */
+@Component
+public class SampleXxlJob {
+	private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
+
+
+	/**
+	 * 1、简单任务示例（Bean模式）
+	 */
+	@XxlJob("demoJobHandler")
+	public void demoJobHandler() throws Exception {
+		String param = XxlJobHelper.getJobParam();
+		XxlJobHelper.log("XXL-JOB, Hello World." + param);
+
+		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() {
+		logger.info("init");
+	}
+
+	public void destroy() {
+		logger.info("destroy");
+	}
+
+
+}
@@ -0,0 +1,25 @@
+server:
+  port: 7008
+
+logging:
+  config: classpath:logback.xml
+
+spring:
+  main:
+    allow-circular-references: true
+
+xxl:
+  job:
+    accessToken: default_token
+    admin:
+      addresses: http://127.0.0.1:8080/xxl-job-admin
+    executor:
+      # 执行器名称
+      appname: blade-xxl-job-executor
+      # 若使用docker部署xxl-job-admin并且本地开发机调试连接，需要开启指定ip，采用docker的internal配置
+      # 若生产部署不涉及跨网段，可不配置ip
+      ip: 'http://host.docker.internal'
+      port: 9999
+      logpath: ../data/applogs/xxl-job/jobhandler
+      logretentiondays: -1
+      address: ''
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration scan="false" debug="false">
+
+    <contextName>logback</contextName>
+    <property name="log.path" value="../data/applogs/xxl-job/xxl-job-executor-sample-springboot.log"/>
+
+    <!-- 彩色日志依赖的渲染类 -->
+    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
+    <conversionRule conversionWord="wex"
+                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
+    <conversionRule conversionWord="wEx"
+                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
+    <!-- 彩色日志格式 -->
+    <property name="CONSOLE_LOG_PATTERN"
+              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
+    <!-- 控制台输出 -->
+    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
+            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
+            <charset>utf8</charset>
+        </encoder>
+    </appender>
+
+    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>${log.path}</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern>
+        </rollingPolicy>
+        <encoder>
+            <pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n
+            </pattern>
+        </encoder>
+    </appender>
+
+    <root level="info">
+        <appender-ref ref="console"/>
+        <appender-ref ref="file"/>
+    </root>
+
+</configuration>