xueli.xue 9 gadus atpakaļ
vecāks
revīzija
bdac4b00e4

+ 336 - 6
doc/XXL-JOB-1.4.x用户手册.md Parādīt failu

@@ -16,7 +16,7 @@ XXL-JOB是一个轻量级分布式任务调度框架,其核心设计目标是
16 16
 - 9、执行日志:支持在线查看调度结果,并且查看完整的执行日志;
17 17
 - 10、邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;
18 18
 - 11、支持登录验证;
19
-- 12、GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。
19
+- 12、GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。支持30个版本的历史版本回溯。
20 20
 
21 21
 #### 1.3 发展
22 22
 于2015年中,我在github上创建XXL-JOB项目仓库并提交第一个commit,随之进行系统结构设计,UI选型,交互设计……
@@ -60,6 +60,7 @@ XXL-JOB是一个轻量级分布式任务调度框架,其核心设计目标是
60 60
 
61 61
 
62 62
 Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择和下载。
63
+
63 64
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23221244_nq9a.png "在这里输入图片标题")
64 65
 
65 66
 #### 1.5 环境
@@ -75,11 +76,13 @@ Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择
75 76
 请下载项目源码并解压,获取 "调度数据库初始化SQL脚本"(脚本文件为: 源码解压根目录\xxl-job\db\tables_xxl_job.sql) 并执行即可。
76 77
 
77 78
 正常情况下,应该生成如下图所示14张表;
79
+
78 80
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23221308_DDW8.png "在这里输入图片标题")
79 81
 
80 82
 #### 2.2 编译源码
81 83
 解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下图所示:
82 84
 
85
+
83 86
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23222522_JGCc.png "在这里输入图片标题")
84 87
 
85 88
 - xxl-job-admin:调度中心
@@ -107,6 +110,7 @@ Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择
107 110
 
108 111
 访问链接:http://localhost:8080/xxl-job-admin/ ,登陆界面如下图所示
109 112
 
113
+
110 114
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23223648_b8Dx.png "在这里输入图片标题")
111 115
 
112 116
 至此“调度中心”项目已经部署成功。
@@ -118,6 +122,7 @@ Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择
118 122
 
119 123
 - **A:配置Jdbc链接**:请在下图所示位置配置jdbc链接地址,链接地址请保持和 2.1章节 所创建的调度数据库的地址一致。
120 124
 
125
+
121 126
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23224042_MeRg.png "在这里输入图片标题")
122 127
 
123 128
 - **B:配置“执行器”端口**:由于“调度中心”和“执行器”部署在不同项目,“调度中心”会请求该端口触发任务执行。端口如下图所示,默认的“执行器”端口是9999,如果与系统现有端口冲突可自行修改,如若不冲突,可忽略。
@@ -142,12 +147,15 @@ Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择
142 147
 - **步骤二(GLUE任务开发)**:请点击下图中所示“GLUE入口按钮”,进入“GLUE编辑器开发界面”,见下图。GLUE任务默认已经初始化了示例任务代码,即打印Hello World。
143 148
 (GLUE实际上是一段继承自IJobHandler的Java类代码,它在执行器项目中运行,可使用@Resource/@Autowire注入执行器里中的其他服务,详细介绍请查看第三章节)
144 149
 
150
+
145 151
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23225310_RYby.png "在这里输入图片标题")
146 152
 
153
+
147 154
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23225327_Y1cn.png "在这里输入图片标题")
148 155
 
149 156
 - **步骤三(触发执行)**:点击下图所示“执行”按钮,可手动触发一次任务执行(通常情况下,通过配置Cron表达式进行任务调度出发)。
150 157
 
158
+
151 159
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23225653_iY9K.png "在这里输入图片标题")
152 160
 
153 161
 - **步骤四(查看日志)**:
@@ -155,25 +163,347 @@ Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择
155 163
 在如图2.5G的任务日志界面中,可查看任务调度状态,执行器接收到调度请求后的执行状态。
156 164
 同时,点击如图2.5G中的“执行日志”按钮,可以查看本此调度在执行器端的完整执行日志,完整执行日志如图2.5H。
157 165
 
166
+
158 167
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23225953_7ey7.png "在这里输入图片标题")
159 168
 (图2.5F:“调度中心”管理管理界面,任务日志入口)
