xuxueli 8 years ago
parent
commit
255bd41333
1 changed files with 24 additions and 14 deletions
  1. 24 14
      doc/XXL-JOB官方文档.md

+ 24 - 14
doc/XXL-JOB官方文档.md View File

264
     xxl.job.executor.ip=
264
     xxl.job.executor.ip=
265
     xxl.job.executor.port=9999
265
     xxl.job.executor.port=9999
266
     
266
     
267
+    ### xxl-job, access token:执行器通讯TOKEN,非空时启用
268
+    xxl.job.accessToken=
269
+        
267
     ### xxl-job log path:执行器运行日志文件存储的磁盘位置,需要对该路径拥有读写权限
270
     ### xxl-job log path:执行器运行日志文件存储的磁盘位置,需要对该路径拥有读写权限
268
     xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/
271
     xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/
269
     
272
     
270
-    ### xxl-job, access token:执行器通讯TOKEN,非空时启用
271
-    xxl.job.accessToken=
272
-
273
+    ### xxl-job log retention days:执行器Log文件定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保持3天,否则功能不生效;
274
+    xxl.job.executor.logretentiondays=-1
275
+    
273
 
276
 
274
 #### 步骤三:执行器组件配置
277
 #### 步骤三:执行器组件配置
275
 
278
 
283
 <!-- 配置01、JobHandler 扫描路径:自动扫描容器中JobHandler -->
286
 <!-- 配置01、JobHandler 扫描路径:自动扫描容器中JobHandler -->
284
 <context:component-scan base-package="com.xxl.job.executor.service.jobhandler" />
287
 <context:component-scan base-package="com.xxl.job.executor.service.jobhandler" />
285
 
288
 
286
-<!-- 配置02、执行器Excutor配置:执行器核心配置 -->
289
+<!-- 配置02、执行器 -->
287
 <bean id="xxlJobExecutor" class="com.xxl.job.core.executor.XxlJobExecutor" init-method="start" destroy-method="destroy" >
290
 <bean id="xxlJobExecutor" class="com.xxl.job.core.executor.XxlJobExecutor" init-method="start" destroy-method="destroy" >
291
+    <!-- 执行器注册中心地址[选填],为空则关闭自动注册 -->
292
+    <property name="adminAddresses" value="${xxl.job.admin.addresses}" />
293
+    <!-- 执行器AppName[选填],为空则关闭自动注册 -->
294
+    <property name="appName" value="${xxl.job.executor.appname}" />
288
     <!-- 执行器IP[选填],为空则自动获取 -->
295
     <!-- 执行器IP[选填],为空则自动获取 -->
289
     <property name="ip" value="${xxl.job.executor.ip}" />
296
     <property name="ip" value="${xxl.job.executor.ip}" />
290
     <!-- 执行器端口号[选填],为空则自动获取 -->
297
     <!-- 执行器端口号[选填],为空则自动获取 -->
291
     <property name="port" value="${xxl.job.executor.port}" />
298
     <property name="port" value="${xxl.job.executor.port}" />
292
-    <!-- 执行器AppName[选填],为空则关闭自动注册 -->
293
-    <property name="appName" value="${xxl.job.executor.appname}" />
294
-    <!-- 执行器注册中心地址[选填],为空则关闭自动注册 -->
295
-    <property name="adminAddresses" value="${xxl.job.admin.addresses}" />
296
-    <!-- 执行器日志路径[选填],为空则使用默认路径 -->
297
-    <property name="logPath" value="${xxl.job.executor.logpath}" />
298
     <!-- 访问令牌[选填],非空则进行匹配校验 -->
299
     <!-- 访问令牌[选填],非空则进行匹配校验 -->
299
     <property name="accessToken" value="${xxl.job.accessToken}" />
300
     <property name="accessToken" value="${xxl.job.accessToken}" />
301
+    <!-- 执行器日志路径[选填],为空则使用默认路径 -->
302
+    <property name="logPath" value="${xxl.job.executor.logpath}" />
303
+    <!-- 日志保存天数[选填],值大于3时生效 -->
304
+    <property name="logRetentionDays" value="${xxl.job.executor.logretentiondays}" />
300
 </bean>
305
 </bean>
301
 ```
306
 ```
302
 
307
 
303
 #### 步骤四:部署执行器项目:
308
 #### 步骤四:部署执行器项目:
304
-如果已经正确进行上述配置,可将执行器项目编译打部署,系统提供三个执行器Sample示例项目,选择其中一个即可,各自的部署方式如下。
309
+如果已经正确进行上述配置,可将执行器项目编译打部署,系统提供多种执行器Sample示例项目,选择其中一个即可,各自的部署方式如下。
305
 
310
 
306
-    xxl-job-executor-sample-spring:项目编译打包成WAR包,并部署到tomcat中。
307
     xxl-job-executor-sample-springboot:项目编译打包成springboot类型的可执行JAR包,命令启动即可;
311
     xxl-job-executor-sample-springboot:项目编译打包成springboot类型的可执行JAR包,命令启动即可;
312
+    xxl-job-executor-sample-spring:项目编译打包成WAR包,并部署到tomcat中。
313
+    xxl-job-executor-sample-jfinal:同上
314
+    xxl-job-executor-sample-nutz:同上
315
+    
308
 
316
 
309
 至此“执行器”项目已经部署结束。
317
 至此“执行器”项目已经部署结束。
310
 
318
 
311
 #### 步骤五:执行器集群(可选):
319
 #### 步骤五:执行器集群(可选):
312
 执行器支持集群部署,提升调度系统可用性,同时提升任务处理能力。
320
 执行器支持集群部署,提升调度系统可用性,同时提升任务处理能力。
313
 
321
 
314
-集群部署唯一要求为:保证集群中每个执行器的配置项 "xxl.job.admin.addresses/调度中心地址" 保持一致,执行器根据该配置进行执行器自动注册等操作。 
322
+执行器集群部署时,几点要求和建议:
323
+- 执行器回调地址(xxl.job.admin.addresses)需要保持一致;执行器根据该配置进行执行器自动注册等操作。 
324
+- 同一个执行器集群内AppName(xxl.job.executor.appname)需要保持一致;调度中心根据该配置动态发现不同集群的在线执行器列表。
315
 
325
 
316
 
326
 
317
 ### 2.5 开发第一个任务“Hello World”       
327
 ### 2.5 开发第一个任务“Hello World”       
1113
 - 28、新增"任务ID"属性,移除"JobKey"属性,前者承担所有功能,方便后续增强任务依赖功能。
1123
 - 28、新增"任务ID"属性,移除"JobKey"属性,前者承担所有功能,方便后续增强任务依赖功能。
1114
 - 29、任务循环依赖问题修复,避免子任务与父任务重复导致的调度死循环;
1124
 - 29、任务循环依赖问题修复,避免子任务与父任务重复导致的调度死循环;
1115
 - 30、任务列表新增筛选条件 "任务描述",快速检索任务;
1125
 - 30、任务列表新增筛选条件 "任务描述",快速检索任务;
1116
-- 31、执行器Log文件定期清理功能:执行器新增配置项("xxl.job.executor.logretentiondays")日志保存天数,日志文件过期自动删除。限制至少保持3天;
1126
+- 31、执行器Log文件定期清理功能:执行器新增配置项("xxl.job.executor.logretentiondays")日志保存天数,日志文件过期自动删除。
1117
 
1127
 
1118
 ### 6.21 版本 V1.9.1 特性[迭代中]
1128
 ### 6.21 版本 V1.9.1 特性[迭代中]
1119
 
1129