✨ 添加新特性。支持 xxl-job

2019-09-18 17:27:10 +08:00
1 parent 984336923a
commit b7b414b3f2
@@ -0,0 +1,52 @@
+/*
+ *    Copyright (c) 2018-2025, lengleng All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * Neither the name of the pig4cloud.com developer nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * Author: lengleng (wangiegie@gmail.com)
+ */
+
+package com.pig4cloud.pigx.common.job;
+
+import com.pig4cloud.pigx.common.job.properties.XxlJobProperties;
+import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author lengleng
+ * @date 2019-09-18
+ * <p>
+ * xxl 初始化
+ */
+@Configuration
+@EnableAutoConfiguration
+@ComponentScan("com.pig4cloud.pigx.common.job.properties")
+@EnableConfigurationProperties(XxlJobAutoConfiguration.class)
+public class XxlJobAutoConfiguration {
+
+	@Bean(initMethod = "start", destroyMethod = "destroy")
+	public XxlJobSpringExecutor xxlJobSpringExecutor(XxlJobProperties xxlJobProperties) {
+		XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
+		xxlJobSpringExecutor.setAdminAddresses(xxlJobProperties.getAdmin().getAddresses());
+		xxlJobSpringExecutor.setAppName(xxlJobProperties.getExecutor().getAppName());
+		xxlJobSpringExecutor.setIp(xxlJobProperties.getExecutor().getIp());
+		xxlJobSpringExecutor.setPort(xxlJobProperties.getExecutor().getPort());
+		xxlJobSpringExecutor.setAccessToken(xxlJobProperties.getExecutor().getAccessToken());
+		xxlJobSpringExecutor.setLogPath(xxlJobProperties.getExecutor().getLogPath());
+		xxlJobSpringExecutor.setLogRetentionDays(xxlJobProperties.getExecutor().getLogRetentionDays());
+		return xxlJobSpringExecutor;
+	}
+}
@@ -0,0 +1,37 @@
+/*
+ *    Copyright (c) 2018-2025, lengleng All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * Neither the name of the pig4cloud.com developer nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * Author: lengleng (wangiegie@gmail.com)
+ */
+
+package com.pig4cloud.pigx.common.job.annotation;
+
+import com.pig4cloud.pigx.common.job.XxlJobAutoConfiguration;
+import org.springframework.context.annotation.Import;
+
+import java.lang.annotation.*;
+
+/**
+ * @author lengleng
+ * @date 2019-09-18
+ * <p>
+ * 开启支持XXL
+ */
+@Target({ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Inherited
+@Import({XxlJobAutoConfiguration.class})
+public @interface EnablePigxXxlJob {
+}
@@ -0,0 +1,35 @@
+/*
+ *    Copyright (c) 2018-2025, lengleng All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * Neither the name of the pig4cloud.com developer nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * Author: lengleng (wangiegie@gmail.com)
+ */
+
+package com.pig4cloud.pigx.common.job.properties;
+
+import lombok.Data;
+
+/**
+ * @author lengleng
+ * @date 2019-09-18
+ * <p>
+ * xxl 管控台相关属性
+ */
+@Data
+public class XxlAdminProperties {
+	/**
+	 * 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。
+	 * 执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
+	 */
+	private String addresses = "http://127.0.0.1:8080/xxl-job-admin";
+}
@@ -0,0 +1,58 @@
+/*
+ *    Copyright (c) 2018-2025, lengleng All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * Neither the name of the pig4cloud.com developer nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * Author: lengleng (wangiegie@gmail.com)
+ */
+
+package com.pig4cloud.pigx.common.job.properties;
+
+import lombok.Data;
+
+/**
+ * @author lengleng
+ * @date 2019-09-18
+ */
+@Data
+public class XxlExecutorProperties {
+	/**
+	 * 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
+	 */
+	private String appName = "xxl-job-executor";
+
+	/**
+	 * 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP
+	 * ，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"
+	 */
+	private String ip;
+
+	/**
+	 * 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
+	 */
+	private Integer port = 9999;
+
+	/**
+	 * 执行器通讯TOKEN [选填]：非空时启用；
+	 */
+	private String accessToken;
+
+	/**
+	 * 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
+	 */
+	private String logPath = "logs/applogs/xxl-job/jobhandler";
+
+	/**
+	 * 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
+	 */
+	private Integer logRetentionDays = 30;
+}
@@ -0,0 +1,35 @@
+/*
+ *    Copyright (c) 2018-2025, lengleng All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * Neither the name of the pig4cloud.com developer nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * Author: lengleng (wangiegie@gmail.com)
+ */
+
+package com.pig4cloud.pigx.common.job.properties;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+/**
+ * @author lengleng
+ * @date 2019-09-18
+ */
+@Data
+@Component
+@ConfigurationProperties(prefix = "xxl.job")
+public class XxlJobProperties {
+	private XxlAdminProperties admin = new XxlAdminProperties();
+
+	private XxlExecutorProperties executor = new XxlExecutorProperties();
+}
@@ -0,0 +1,45 @@
+/*
+ *    Copyright (c) 2018-2025, lengleng All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * Neither the name of the pig4cloud.com developer nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * Author: lengleng (wangiegie@gmail.com)
+ */
+
+package com.pig4cloud.pigx.daemon.elastic.job;
+
+import com.xxl.job.core.biz.model.ReturnT;
+import com.xxl.job.core.handler.IJobHandler;
+import com.xxl.job.core.handler.annotation.JobHandler;
+import com.xxl.job.core.log.XxlJobLogger;
+import com.xxl.job.core.util.ShardingUtil;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+
+/**
+ * @author lengleng
+ * @date 2019-09-18
+ */
+@Slf4j
+@Component
+@JobHandler("demoJobHandler")
+public class DemoJobHandler extends IJobHandler {
+
+	@Override
+	public ReturnT<String> execute(String s) {
+		ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
+
+
+		XxlJobLogger.log("This is a demo job." + shardingVO);
+		return SUCCESS;
+	}
+}