• 分布式任务调度平台 xxl-job 搭建


      1.简介               

            XXL-JOB是一个分布式任务调度平台,它有两个核心模块,一个调度中心,另外一个为执行器,它把任务调度和任务执行分成两个部分。这样调度只需要负责任务的调度属性,触发调度信号。执行模块只需要接收调度信号,去执行具体的业务逻辑,两者可以各自的进行扩容和缩容。

    架构图:

    2. 搭建

     因为是开源项目,所以我们直接去github下载源码,我选择的是release版本 

     源码地址:github.com/xuxueli/xxl-job

    下载下来后的代码结构: 

     

     可以看到 xxl-job-master 为 父工程

                    xxl-job-admin  为 调度中心

                    xxl-job-core     为 基础配置,为调度中心提供支持 

                    xxl-job-executor-samples   为  不同版本的执行器  本文使用springboot执行器

    构建数据库表:

    代码build后,先去数据库把db做好,官网代码里提供了相应sql,直接执行

     修改调度中心db配置:

     然后调度中心可以直接启动了,端口初始是8080,为了防止占用,建议改成别的

    访问url: localhost:8080/xxl-job-admin

     

     搭建执行器:

            这里我们用开源代码给的demo做,后边整合到外部的springboot服务,父工程内的执行器moudle代码结构,分为三部分:job配置中心,暴露的调度接口和要执行的逻辑接口

     1.xxl-job配置

    1. xxl:
    2. job:
    3. accessToken: default_token
    4. admin:
    5. addresses: 'http://127.0.0.1:8080/xxl-job-admin '
    6. executor:
    7. address: ''
    8. appname: xxl-job-executor-meeting
    9. ip: 127.0.0.1
    10. logpath: /data/applogs/xxl-job/jobhandler
    11. logretentiondays: 30
    12. port: 9999

     2.xxl-job配置类

    1. /**
    2. * xxl-job config
    3. *
    4. * @author xuxueli 2017-04-28
    5. */
    6. @Configuration
    7. public class XxlJobConfig {
    8. private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
    9. @Value("${xxl.job.admin.addresses}")
    10. private String adminAddresses;
    11. @Value("${xxl.job.accessToken}")
    12. private String accessToken;
    13. @Value("${xxl.job.executor.appname}")
    14. private String appname;
    15. @Value("${xxl.job.executor.address}")
    16. private String address;
    17. @Value("${xxl.job.executor.ip}")
    18. private String ip;
    19. @Value("${xxl.job.executor.port}")
    20. private int port;
    21. @Value("${xxl.job.executor.logpath}")
    22. private String logPath;
    23. @Value("${xxl.job.executor.logretentiondays}")
    24. private int logRetentionDays;
    25. @Bean
    26. public XxlJobSpringExecutor xxlJobExecutor() {
    27. logger.info(">>>>>>>>>>> xxl-job config init.");
    28. XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
    29. xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
    30. xxlJobSpringExecutor.setAppname(appname);
    31. xxlJobSpringExecutor.setAddress(address);
    32. xxlJobSpringExecutor.setIp(ip);
    33. xxlJobSpringExecutor.setPort(port);
    34. xxlJobSpringExecutor.setAccessToken(accessToken);
    35. xxlJobSpringExecutor.setLogPath(logPath);
    36. xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
    37. return xxlJobSpringExecutor;
    38. }
    39. /**
    40. * 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
    41. *
    42. * 1、引入依赖:
    43. *
    44. * org.springframework.cloud
    45. * spring-cloud-commons
    46. * ${version}
    47. *
    48. *
    49. * 2、配置文件,或者容器启动变量
    50. * spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
    51. *
    52. * 3、获取IP
    53. * String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
    54. */
    55. }

    3.定时任务

    1. /**
    2. * XxlJob开发示例(Bean模式)
    3. *
    4. * 开发步骤:
    5. * 1、任务开发:在Spring Bean实例中,开发Job方法;
    6. * 2、注解配置:为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
    7. * 3、执行日志:需要通过 "XxlJobHelper.log" 打印执行日志;
    8. * 4、任务结果:默认任务结果为 "成功" 状态,不需要主动设置;如有诉求,比如设置任务结果为失败,可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果;
    9. *
    10. * @author xuxueli 2019-12-11 21:52:51
    11. */
    12. @Component
    13. public class SampleXxlJob {
    14. private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
    15. /**
    16. * 1、简单任务示例(Bean模式)
    17. */
    18. @XxlJob("demoJobHandler")
    19. public void demoJobHandler() throws Exception {
    20. XxlJobHelper.log("XXL-JOB, Hello World.");
    21. for (int i = 0; i < 5; i++) {
    22. XxlJobHelper.log("beat at:" + i);
    23. TimeUnit.SECONDS.sleep(2);
    24. }
    25. // default success
    26. }
    27. /**
    28. * 2、分片广播任务
    29. */
    30. @XxlJob("shardingJobHandler")
    31. public void shardingJobHandler() throws Exception {
    32. // 分片参数
    33. int shardIndex = XxlJobHelper.getShardIndex();
    34. int shardTotal = XxlJobHelper.getShardTotal();
    35. XxlJobHelper.log("分片参数:当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);
    36. // 业务逻辑
    37. for (int i = 0; i < shardTotal; i++) {
    38. if (i == shardIndex) {
    39. XxlJobHelper.log("第 {} 片, 命中分片开始处理", i);
    40. } else {
    41. XxlJobHelper.log("第 {} 片, 忽略", i);
    42. }
    43. }
    44. }
    45. /**
    46. * 3、命令行任务
    47. */
    48. @XxlJob("commandJobHandler")
    49. public void commandJobHandler() throws Exception {
    50. String command = XxlJobHelper.getJobParam();
    51. int exitValue = -1;
    52. BufferedReader bufferedReader = null;
    53. try {
    54. // command process
    55. ProcessBuilder processBuilder = new ProcessBuilder();
    56. processBuilder.command(command);
    57. processBuilder.redirectErrorStream(true);
    58. Process process = processBuilder.start();
    59. //Process process = Runtime.getRuntime().exec(command);
    60. BufferedInputStream bufferedInputStream = new BufferedInputStream(process.getInputStream());
    61. bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));
    62. // command log
    63. String line;
    64. while ((line = bufferedReader.readLine()) != null) {
    65. XxlJobHelper.log(line);
    66. }
    67. // command exit
    68. process.waitFor();
    69. exitValue = process.exitValue();
    70. } catch (Exception e) {
    71. XxlJobHelper.log(e);
    72. } finally {
    73. if (bufferedReader != null) {
    74. bufferedReader.close();
    75. }
    76. }
    77. if (exitValue == 0) {
    78. // default success
    79. } else {
    80. XxlJobHelper.handleFail("command exit value("+exitValue+") is failed");
    81. }
    82. }
    83. /**
    84. * 4、跨平台Http任务
    85. * 参数示例:
    86. * "url: http://www.baidu.com\n" +
    87. * "method: get\n" +
    88. * "data: content\n";
    89. */
    90. @XxlJob("httpJobHandler")
    91. public void httpJobHandler() throws Exception {
    92. // param parse
    93. String param = XxlJobHelper.getJobParam();
    94. if (param==null || param.trim().length()==0) {
    95. XxlJobHelper.log("param["+ param +"] invalid.");
    96. XxlJobHelper.handleFail();
    97. return;
    98. }
    99. String[] httpParams = param.split("\n");
    100. String url = null;
    101. String method = null;
    102. String data = null;
    103. for (String httpParam: httpParams) {
    104. if (httpParam.startsWith("url:")) {
    105. url = httpParam.substring(httpParam.indexOf("url:") + 4).trim();
    106. }
    107. if (httpParam.startsWith("method:")) {
    108. method = httpParam.substring(httpParam.indexOf("method:") + 7).trim().toUpperCase();
    109. }
    110. if (httpParam.startsWith("data:")) {
    111. data = httpParam.substring(httpParam.indexOf("data:") + 5).trim();
    112. }
    113. }
    114. // param valid
    115. if (url==null || url.trim().length()==0) {
    116. XxlJobHelper.log("url["+ url +"] invalid.");
    117. XxlJobHelper.handleFail();
    118. return;
    119. }
    120. if (method==null || !Arrays.asList("GET", "POST").contains(method)) {
    121. XxlJobHelper.log("method["+ method +"] invalid.");
    122. XxlJobHelper.handleFail();
    123. return;
    124. }
    125. boolean isPostMethod = method.equals("POST");
    126. // request
    127. HttpURLConnection connection = null;
    128. BufferedReader bufferedReader = null;
    129. try {
    130. // connection
    131. URL realUrl = new URL(url);
    132. connection = (HttpURLConnection) realUrl.openConnection();
    133. // connection setting
    134. connection.setRequestMethod(method);
    135. connection.setDoOutput(isPostMethod);
    136. connection.setDoInput(true);
    137. connection.setUseCaches(false);
    138. connection.setReadTimeout(5 * 1000);
    139. connection.setConnectTimeout(3 * 1000);
    140. connection.setRequestProperty("connection", "Keep-Alive");
    141. connection.setRequestProperty("Content-Type", "application/json;charset=UTF-8");
    142. connection.setRequestProperty("Accept-Charset", "application/json;charset=UTF-8");
    143. // do connection
    144. connection.connect();
    145. // data
    146. if (isPostMethod && data!=null && data.trim().length()>0) {
    147. DataOutputStream dataOutputStream = new DataOutputStream(connection.getOutputStream());
    148. dataOutputStream.write(data.getBytes("UTF-8"));
    149. dataOutputStream.flush();
    150. dataOutputStream.close();
    151. }
    152. // valid StatusCode
    153. int statusCode = connection.getResponseCode();
    154. if (statusCode != 200) {
    155. throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid.");
    156. }
    157. // result
    158. bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));
    159. StringBuilder result = new StringBuilder();
    160. String line;
    161. while ((line = bufferedReader.readLine()) != null) {
    162. result.append(line);
    163. }
    164. String responseMsg = result.toString();
    165. XxlJobHelper.log(responseMsg);
    166. return;
    167. } catch (Exception e) {
    168. XxlJobHelper.log(e);
    169. XxlJobHelper.handleFail();
    170. return;
    171. } finally {
    172. try {
    173. if (bufferedReader != null) {
    174. bufferedReader.close();
    175. }
    176. if (connection != null) {
    177. connection.disconnect();
    178. }
    179. } catch (Exception e2) {
    180. XxlJobHelper.log(e2);
    181. }
    182. }
    183. }
    184. /**
    185. * 5、生命周期任务示例:任务初始化与销毁时,支持自定义相关逻辑;
    186. */
    187. @XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
    188. public void demoJobHandler2() throws Exception {
    189. XxlJobHelper.log("XXL-JOB, Hello World.");
    190. }
    191. public void init(){
    192. logger.info("init");
    193. }
    194. public void destroy(){
    195. logger.info("destroy");
    196. }
    197. }

    启动执行器,服务启动端口8081 ,调度端口默认9999

    3.调度平台配置

            1. 在执行器管理里新建一个执行器,Appname配置执行器yml里映射的appname,如果调度中心和执行器在一个单一机器内,可以使用自动注册,如果是不同机器或者同一机器不同VDC或不同集群内需要手动录入,也就是配置执行器的服务

         2.建完执行器后,创建调度任务,选择上面创建的执行器,配置Corn表达式,这里和定时任务的配置统一

     重点在任务配置里的JobHander需要和执行器里的调度接口的映射匹配

     执行器和调度任务配置好后,就可以测试运行了,可以通过日志查看运行状态

     4.xxl-job整合现有springframe项目

    整合现有项目,只需要将xxl-job的依赖打包到maven里

    1. <dependency>
    2. <groupId>com.xuxueli</groupId>
    3. <artifactId>xxl-job-core</artifactId>
    4. <version>2.0.2</version>
    5. </dependency>

     剩下的调度配置项和调度接口,定时任务和上面一样需要做相同配置

    end

  • 相关阅读:
    【Vue3+Vite+Ts+element-plus】 使用tsx 动态表格封装
    2023最新SSM计算机毕业设计选题大全(附源码+LW)之java招生管理系统2ij21
    猿创征文|UnitySqlite持久化数据
    R--基础知识总结
    vue3.0--1.vue3.0环境集成、setup、ref函数、reactive函数、计算属性(computed)
    安装2023最新版PyCharm来开发Python应用程序
    面试:List View和RecyclerView缓存策略对比
    【C++】初阶模板
    【优化选址】遗传算法求解物流配送中心选址【含Matlab源码 1917期】
    设计模式day13
  • 原文地址:https://blog.csdn.net/Zxiaobinggan/article/details/127801365