160 169
 
170
+
161 171
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23230953_BFVV.png "在这里输入图片标题")
162 172
 (图2.5G:“调度中心”管理管理界面,任务日志入口)
163 173
 
174
+
164 175
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23230416_2cLu.png "在这里输入图片标题")
165 176
 (图2.5H:“调度中心”管理管理界面,任务日志入口)
166 177
 
167 178
 ## 三、任务详解
168
-#### 4.1 BEAN模式任务
179
+
180
+**配置属性详细说明:**
181
+    - 任务组:任务的分组,便于任务管理;
182
+    - 描述:任务的描述信息,便于任务管理;
183
+    - 执行器地址:执行器接受任务调度的地址,格式为“IP:Port”,支持配置多个地址进行Failover,当存在多个地址时用逗号分隔,格式为“IP1:Port,IP2:Port...”
184
+    - Cron:触发任务执行的Cron表达式;
185
+    - JobHandler + GLUE复选框:
186
+        BEAN模式任务:不选中GLUE复选框,JobHandler输入框为必填项,需要输入该任务对应的JobHandler的名称,即执行器中新开发的JobHandler类“@JobHander”注解自定义的value值;
187
+        GLUE模式任务:选中GLUE复选框,JobHandler输入框被禁用,不必输入,因为此时任务逻辑维护在线上。
188
+    - 执行参数:任务执行所需的参数,多个参数时用逗号分隔,任务执行时将会把多个参数抓换成数组传入;
189
+    - 报警邮件:任务调度失败时邮件通知的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔;
190
+    - 负责人:任务的负责人;
191
+
192
+#### 3.1 BEAN模式任务
169 193
 Bean模式任务:任务逻辑以JobHandler的形式存在于“执行器”所在项目中,开发流程如下:
170 194
 
171
-- **步骤一:开发JobHandler**:
172
-    - 1. 新建一个继承com.xxl.job.core.handler.IJobHandler的Java类;
173
-    - 2. 该类被Spring容器扫描为Bean实例,如加“@Service注解”;
174
-    - 3. 添加 “@JobHander(value="自定义jobhandler名称")”注解,注解的value值为自定义的JobHandler名称,该名称对应的是调度中心新建任务的JobHandler属性的值。
195
+- **步骤一:执行器项目中,开发JobHandler**:
196
+    - 1 新建一个继承com.xxl.job.core.handler.IJobHandler的Java类;
197
+    - 2 该类被Spring容器扫描为Bean实例,如加“@Service注解”;
198
+    - 3 添加 “@JobHander(value="自定义jobhandler名称")”注解,注解的value值为自定义的JobHandler名称,该名称对应的是调度中心新建任务的JobHandler属性的值。
175 199
     (可参考xxl-job-executor-example项目中的DemoJobHandler,见下图)
176 200
 
