SpringBoot+XXL-JOB

1. XXL-JOB搭建

   任务调度中心xxl-job-admin可以集成到SpringBoot项目子模块，也可以独立于SpringBoot项目之外单独运行。

2. pom.xml

   <!-- https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core -->
   <dependency>
       <groupId>com.xuxueli</groupId>
       <artifactId>xxl-job-core</artifactId>
       <version>2.3.1</version>
   </dependency>

3. application.yml

   server:
     port: 8888
     servlet:
       context-path: /my-xxl-job
   
   --- # xxl-job 配置
   xxl.job:
     # 执行器开关
     enabled: true
     # 调度中心地址：如调度中心集群部署存在多个地址则用逗号分隔。
     admin-addresses: http://127.0.0.1:8686/AAAAAA
     # 执行器通讯TOKEN：非空时启用 同xxl-job-admin保持一致
     access-token: CCCCCC
     executor:
       # 执行器AppName：执行器心跳注册分组依据；为空则关闭自动注册
       appname: mmmmmm
       # 执行器端口号 执行器从9101开始往后写
       port: 8787
       # 执行器注册：默认IP:PORT
       address:
       # 执行器IP：默认自动获取IP
       ip:
       # 执行器运行日志文件存储磁盘路径
       logpath: ./logs/xxl-job
       # 执行器日志文件保存天数：大于3生效
       logretentiondays: 30

4. 属性类

   @Data
   @ConfigurationProperties(prefix = "xxl.job")
   public class XxlJobProperties {
   
       private Boolean enabled;
   
       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;
       }
   
   }

5. 配置类

   @Slf4j
   @Configuration
   @EnableConfigurationProperties(XxlJobProperties.class)
   @AllArgsConstructor
   @ConditionalOnProperty(prefix = "xxl.job", name = "enabled", havingValue = "true")
   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;
       }
   
   }

6. 任务类

   /**
    * 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
    */
   @Component
   public class SampleXxlJob {
       private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
   
   
       /**
        * 1、简单任务示例（Bean模式）
        */
       @XxlJob("BBBBBB")
       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("destroy");
       }
   
   
   }

7. 项目结构
   
8. 定时任务

   登陆任务调度中心xxl-job-admin，根据SpringBoot项目application.yml中配置xxl.job.executor.appname将mmmmmm添加到执行器中，自动注册不需要填写机器地址。
   -------------------------------------------------------------------------------------------------
   AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
   名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
   排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
   注册方式：调度中心获取执行器地址的方式；
       自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
       手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
   机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；

   

   向执行器mmmmmm中添加定时任务BBBBBB，运行模式为BEAN，JobHandler对应SampleXxlJob类中的注解@XxlJob("BBBBBB")。

   

   启动任务，SampleXxlJob类中的注解@XxlJob("BBBBBB")标注的方法demoJobHandler()，根据Cron表达式定时执行。

   

   任务启动后，SampleXxlJob类中的注解@XxlJob("BBBBBB")标注的方法demoJobHandler()，方法中打印的信息可在调度日志中查看。

   
   

   任务启动一定时间后，可通过运行报表查看任务的执行情况，主要对成功、失败、进行中的任务做统计。

   
9. 特性描述

   1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；
   2、动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效；
   3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”自研调度组件并支持集群部署，可保证调度中心HA；
   4、执行器HA（分布式）：任务分布式执行，任务”执行器”支持集群部署，可保证任务执行HA；
   5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；
   6、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；
   7、触发策略：提供丰富的任务触发策略，包括：Cron触发、固定间隔触发、固定延时触发、API（事件）触发、人工触发、父子任务触发；
   8、调度过期策略：调度中心错过调度时间的补偿处理策略，包括：忽略、立即补偿触发一次等；
   9、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；
   10、任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务；
   11、任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试；
   12、任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式；
   13、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；
   14、分片广播任务：执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；
   15、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
   16、故障转移：任务路由策略选择”故障转移”情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。
   17、任务进度监控：支持实时监控任务进度；
   18、Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；
   19、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。
   20、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
   21、命令行任务：原生提供通用命令行任务Handler（Bean任务，”CommandJobHandler”）；业务方只需要提供命令行即可；
   22、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；
   23、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；
   24、自定义任务参数：支持在线配置调度任务入参，即时生效；
   25、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；
   26、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；
   27、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；
   28、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
   29、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；
   30、全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行；
   31、跨语言：调度中心与执行器提供语言无关的 RESTful API 服务，第三方任意语言可据此对接调度中心或者实现执行器。除此之外，还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案；
   32、国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文；
   33、容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用；
   34、线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入”Slow”线程池，避免耗尽调度线程，提高系统稳定性；
   35、用户管理：支持在线管理系统用户，存在管理员、普通用户两种角色；
   36、权限控制：执行器维度进行权限控制，管理员拥有全量权限，普通用户需要分配执行器权限后才允许相关操作；

10. 调度数据库

    XXL-JOB调度模块基于自研调度组件并支持集群部署，调度数据库表说明如下：
    - xxl_job_lock：任务调度锁表；
    - xxl_job_group：执行器信息表，维护任务执行器信息；
    - xxl_job_info：调度扩展信息表： 用于保存XXL-JOB调度任务的扩展信息，如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等；
    - xxl_job_log：调度日志表： 用于保存XXL-JOB任务调度的历史信息，如调度结果、执行结果、调度入参、调度机器和执行器等等；
    - xxl_job_log_report：调度日志报表：用户存储XXL-JOB任务调度日志的报表，调度中心报表功能页面会用到；
    - xxl_job_logglue：任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能；
    - xxl_job_registry：执行器注册表，维护在线的执行器和调度中心机器地址信息；
    - xxl_job_user：系统用户表；