From 31a1dc66be48ce8bd4aa947f95c751fd76ccd8df Mon Sep 17 00:00:00 2001 From: xuxueli <931591021@qq.com> Date: Mon, 6 May 2019 21:17:55 +0800 Subject: [PATCH] update document --- doc/XXL-JOB官方文档.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/XXL-JOB官方文档.md b/doc/XXL-JOB官方文档.md index fd56c82f..eff4f032 100644 --- a/doc/XXL-JOB官方文档.md +++ b/doc/XXL-JOB官方文档.md @@ -650,7 +650,7 @@ public XxlJobSpringExecutor xxlJobExecutor() { ## 四、任务管理 -### 4.0 配置执行器 +### 4.1 配置执行器 点击进入"执行器管理"界面, 如下图: ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_Hr2T.png "在这里输入图片标题") @@ -671,30 +671,30 @@ public XxlJobSpringExecutor xxlJobExecutor() { 手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用； 机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息； -### 4.1 新建任务 +### 4.2 新建任务 进入任务管理界面，点击“新增任务”按钮，在弹出的“新增任务”界面配置任务属性后保存即可。详情页参考章节 "三、任务详解"。 -### 4.2 编辑任务 +### 4.3 编辑任务 进入任务管理界面，选中指定任务。点击该任务右侧“编辑”按钮，在弹出的“编辑任务”界面更新任务属性后保存即可，可以修改设置的任务属性信息： -### 4.3 编辑GLUE代码 +### 4.4 编辑GLUE代码 该操作仅针对GLUE任务。 选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发。可参考章节 "3.2 GLUE模式(Java)"。 -### 4.4 启动/停止任务 +### 4.5 启动/停止任务 可对任务进行“启动”和“停止”操作。 -需要注意的是，此处的启动/停止仅针对任务的后续调度触发行为，不会影响到已经触发的调度任务，如需终止已经触发的调度任务，可查看“4.8 终止运行中的任务” +需要注意的是，此处的启动/停止仅针对任务的后续调度触发行为，不会影响到已经触发的调度任务，如需终止已经触发的调度任务，可查看“4.9 终止运行中的任务” ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_ZAhX.png "在这里输入图片标题") -### 4.5 手动触发一次调度 +### 4.6 手动触发一次调度 点击“执行”按钮，可手动触发一次任务调度，不影响原有调度规则。 ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_ZAhX.png "在这里输入图片标题") -### 4.6 查看调度日志 +### 4.7 查看调度日志 点击“日志”按钮，可以查看任务历史调度日志。在历史调入日志界面可查看每次任务调度的调度结果、执行结果等，点击“执行日志”按钮可查看执行器完整日志。 ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_ZAhX.png "在这里输入图片标题") @@ -711,15 +711,15 @@ public XxlJobSpringExecutor xxlJobExecutor() { 执行结果："执行器"中本次任务执行的结果，200表示成功，500或其他表示失败； 执行备注："执行器"中本次任务执行的日志信息； 操作： - "执行日志"按钮：点击可查看本地任务执行的详细日志信息；详见“4.7 查看执行日志”； + "执行日志"按钮：点击可查看本地任务执行的详细日志信息；详见“4.8 查看执行日志”； "终止任务"按钮：点击可终止本地调度对应执行器上本任务的执行线程，包括未执行的阻塞任务一并被终止； -### 4.7 查看执行日志 +### 4.8 查看执行日志 点击执行日志右侧的 “执行日志” 按钮，可跳转至执行日志界面，可以查看业务代码中打印的完整日志，如下图； ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_tvGI.png "在这里输入图片标题") -### 4.8 终止运行中的任务 +### 4.9 终止运行中的任务 仅针对执行中的任务。 在任务日志界面，点击右侧的“终止任务”按钮，将会向本次任务对应的执行器发送任务终止请求，将会终止掉本次任务，同时会清空掉整个任务执行队列。 @@ -744,13 +744,13 @@ try{ 任务终止时会执行对应JobHandler的"destroy()"方法，可以借助该方法处理一些资源回收的逻辑。 -### 4.9 删除执行日志 +### 4.10 删除执行日志 在任务日志界面，选中执行器和任务之后，点击右侧的"删除"按钮将会出现"日志清理"弹框，弹框中支持选择不同类型的日志清理策略，选中后点击"确定"按钮即可进行日志清理操作； ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_Ypik.png "在这里输入图片标题") ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_EB65.png "在这里输入图片标题") -### 4.10 删除任务 +### 4.11 删除任务 点击删除按钮，可以删除对应任务。 ![输入图片说明](https://raw.githubusercontent.com/xuxueli/xxl-job/master/doc/images/img_Z9Qr.png "在这里输入图片标题") @@ -900,7 +900,7 @@ xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback - 执行时间：执行器，任务执行结束后回调的时间； - 执行结果：执行器，任务执行的结果，SUCCESS或FAIL； - 执行备注：执行器，任务执行的备注信息，如异常日志等； -- 执行日志：任务执行过程中，业务代码中打印的完整执行日志，见“4.7 查看执行日志”； +- 执行日志：任务执行过程中，业务代码中打印的完整执行日志，见“4.8 查看执行日志”； #### 5.4.10 任务依赖 原理：XXL-JOB中每个任务都对应有一个任务ID，同时，每个任务支持设置属性“子任务ID”，因此，通过“任务ID”可以匹配任务依赖关系。 @@ -1090,7 +1090,7 @@ API服务请求参考代码：com.xxl.job.executor.ExecutorBizTest ### 5.16 任务超时控制 支持设置任务超时时间，任务运行超时的情况下，将会主动中断任务； -需要注意的是，任务超时中断时与任务终止机制（可查看“4.8 终止运行中的任务”）类似，也是通过 "interrupt" 中断任务，因此业务代码需要将 "InterruptedException" 外抛，否则功能不可用。 +需要注意的是，任务超时中断时与任务终止机制（可查看“4.9 终止运行中的任务”）类似，也是通过 "interrupt" 中断任务，因此业务代码需要将 "InterruptedException" 外抛，否则功能不可用。 ### 5.17 跨平台 & 跨语言 跨平台、跨语言主要体现在以下两个方面：