177 201
 ![输入图片说明](https://static.oschina.net/uploads/img/201607/23232347_oLlM.png "在这里输入图片标题")
178 202
 
203
+- **步骤二:调度中心,新建调度任务并配置(BEAN模式)**,
204
+
205
+参考上文“配置属性详细说明”对新建的任务进行参数配置,需要注意的是“JobHandler + GLUE复选框”任务属性,需要按照“GLUE模式”任务进行配置;
206
+
207
+![输入图片说明](https://static.oschina.net/uploads/img/201607/23225207_GSeQ.png "在这里输入图片标题")
208
+
209
+#### 3.2 GLUE模式任务
210
+GLUE模式任务:任务逻辑以GLUE代码的形式存储在DB中,支持通过Web IDE在线更新,实时编译和生效,因此不需要指定JobHandler。开发流程如下:
211
+
212
+- **步骤一:调度中心,新建调度任务并配置(GLUE模式)**:
213
+
214
+参考上文“配置属性详细说明”对新建的任务进行参数配置,需要注意的是“JobHandler + GLUE复选框”任务属性,需要按照“GLUE模式”任务进行配置;
215
+
216
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24123029_GqMy.png "在这里输入图片标题")
217
+
218
+- **步骤二:开发GLUE代码**:
219
+选中指定任务,点击该任务右侧“GLUE”按钮(仅GLUE模式任务支持),将会前往GLUE任务的Web IDE界面,在该界面支持对任务代码进行开发(当然也可以在IDE中开发完成后,复制粘贴到编辑中),可使用@Resource或@Autoward注解注入“执行器”项目中的Spring服务;
220
+
221
+版本回溯功能(支持30个版本的版本回溯):可参考下图,选择下拉框“版本回溯”,会列出该GLUE的更新历史,选择相应版本即可显示该版本代码,保存后GLUE代码即回退到对应的历史版本;
222
+
223
+## 四、任务管理
224
+#### 4.1 新建任务
225
+进入任务管理界面,点击“新增任务”按钮,在弹出的“新增任务”界面配置任务属性后保存即可,可参考下图:
226
+
227
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24123920_b9UQ.png "在这里输入图片标题")
228
+
229
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24124140_IxVH.png "在这里输入图片标题")
230
+
231
+#### 4.2 编辑任务
232
+进入任务管理界面,选中指定任务。点击该任务右侧“编辑”按钮,在弹出的“编辑任务”界面更新任务属性后保存即可,可参考下图:
233
+
234
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24124734_UYp2.png "在这里输入图片标题")
235
+
236
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24124821_FHtr.png "在这里输入图片标题")
237
+
238
+#### 4.3 编译GLUE代码
239
+
240
+该操作仅针对GLUE任务。
241
+
242
+GLUE任务开发:进入任务管理界面,选中指定任务。点击该任务右侧“GLUE”按钮(仅GLUE模式任务支持),将会前往GLUE任务的Web IDE界面,在该界面支持对任务代码进行开发(当然也可以在IDE中开发完成后,复制粘贴到编辑中)
243
+
244
+版本回溯功能(支持30个版本的版本回溯):可参考下图,选择下拉框“版本回溯”,会列出该GLUE的更新历史,选择相应版本即可显示该版本代码,保存后GLUE代码即回退到对应的历史版本;
245
+
246
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24125405_tk1u.png "在这里输入图片标题")
247
+
248
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24125452_qwGM.png "在这里输入图片标题")
249
+
250
+#### 4.4 暂停/恢复任务
251
+可对任务进行“暂停”和“恢复”操作。
252
+需要注意的是,此处的暂停/恢复仅针对任务的后续调度触发行为,不会影响到已经触发的调度任务,如需终止已经触发的调度任务,可查看“4.8 终止运行中的任务”
253
+
254
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24130337_ZAhX.png "在这里输入图片标题")
255
+
256
+#### 4.5 手动触发一次调度
257
+点击“执行”按钮,可手动触发一次任务调度,不影响原有调度规则。
258
+
259
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24133348_Z5wp.png "在这里输入图片标题")
260
+
261
+#### 4.6 查看调度日志
262
+点击“日志”按钮,可以查看任务历史调度日志。在历史调入日志界面可查看每次任务调度的调度结果、执行结果等,点击“执行日志”按钮可查看执行器完整日志。
263
+
264
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24133500_9235.png "在这里输入图片标题")
265
+
266
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24134148_6xpS.png "在这里输入图片标题")
267
+
268
+调度日志,针对单次调度,属性说明如下:
269
+- 执行器地址:任务执行的机器地址;
270
+- JobHandler:Bean模式表示任务执行的JobHandler名称;
271
+- 任务参数:任务执行的入参;
272
+- 调度时间:调度中心,发起调度的时间;
273
+- 调度结果:调度中心,发起调度的结果,SUCCESS或FAIL;
274
+- 调度备注:调度中心,发起调度的备注信息,如地址心跳检测日志等;
275
+- 执行时间:执行器,任务执行结束后回调的时间;
276
+- 执行结果:执行器,任务执行的结果,SUCCESS或FAIL;
277
+- 执行备注:执行器,任务执行的备注信息,如异常日志等;
278
+- 执行日志:任务执行过程中,业务代码中打印的完整执行日志,见“4.7 查看执行日志”;
279
+
280
+#### 4.7 查看执行日志
281
+点击执行日志右侧的 “执行日志” 按钮,可跳转至执行日志界面,可以查看业务代码中打印的完整日志,如下图;
282
+
283
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24134243_BGuL.png "在这里输入图片标题")
284
+
285
+#### 4.8 终止运行中的任务
286
+仅针对执行中的任务。
287
+在任务日志界面,点击右侧的“终止任务”按钮,将会向本次任务对应的执行器发送任务终止请求,将会终止掉本次任务,同时会清空掉整个任务执行队列。
288
+
289
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24140048_hIci.png "在这里输入图片标题")
290
+
291
+#### 4.9 删除任务
292
+点击删除按钮,可以删除对应任务。
293
+
294
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24140641_Z9Qr.png "在这里输入图片标题")
295
+
296
+## 五、总体设计
297
+#### 5.1 源码目录介绍
298
+    - /doc :文档资料
299
+    - /db :“调度数据库”建表脚本
300
+    - /xxl-job-admin :调度中心,项目源码
301
+    - /xxl-job-core :公共Jar依赖
302
+    - /xxl-job-executor-example :执行器,Demo项目源码(大家可以在该项目上进行开发,也可以将现有项目改造生成执行器项目)
303
+
304
+#### 5.2 “调度数据库”配置
305
+XXL-JOB调度模块基于Quartz集群实现,其“调度数据库”是在Quartz的11张集群mysql表基础上扩展而成。
306
+
307
+XXL-JOB首先定制了Quartz原生表结构前缀(XXL_JOB_QRTZ_)。
308
+
309
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24143957_bNwm.png "在这里输入图片标题")
310
+
311
+然后,在此基础上新增了三张扩展表,如下:
312
+    - XXL_JOB_QRTZ_TRIGGER_INFO:调度扩展信息表: 用于保存XXL-JOB调度任务的扩展信息,如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等;
313
+    - XXL_JOB_QRTZ_TRIGGER_LOG:调度日志表: 用于保存XXL-JOB任务调度的历史信息,如调度结果、执行结果、调度入参、调度机器和执行器等等;
314
+    - XXL_JOB_QRTZ_TRIGGER_LOGGLUE:任务GLUE日志:用于保存GLUE更新历史,用于支持GLUE的版本回溯功能;
315
+
316
+因此,XXL-JOB调度数据库共计用于14张数据库表。
317
+
318
+![输入图片说明](https://static.oschina.net/uploads/img/201607/23221308_DDW8.png "在这里输入图片标题")
319
+
320
+#### 5.3 架构设计
321
+##### 5.3.1 设计思想
322
+将调度行为抽象形成“调度中心”公共平台,而平台自身并不承担业务逻辑,“调度中心”负责发起调度请求。
323
+
324
+将任务抽象成分散的JobHandler,交由“执行器”统一管理,“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。
325
+
326
+因此,“调度”和“任务”两部分可以相互解耦,提高系统整体稳定性和扩展性;
327
+
328
+##### 5.3.2 系统组成
329
+- **调度模块(调度中心)**:
330
+    负责管理调度信息,按照调度配置发出调度请求,自身不承担业务代码。调度系统与任务解耦,提高了系统可用性和稳定性,同时调度系统性能不再受限于任务模块;
331
+    支持可视化、简单且动态的维管理调度信息,包括任务新建,更新,删除,GLUE开发和任务报警等,所有上述操作都会实时生效,同时支持监控调度结果以及执行日志,支持执行器Failover。
332
+- **执行模块(执行器)**:
333
+    负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作,开发和维护更加简单和高效;
334
+    接收“调度中心”的执行请求、终止请求和日志请求等。
335
+
336
+##### 5.3.3 架构图(绘制中)
337
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24144555_SUI2.png "在这里输入图片标题")
338
+
339
+#### 5.4 调度模块
340
+##### 5.4.1 RemoteHttpJobBean
341
+常规Quartz的开发,任务逻辑一般维护在QuartzJobBean中,耦合很严重。XXL-JOB中“调度模块”和“任务模块”完全解耦,调度模块中的所有调度任务使用同一个QuartzJobBean,即RemoteHttpJobBean。不同的调度任务将各自参数维护在各自扩展表数据中,当触发RemoteHttpJobBean执行时,将会解析不同的任务参数发起远程调用,调用各自的远程执行器服务。
342
+
343
+这种调用模型类似RPC调用,RemoteHttpJobBean提供调用代理的功能,而执行器提供远程服务的功能。
344
+
345
+##### 5.4.2 调度中心HA(集群)
346
+基于Quartz的集群方案,数据库选用Mysql;集群分布式并发环境中使用QUARTZ定时任务调度,会在各个节点会上报任务,存到数据库中,执行时会从数据库中取出触发器来执行,如果触发器的名称和执行时间相同,则只有一个节点去执行此任务。
347
+
348
+```
349
+# for cluster
350
+org.quartz.jobStore.tablePrefix = XXL_JOB_QRTZ_
351
+org.quartz.scheduler.instanceId: AUTO
352
+org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX
353
+org.quartz.jobStore.isClustered: true
354
+org.quartz.jobStore.clusterCheckinInterval: 1000
355
+```
356
+
357
+##### 5.4.3 调度线程池
358
+默认线程池中线程的数量为10个,避免单线程因阻塞而引起任务调度延迟。
359
+
360
+```
361
+org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
362
+org.quartz.threadPool.threadCount: 10
363
+org.quartz.threadPool.threadPriority: 5
364
+org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
365
+```
366
+
367
+##### 5.4.4 @DisallowConcurrentExecution
368
+XXL-JOB调度模块的“调度中心”默认不使用该注解,即默认开启并行机制,因为RemoteHttpJobBean为公共QuartzJobBean,这样在多线程调度的情况下,调度模块被阻塞的几率很低,大大提高了调度系统的承载量。
369
+
370
+XXL-JOB的每个调度任务虽然在调度模块是并行调度执行的,但是任务调度传递到任务模块的“执行器”确实串行执行的,同时支持任务终止。
371
+
372
+##### 5.4.5 misfire
373
+错过了触发时间,处理规则。
374
+可能原因:服务重启;调度线程被QuartzJobBean阻塞,线程被耗尽;某个任务启用了@DisallowConcurrentExecution,上次调度持续阻塞,下次调度被错过;
375
+
376
+quartz.properties中关于misfire的阀值配置如下,单位毫秒:
377
+```
378
+org.quartz.jobStore.misfireThreshold: 60000
379
+```
380
+
381
+Misfire规则:
382
+    withMisfireHandlingInstructionDoNothing:不触发立即执行,等待下次调度;
383
+    withMisfireHandlingInstructionIgnoreMisfires:以错过的第一个频率时间立刻开始执行;
384
+    withMisfireHandlingInstructionFireAndProceed:以当前时间为触发频率立刻触发一次执行;
385
+
386
+XXL-JOB默认misfire规则为:withMisfireHandlingInstructionDoNothing
387
+
388
+```
389
+CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(jobInfo.getJobCron()).withMisfireHandlingInstructionDoNothing();
390
+CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity(triggerKey).withSchedule(cronScheduleBuilder).build();
391
+```
392
+
393
+##### 5.4.6 日志回调服务
394
+调度模块的“调度中心”作为Web服务单独部署,除此之外,内部嵌入jetty服务器提供日志回调服务。
395
+
396
+“执行器”在接收到任务执行请求后,执行任务,在执行结束之后会将执行结果回调通知“调度中心”,回调端口如下图所示。
397
+
398
+![输入图片说明](https://static.oschina.net/uploads/img/201607/23223301_I03k.png "在这里输入图片标题")
399
+
400
+##### 5.4.7 任务HA(Failover)
401
+任务“执行器地址”支持配置多个,用逗号分隔,如“127.0.0.1:9998,127.0.0.1:9999”。
402
+
403
+如果任务配置多个执行器地址,当调度中心每次发起调度请求时,会按照地址配置的顺序依次对执行器发出心跳检测请求,第一个检测为存活状态的执行器将会被选定。
404
+
405
+调度成功后,可在日志监控界面查看“调度备注”,如下;
406
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24150809_TNqT.png "在这里输入图片标题")
407
+
408
+“调度备注”可以查看执行器地址选择日志,任务配置的地址“227.0.0.1:9999,127.0.0.1:9999”,首先对第一个执行器地址“227.0.0.1:9999”进行心跳检测,心跳失败因此跳过;然后对第二个执行器地址“127.0.0.1:9999”进行心跳检测,心跳检测成功,选定为“目标执行器”;然后对“目标执行器”发送调度请求,调度流程结束,等待执行器回调执行结果。
409
+
410
+##### 5.4.8 调度日志
411
+调度中心每次进行任务调度,都会记录一条任务日志,任务日志主要包括以下三部分内容:
412
+
413
+- 任务信息:包括“执行器地址”、“JobHandler”和“执行参数”等属性,根据这些参数,可以精确的定位任务执行的具体机器和任务代码;
414
+- 调度信息:包括“调度时间”、“调度结果”和“调度日志”等,根据这些参数,可以了解“调度中心”发起调度请求时具体情况。
415
+- 执行信息:包括“执行时间”、“执行结果”和“执行日志”等,根据这些参数,可以了解在“执行器”端任务执行的具体情况;
416
+
417
+
418
+![输入图片说明](https://static.oschina.net/uploads/img/201607/24134148_6xpS.png "在这里输入图片标题")
419
+
420
+调度日志,针对单次调度,属性说明如下:
421
+- 执行器地址:任务执行的机器地址;
422
+- JobHandler:Bean模式表示任务执行的JobHandler名称;
423
+- 任务参数:任务执行的入参;
424
+- 调度时间:调度中心,发起调度的时间;
425
+- 调度结果:调度中心,发起调度的结果,SUCCESS或FAIL;
426
+- 调度备注:调度中心,发起调度的备注信息,如地址心跳检测日志等;
427
+- 执行时间:执行器,任务执行结束后回调的时间;
428
+- 执行结果:执行器,任务执行的结果,SUCCESS或FAIL;
429
+- 执行备注:执行器,任务执行的备注信息,如异常日志等;
430
+- 执行日志:任务执行过程中,业务代码中打印的完整执行日志,见“4.7 查看执行日志”;
431
+
432
+##### 5.4.9 quartz的不足
433
+Quartz作为开源作业调度中的佼佼者,是作业调度的首选。但是集群环境中Quartz采用API的方式对任务进行管理,从而可以避免上述问题,但是同样存在以下问题:
434
+    - 问题一:调用API的的方式操作任务,不人性化;
435
+    - 问题二:需要持久化业务QuartzJobBean到底层数据表中,系统侵入性相当严重。
436
+    - 问题三:调度逻辑和QuartzJobBean耦合在同一个项目中,这将导致一个问题,在调度任务数量逐渐增多,同时调度任务逻辑逐渐加重的情况加,此时调度系统的性能将大大受限于业务;
437
+XXL-JOB弥补了quartz的上述不足之处。
438
+
439
+#### 5.5 执行模块
440
+##### 5.5.1 Bean模式任务
441
+开发步骤:见章节三;
442
+原理:每个Bean模式任务都是一个Spring的Bean类实例,它被维护在“执行器”项目的Spring容器中。任务类需要加“@JobHander(value="名称")”注解,因为“执行器”会根据该注解识别Spring容器中的任务。任务类需要继承统一接口“IJobHandler”,任务逻辑在execute方法中开发,因为“执行器”在接收到调度中心的调度请求时,将会调用“IJobHandler”的execute方法,执行任务逻辑。
443
+
444
+##### 5.5.2 GLUE模式任务
445
+开发步骤:见章节三;
446
+原理:每个Glue任务的代码,实际上是“一个继承自“IJobHandler”的实现类的类代码”,“执行器”接收到“调度中心”的调度请求时,会通过Groovy类加载器加载此代码,实例化成Java对象,同时注入此代码中声明的Spring服务(请确保Glue代码中的服务和类引用在“执行器”项目中存在),然后调用该对象的execute方法,执行任务逻辑。
447
+
448
+##### 5.5.3 执行器
449
+执行器实际上是一个内嵌的Jetty服务器,默认端口9999。
450
+
451
+![输入图片说明](https://static.oschina.net/uploads/img/201607/23224304_0jxT.png "在这里输入图片标题")
452
+
453
+在项目启动时,执行器会通过“@JobHander”识别Spring容器中“Bean模式任务”,以注解的value属性为key管理起来。
454
+
455
+“执行器”接收到“调度中心”的调度请求时,如果任务类型为“Bean模式”,将会匹配Spring容器中的“Bean模式任务”,然后调用其execute方法,执行任务逻辑。如果任务类型为“GLUE模式”,将会加载GLue代码,实例化Java对象,注入依赖的Spring服务(注意:Glue代码中注入的Spring服务,必须存在与该“执行器”项目的Spring容器中),然后调用execute方法,执行任务逻辑。
456
+
457
+##### 5.5.4 任务日志
458
+XXL-JOB会为每次调度请求生成一个单独的日志文件,通过重写LOG4J的Appender实现,“调度中心”查看执行日志时将会加载对应的日志文件。
459
+
460
+需要注意的是,“执行器”中日志Appender上配置的包名,需要覆盖到所有任务(Bean模式 + GLUE模式)的包名,否则覆盖不到的任务将不会生成日志文件。
461
+
462
+```
463
+// 以下代码见/xxl-job/xxl-job-executor-example/src/main/resources/log4j.xml文件
464
+<appender name="xxl-job" class="com.xxl.job.core.log.XxlJobFileAppender">
465
+    <param name="filePath" value="/data/applogs/xxl-job/jobhandler/"/>
466
+    <param name="append" value="true"/>
467
+    <param name="encoding" value="UTF-8"/>
468
+    <layout class="org.apache.log4j.PatternLayout">
469
+        <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%t]-[%M]-[%L]-[%p] %m%n"/>
470
+    </layout>
471
+</appender>
472
+...
473
+<logger name="com.xxl.job.executor.service.jobhandler" additivity="false">
474
+    <level value="INFO" />
475
+    <appender-ref ref="CONSOLE" />
476
+    <appender-ref ref="FILE" />
477
+    <appender-ref ref="xxl-job"/>
478
+</logger>
479
+```
480
+
481
+单独日志文件存放的位置可在“执行器”的log.xml文件进行自定义,默认位置为项目磁盘根目录下“/data/applogs/xxl-job/jobhandler/”;
482
+
483
+目录格式为:/data/applogs/xxl-job/jobhandler/“格式化日期”/“数据库调度日志记录的主键ID.log”。
484
+
485
+##### 5.6 通讯模块
486
+ 
487
+一次完整的任务调度流程如下:
488
+- 1、“调度中心”向“执行器”发送http调度请求。如图2.4B所示。
489
+(“执行器”中接收请求的服务,实际上是一台内嵌jetty服务器,默认端口9999)
490
+- 2、“执行器”执行任务逻辑;
491
+- 3、“执行器”http回调“调度中心”调度结果;如图2.3C所示。
492
+(“调度中心”中接收回调的服务,实际上是一台内嵌jetty服务器,默认端口8888)
493
+
494
+
495
+## 六、其他
496
+#### 6.1 接入登记
497
+更多接入公司,欢迎在github [登记](https://github.com/xuxueli/xxl-job/issues/1 )。
498
+
499
+#### 6.2 报告问题
500
+XXL-JOB托管在Github上,如有问题可在 [ISSUES](https://github.com/xuxueli/xxl-job/issues/) 上提问,也可以加入技术交流群(仅作技术交流):367260654
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
179 509
 

+ 1 - 1
xxl-job-admin/src/main/java/com/xxl/job/admin/controller/JobCodeController.java Parādīt failu

@@ -69,7 +69,7 @@ public class JobCodeController {
69 69
 		if (StringUtils.isNotBlank(xxlJobLogGlue.getGlueSource()) && StringUtils.isNotBlank(xxlJobLogGlue.getGlueRemark())) {
70 70
 			xxlJobLogGlueDao.save(xxlJobLogGlue);
71 71
 			// remove code backup more than 30
72
-			xxlJobLogGlueDao.removeOld(xxlJobLogGlue.getJobGroup(), xxlJobLogGlue.getJobName(), 3);
72
+			xxlJobLogGlueDao.removeOld(xxlJobLogGlue.getJobGroup(), xxlJobLogGlue.getJobName(), 30);
73 73
 		}
74 74
 		
75 75
 		

+ 1 - 1
xxl-job-admin/src/main/resources/config.properties Parādīt failu

@@ -4,7 +4,7 @@ mail.port=25
4 4
 mail.username=ovono802302@163.com
5 5
 mail.password=asdfzxcv
6 6
 mail.sendFrom=ovono802302@163.com
7
-mail.sendNick=《调度调度平台XXL-JOB》
7
+mail.sendNick=《任务调度平台XXL-JOB》
8 8
 
9 9
 # for login
10 10
 login.username=admin