添加 solon 的集成适配

pom.xml

@@ -30,6 +30,8 @@
 		<spring.version>5.3.3</spring.version>
 		<spring-boot.version>2.4.2</spring-boot.version>
 
+		<solon.version>1.4.3</solon.version>
+
 		<mybatis-spring-boot-starter.version>2.1.4</mybatis-spring-boot-starter.version>
 		<mysql-connector-java.version>8.0.23</mysql-connector-java.version>
 

xxl-job-core/pom.xml

@@ -43,6 +43,14 @@
 			<scope>provided</scope>
 		</dependency>
 
+		<!-- solon -->
+		<dependency>
+			<groupId>org.noear</groupId>
+			<artifactId>solon</artifactId>
+			<version>${solon.version}</version>
+			<scope>provided</scope>
+		</dependency>
+
 		<!-- ********************** base ********************** -->
 		<!-- slf4j -->
 		<dependency>

xxl-job-core/src/main/java/com/xxl/job/core/executor/impl/XxlJobSolonExecutor.java

@@ -0,0 +1,87 @@
+package com.xxl.job.core.executor.impl;
+
+import com.xxl.job.core.executor.XxlJobExecutor;
+import com.xxl.job.core.glue.GlueFactory;
+import com.xxl.job.core.handler.annotation.XxlJob;
+import com.xxl.job.core.handler.impl.MethodJobHandler;
+import org.noear.solon.SolonApp;
+import org.noear.solon.core.Aop;
+import org.noear.solon.core.BeanExtractor;
+import org.noear.solon.core.BeanWrap;
+import org.noear.solon.core.Plugin;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.lang.reflect.Method;
+
+/**
+ * xxl-job executor (for solon)
+ *
+ * @author noear 2021/5/22 created
+ */
+public class XxlJobSolonExecutor extends XxlJobExecutor implements Plugin, BeanExtractor<XxlJob> {
+    private static final Logger logger = LoggerFactory.getLogger(XxlJobSolonExecutor.class);
+
+
+    @Override
+    public void start(SolonApp app) {
+        // init JobHandler Repository (for method)
+        Aop.context().beanExtractorAdd(XxlJob.class, this);
+
+        // refresh GlueFactory
+        GlueFactory.refreshInstance(2);
+
+        // super start
+        try {
+            super.start();
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    // destroy
+    @Override
+    public void destroy() {
+        super.destroy();
+    }
+
+
+    @Override
+    public void doExtract(BeanWrap wrap, Method method, XxlJob anno) {
+        String name = anno.value();
+
+        if (name.trim().length() == 0) {
+            throw new RuntimeException("xxl-job method-jobhandler name invalid, for[" + wrap.clz() + "#" + method.getName() + "] .");
+        }
+        if (loadJobHandler(name) != null) {
+            throw new RuntimeException("xxl-job jobhandler[" + name + "] naming conflicts.");
+        }
+
+
+        method.setAccessible(true);
+
+        // init and destory
+        Method initMethod = null;
+        Method destroyMethod = null;
+
+        if (anno.init().trim().length() > 0) {
+            try {
+                initMethod = wrap.clz().getDeclaredMethod(anno.init());
+                initMethod.setAccessible(true);
+            } catch (NoSuchMethodException e) {
+                throw new RuntimeException("xxl-job method-jobhandler initMethod invalid, for[" + wrap.clz() + "#" + method.getName() + "] .");
+            }
+        }
+        if (anno.destroy().trim().length() > 0) {
+            try {
+                destroyMethod = wrap.clz().getDeclaredMethod(anno.destroy());
+                destroyMethod.setAccessible(true);
+            } catch (NoSuchMethodException e) {
+                throw new RuntimeException("xxl-job method-jobhandler destroyMethod invalid, for[" + wrap.clz() + "#" + method.getName() + "] .");
+            }
+        }
+
+        // registry jobhandler
+        registJobHandler(name, new MethodJobHandler(wrap.raw(), method, initMethod, destroyMethod));
+    }
+}

xxl-job-core/src/main/java/com/xxl/job/core/glue/GlueFactory.java

@@ -1,5 +1,6 @@
 package com.xxl.job.core.glue;
 
+import com.xxl.job.core.glue.impl.SolonGlueFactory;
 import com.xxl.job.core.glue.impl.SpringGlueFactory;
 import com.xxl.job.core.handler.IJobHandler;
 import groovy.lang.GroovyClassLoader;
@@ -16,7 +17,6 @@ import java.util.concurrent.ConcurrentMap;
  */
 public class GlueFactory {
 
-
 	private static GlueFactory glueFactory = new GlueFactory();
 	public static GlueFactory getInstance(){
 		return glueFactory;
@@ -26,6 +26,8 @@ public class GlueFactory {
 			glueFactory = new GlueFactory();
 		} else if (type == 1) {
 			glueFactory = new SpringGlueFactory();
+		} else if (type == 2) {
+			glueFactory = new SolonGlueFactory();
 		}
 	}
 

xxl-job-core/src/main/java/com/xxl/job/core/glue/impl/SolonGlueFactory.java

@@ -0,0 +1,32 @@
+package com.xxl.job.core.glue.impl;
+
+import com.xxl.job.core.glue.GlueFactory;
+import org.noear.solon.Solon;
+import org.noear.solon.core.Aop;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * @author noear 2021/5/22 created
+ */
+public class SolonGlueFactory extends GlueFactory {
+    private static Logger logger = LoggerFactory.getLogger(SolonGlueFactory.class);
+
+
+    /**
+     * inject action of solon
+     * @param instance
+     */
+    @Override
+    public void injectService(Object instance){
+        if (instance==null) {
+            return;
+        }
+
+        if (Solon.global() == null) {
+            return;
+        }
+
+        Aop.inject(instance);
+    }
+}

xxl-job-executor-samples/pom.xml

@@ -13,6 +13,7 @@
     <modules>
         <module>xxl-job-executor-sample-frameless</module>
         <module>xxl-job-executor-sample-springboot</module>
+        <module>xxl-job-executor-sample-solon</module>
     </modules>
 
 </project>

xxl-job-executor-samples/xxl-job-executor-sample-solon/pom.xml

@@ -0,0 +1,103 @@
+<?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">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.xuxueli</groupId>
+        <artifactId>xxl-job-executor-samples</artifactId>
+        <version>2.3.0</version>
+    </parent>
+    <artifactId>xxl-job-executor-sample-solon</artifactId>
+    <packaging>jar</packaging>
+
+    <name>${project.artifactId}</name>
+    <description>Example executor project for spring boot.</description>
+    <url>https://www.xuxueli.com/</url>
+
+    <properties>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <!-- Import dependency management from Spring Boot (依赖管理：继承一些默认的依赖，工程需要依赖的jar包的管理，申明其他dependency的时候就不需要version) -->
+                <groupId>org.noear</groupId>
+                <artifactId>solon-parent</artifactId>
+                <version>${solon.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <!-- spring-boot-starter-web (spring-webmvc + tomcat) -->
+        <dependency>
+            <groupId>org.noear</groupId>
+            <artifactId>solon-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>1.2.3</version>
+        </dependency>
+
+        <!-- xxl-job-core -->
+        <dependency>
+            <groupId>com.xuxueli</groupId>
+            <artifactId>xxl-job-core</artifactId>
+            <version>${project.parent.version}</version>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <finalName>${project.artifactId}</finalName>
+
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.7.0</version>
+                <configuration>
+                    <compilerArgument>-parameters</compilerArgument>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                    <encoding>UTF-8</encoding>
+                </configuration>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>3.3.0</version>
+                <configuration>
+                    <finalName>${project.artifactId}</finalName>
+                    <appendAssemblyId>false</appendAssemblyId>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                    <archive>
+                        <manifest>
+                            <mainClass>com.xxl.job.executor.XxlJobExecutorApp</mainClass>
+                        </manifest>
+                    </archive>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+
+    </build>
+
+
+</project>

xxl-job-executor-samples/xxl-job-executor-sample-solon/src/main/java/com/xxl/job/executor/XxlJobExecutorApp.java

@@ -0,0 +1,13 @@
+package com.xxl.job.executor;
+
+import org.noear.solon.Solon;
+
+/**
+ * @author xuxueli 2018-10-28 00:38:13
+ * @author noear 2021/5/22 created
+ */
+public class XxlJobExecutorApp {
+	public static void main(String[] args) {
+        Solon.start(XxlJobExecutorApp.class, args);
+	}
+}

xxl-job-executor-samples/xxl-job-executor-sample-solon/src/main/java/com/xxl/job/executor/config/XxlJobConfig.java

@@ -0,0 +1,63 @@
+package com.xxl.job.executor.config;
+
+import com.xxl.job.core.executor.impl.XxlJobSolonExecutor;
+import org.noear.solon.annotation.Bean;
+import org.noear.solon.annotation.Configuration;
+import org.noear.solon.annotation.Inject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * xxl-job config
+ *
+ * @author xuxueli 2017-04-28
+ * @author noear 2021/5/22 created
+ */
+@Configuration
+public class XxlJobConfig {
+    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
+
+    @Inject("${xxl.job.admin.addresses}")
+    private String adminAddresses;
+
+    @Inject("${xxl.job.accessToken}")
+    private String accessToken;
+
+    @Inject("${xxl.job.executor.appname}")
+    private String appname;
+
+    @Inject("${xxl.job.executor.address}")
+    private String address;
+
+    @Inject("${xxl.job.executor.ip}")
+    private String ip;
+
+    @Inject("${xxl.job.executor.port}")
+    private int port;
+
+    @Inject("${xxl.job.executor.logpath}")
+    private String logPath;
+
+    @Inject("${xxl.job.executor.logretentiondays}")
+    private int logRetentionDays;
+
+
+    @Bean
+    public XxlJobSolonExecutor xxlJobExecutor() {
+        logger.info(">>>>>>>>>>> xxl-job config init.");
+
+        XxlJobSolonExecutor executor = new XxlJobSolonExecutor();
+
+        executor.setAdminAddresses(adminAddresses);
+        executor.setAppname(appname);
+        executor.setAddress(address);
+        executor.setIp(ip);
+        executor.setPort(port);
+        executor.setAccessToken(accessToken);
+        executor.setLogPath(logPath);
+        executor.setLogRetentionDays(logRetentionDays);
+
+        return executor;
+    }
+
+}

xxl-job-executor-samples/xxl-job-executor-sample-solon/src/main/java/com/xxl/job/executor/controller/IndexController.java

@@ -0,0 +1,14 @@
+package com.xxl.job.executor.controller;//package com.xxl.job.executor.mvc.controller;
+
+//import org.noear.solon.annotation.Controller;
+//import org.noear.solon.annotation.Mapping;
+//
+//@Controller
+//public class IndexController {
+//
+//    @Mapping("/")
+//    public String index() {
+//        return "xxl job executor running.";
+//    }
+//
+//}

xxl-job-executor-samples/xxl-job-executor-sample-solon/src/main/java/com/xxl/job/executor/jobhandler/SampleXxlJob.java

@@ -0,0 +1,254 @@
+package com.xxl.job.executor.jobhandler;
+
+import com.xxl.job.core.context.XxlJobHelper;
+import com.xxl.job.core.handler.annotation.XxlJob;
+import org.noear.solon.annotation.Component;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+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模式）
+ *
+ * 开发步骤：
+ *      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
+ * @author noear 2021/5/22 created
+ */
+@Component
+public class SampleXxlJob {
+    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
+
+
+    /**
+     * 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(){
+        logger.info("init");
+    }
+    public void destroy(){
+        logger.info("destory");
+    }
+
+
+}

xxl-job-executor-samples/xxl-job-executor-sample-solon/src/main/resources/application.properties

@@ -0,0 +1,21 @@
+# web port
+server.port=8081
+
+
+### 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=
+
+### 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=30

xxl-job-executor-samples/xxl-job-executor-sample-solon/src/main/resources/logback.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration debug="false" scan="true" scanPeriod="1 seconds">
+
+    <contextName>logback</contextName>
+    <property name="log.path" value="/data/applogs/xxl-job/xxl-job-executor-sample-solon.log"/>
+
+    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </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>