三、任务详解

三、任务详解

配置属性详细说明：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54


1.  ` 基础配置：`
2.   `-  执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器,  实现任务自动发现功能;  另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器,  可在  " 执行器管理 "  进行设置;`
3.   `-  任务描述：任务的描述信息，便于任务管理；`
4.   `-  负责人：任务的负责人；`
5.   `-  报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；`

7.  ` 触发配置：`
8.   `-  调度类型：`
9.   ` 无：该类型不会主动触发调度；`
10.   `CRON：该类型将会通过 CRON，触发任务调度；`
11.   ` 固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；`
12.   ` 固定延迟：该类型将会以固定延迟，触发任务调度；按照固定的延迟时间，从上次调度结束后开始计算延迟时间，到达延迟时间后触发下次调度；`
13.   `- CRON：触发任务执行的 Cron 表达式；`
14.   `-  固定速度：固定速度的时间间隔，单位为秒；`
15.   `-  固定延迟：固定延迟的时间间隔，单位为秒；`

17.  ` 任务配置：`
18.   `-  运行模式：`
19.   `BEAN 模式：任务以 JobHandler 方式维护在执行器端；需要结合  "JobHandler"  属性匹配执行器中任务；`
20.   `GLUE 模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自 IJobHandler 的 Java 类代码并  "groovy"  源码方式维护，它在执行器项目中运行，可使用 @Resource/@Autowire 注入执行器里中的其他服务；`
21.   `GLUE 模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段  "shell"  脚本；`
22.   `GLUE 模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段  "python"  脚本；`
23.   `GLUE 模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段  "php"  脚本；`
24.   `GLUE 模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段  "nodejs"  脚本；`
25.   `GLUE 模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段  "PowerShell"  脚本；`
26.   `-  JobHandler：运行模式为  "BEAN 模式 "  时生效，对应执行器中新开发的 JobHandler 类“@JobHandler”注解自定义的 value 值；`
27.   `-  执行参数：任务执行所需的参数；` 

29.  ` 高级配置：`
30.   `-  路由策略：当执行器集群部署时，提供丰富的路由策略，包括；`
31.   `FIRST（第一个）：固定选择第一个机器；`
32.   `LAST（最后一个）：固定选择最后一个机器；`
33.   `ROUND（轮询）：；`
34.   `RANDOM（随机）：随机选择在线的机器；`
35.   `CONSISTENT_HASH（一致性 HASH）：每个任务按照 Hash 算法固定选择某一台机器，且所有任务均匀散列在不同机器上。`
36.   `LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；`
37.   `LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；`
38.   `FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；`
39.   `BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；`
40.   `SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；`
41.   `-  子任务：每个任务都拥有一个唯一的任务 ID(任务 ID 可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务 ID 所对应的任务的一次主动调度。`
42.   `-  调度过期策略：`
43.   `-  忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；`
44.   `-  立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；`
45.   `-  阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；`
46.   ` 单机串行（默认）：调度请求进入单机执行器后，调度请求进入 FIFO 队列并以串行方式运行；`
47.   ` 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；`
48.   ` 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；`
49.   `-  任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；`
50.   `-  失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；`


3.1 BEAN 模式（类形式）

Bean 模式任务，支持基于类的开发方式，每个任务对应一个 Java 类。

  • 优点：不限制项目环境，兼容性好。即使是无框架项目，如 main 方法直接启动的项目也可以提供支持，可以参考示例项目 “xxl-job-executor-sample-frameless”；
  • 缺点：
    • 每个任务需要占用一个 Java 类，造成类的浪费；
    • 不支持自动扫描任务并注入到执行器容器，需要手动注入。

步骤一：执行器项目中，开发 Job 类：

1
2
3
4
5
6
7
8
9


1.  `1、开发一个继承自 "com.xxl.job.core.handler.IJobHandler" 的 JobHandler 类，实现其中任务方法。`
2.  `2、手动通过如下方式注入到执行器容器。`
3.  ` ``` `
4.  `XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());`
5.  ` ``` `


步骤二：调度中心，新建调度任务

后续步骤和 “3.2 BEAN 模式（方法形式）”一致，可以前往参考。

3.2 BEAN 模式（方法形式）

