Browse Source

update document

xuxueli 6 years ago
parent
commit
99c9a2ab63
1 changed files with 15 additions and 10 deletions
  1. 15 10
      doc/XXL-JOB官方文档.md

+ 15 - 10
doc/XXL-JOB官方文档.md View File

691
     
691
     
692
 ### 3.1 BEAN模式(类形式)
692
 ### 3.1 BEAN模式(类形式)
693
 
693
 
694
-基于类的Bean模式开发方式,这是比较原始的一种开发方式
694
+Bean模式任务,支持基于类的开发方式,每个任务对应一个Java类
695
 
695
 
696
-- 优点:兼容性好、不限制项目环境,即使是无框架项目,如main方法直接启动的项目也可以提供支持,可以参考示例项目 "xxl-job-executor-sample-frameless";
697
-- 缺点:每个任务需要占用一个Java类,比较浪费资源;而且,不支持自动扫描任务注入到执行器容器,需要手动注入。
696
+- 优点:不限制项目环境,兼容性好。即使是无框架项目,如main方法直接启动的项目也可以提供支持,可以参考示例项目 "xxl-job-executor-sample-frameless";
697
+- 缺点:
698
+    - 每个任务需要占用一个Java类,造成类的浪费;
699
+    - 不支持自动扫描任务并注入到执行器容器,需要手动注入。
698
 
700
 
699
 #### 步骤一:执行器项目中,开发Job类:
701
 #### 步骤一:执行器项目中,开发Job类:
700
 
702
 
701
-    - 1、开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类。
702
-    - 2、手动通过如下方式注入到执行器容器。
703
+    1、开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类,实现其中任务方法
704
+    2、手动通过如下方式注入到执行器容器。
703
     ```
705
     ```
704
     XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());
706
     XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());
705
     ```
707
     ```
710
 
712
 
711
 ### 3.2 BEAN模式(方法形式)
713
 ### 3.2 BEAN模式(方法形式)
712
 
714
 
713
-基于方法的Bean模式开发方式,这是比较推荐的开发方式
715
+Bean模式任务,支持基于方法的开发方式,每个任务对应一个方法
714
 
716
 
715
-- 优点:每个任务只需要开发一个方法,添加"@XxlJob"注解即可。更加方便、快速。会自动扫描任务注入到执行器容器。
717
+- 优点:
718
+    - 每个任务只需要开发一个方法,并添加"@XxlJob"注解即可,更加方便、快速。
719
+    - 支持自动扫描任务并注入到执行器容器。
716
 - 缺点:要求Spring容器环境;
720
 - 缺点:要求Spring容器环境;
717
 
721
 
718
 >基于方法开发的任务,底层会生成JobHandler代理,和基于类的方式一样,任务也会以JobHandler的形式存在于执行器任务容器中。
722
 >基于方法开发的任务,底层会生成JobHandler代理,和基于类的方式一样,任务也会以JobHandler的形式存在于执行器任务容器中。
719
 
723
 
720
 #### 步骤一:执行器项目中,开发Job方法:
724
 #### 步骤一:执行器项目中,开发Job方法:
721
 
725
 
722
-    - 1、在Spring Bean实例中,开发Job方法,方式格式要求为 "public ReturnT<String> execute(String param)"
723
-    - 2、为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
724
-    - 3、执行日志:需要通过 "XxlJobLogger.log" 打印执行日志;
726
+    1、在Spring Bean实例中,开发Job方法,方式格式要求为 "public ReturnT<String> execute(String param)"
727
+    2、为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
728
+    3、执行日志:需要通过 "XxlJobLogger.log" 打印执行日志;
725
     
729
     
726
 ```
730
 ```
727
 // 可参考Sample示例执行器中的 "com.xxl.job.executor.service.jobhandler.SampleXxlJob" ,如下:
731
 // 可参考Sample示例执行器中的 "com.xxl.job.executor.service.jobhandler.SampleXxlJob" ,如下:
1682
 - 注意:最新版本 "XxlJobSpringExecutor" 逻辑有调整,历史项目中该组件的配置方式请参考Sample示例项目进行调整,尤其注意需要移除组件的init和destroy方法;
1686
 - 注意:最新版本 "XxlJobSpringExecutor" 逻辑有调整,历史项目中该组件的配置方式请参考Sample示例项目进行调整,尤其注意需要移除组件的init和destroy方法;
1683
 
1687
 
1684
 ### 6.28 版本 v2.2.0 Release Notes[迭代中]
1688
 ### 6.28 版本 v2.2.0 Release Notes[迭代中]
1689
+- 1、[迭代中]调度中心升级springboot2.x;因此,系统要求JDK8+;
1685
 
1690
 
1686
 
1691
 
1687
 ### TODO LIST
1692
 ### TODO LIST