Bean 模式任务，支持基于方法的开发方式，每个任务对应一个方法。

  • 优点：
    • 每个任务只需要开发一个方法，并添加”@XxlJob”注解即可，更加方便、快速。
    • 支持自动扫描任务并注入到执行器容器。
  • 缺点：略。

基于方法开发的任务，底层会生成 JobHandler 代理，和基于类的方式一样，任务也会以 JobHandler 的形式存在于执行器任务容器中。

步骤一：执行器项目中，开发 Job 方法：

1
2
3
4
5
6
7
8


1.  `1、任务开发：在 Spring  Bean 实例中，开发 Job 方法；`
2.  `2、注解配置：为 Job 方法添加注解  "@XxlJob(value="自定义 jobhandler 名称", init = "JobHandler 初始化方法", destroy = "JobHandler 销毁方法")"，注解 value 值对应的是调度中心新建任务的 JobHandler 属性的值。`
3.  `3、执行日志：需要通过  "XxlJobHelper.log"  打印执行日志；`
4.  `4、任务结果：默认任务结果为  " 成功 "  状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过  "XxlJobHelper.handleFail/handleSuccess"  自主设置任务结果；`


1
2
3
4
5
6
7
8
9


1.  `// 可参考 Sample 示例执行器中的 "com.xxl.job.executor.service.jobhandler.SampleXxlJob" ，如下：`
2.  `@XxlJob("demoJobHandler")`
3.  `public  void demoJobHandler()  throws  Exception  {`
4.   `XxlJobHelper.log("XXL-JOB, Hello World.");`
5.  `}`


步骤二：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “BEAN 模式”，JobHandler 属性填写任务注解“@XxlJob”中定义的值；

原生内置 Bean 模式任务

为方便用户参考与快速实用，示例执行器内原生提供多个 Bean 模式任务 Handler，可以直接配置实用，如下：

  • demoJobHandler：简单示例任务，任务内部模拟耗时任务逻辑，用户可在线体验 Rolling Log 等功能；

  • shardingJobHandler：分片示例任务，任务内部模拟处理分片参数，可参考熟悉分片任务；

  • httpJobHandler：通用 HTTP 任务 Handler；业务方只需要提供 HTTP 链接等信息即可，不限制语言、平台。示例任务入参如下：```

    1. url: http://www.xxx.com
    2. method: get 或 post
    3. data: post-data

  • commandJobHandler：通用命令行任务 Handler；业务方只需要提供命令行即可；如 “pwd”命令；

3.3 GLUE 模式(Java)

任务以源码方式维护在调度中心，支持通过 Web IDE 在线更新，实时编译和生效，因此不需要指定 JobHandler。开发流程如下：

步骤一：调度中心，新建调度任务：

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE 模式(Java)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往 GLUE 任务的 Web IDE 界面，在该界面支持对任务代码进行开发（也可以在 IDE 中开发完成后，复制粘贴到编辑中）。

版本回溯功能（支持 30 个版本的版本回溯）：在 GLUE 任务的 Web IDE 界面，选择右上角下拉框“版本回溯”，会列出该 GLUE 的更新历史，选择相应版本即可显示该版本代码，保存后 GLUE 代码即回退到对应的历史版本；

3.4 GLUE 模式(Shell)

步骤一：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE 模式(Shell)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往 GLUE 任务的 Web IDE 界面，在该界面支持对任务代码进行开发（也可以在 IDE 中开发完成后，复制粘贴到编辑中）。

该模式的任务实际上是一段 “shell” 脚本；

3.4 GLUE 模式(Python)

步骤一：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE 模式(Python)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往 GLUE 任务的 Web IDE 界面，在该界面支持对任务代码进行开发（也可以在 IDE 中开发完成后，复制粘贴到编辑中）。

该模式的任务实际上是一段 “python” 脚本；

3.5 GLUE 模式(NodeJS)

步骤一：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE 模式(NodeJS)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往 GLUE 任务的 Web IDE 界面，在该界面支持对任务代码进行开发（也可以在 IDE 中开发完成后，复制粘贴到编辑中）。

该模式的任务实际上是一段 “nodeJS” 脚本；

3.6 GLUE 模式(PHP)

同上

3.7 GLUE 模式(PowerShell)

同上