elastic-Job配置参数详细解释

悠悠 2021-09-27 14:44 820阅读 0赞

job:simple命名空间属性详细说明

<table> 
 <tbody> 
  <tr> 
   <th style="width:133px;">属性名</th> 
   <th style="width:77px;">类型</th> 
   <th style="width:96px;">是否必填</th> 
   <th style="width:142px;">缺省值</th> 
   <th style="width:435px;">描述</th> 
  </tr> 
  <tr> 
   <td style="width:133px;">id</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;"><code>是</code></td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">作业名称</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">class</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">作业实现类，需实现<code>ElasticJob</code>接口，脚本型作业不需要配置</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">registry-center-ref</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;"><code>是</code></td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">注册中心<code>Bean</code>的引用，需引用<code>reg:zookeeper</code>的声明</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">cron</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;"><code>是</code></td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;"><code>cron</code>表达式，用于配置作业触发时间</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">sharding-total-count</td> 
   <td style="width:77px;">int</td> 
   <td style="width:96px;"><code>是</code></td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">作业分片总数</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">sharding-item-parameters</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">分片序列号和参数用等号分隔，多个键值对用逗号分隔<br> 分片序列号从<code>0</code>开始，不可大于或等于作业分片总数<br> 如：<br><code>0=a,1=b,2=c</code></td> 
  </tr> 
  <tr> 
   <td style="width:133px;">job-parameter</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">作业自定义参数<br> 可以配置多个相同的作业，但是用不同的参数作为不同的调度实例</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">monitor-execution</td> 
   <td style="width:77px;">boolean</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">true</td> 
   <td style="width:435px;">监控作业运行时状态<br> 每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。<br> 每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">monitor-port</td> 
   <td style="width:77px;">int</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">-1</td> 
   <td style="width:435px;">作业监控端口<br> 建议配置作业监控端口, 方便开发者dump作业信息。<br> 使用方法: echo “dump” | nc 127.0.0.1 9888</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">max-time-diff-seconds</td> 
   <td style="width:77px;">int</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">-1</td> 
   <td style="width:435px;">最大允许的本机与注册中心的时间误差秒数<br> 如果时间误差超过配置秒数则作业启动时将抛异常<br> 配置为<code>-1</code>表示不校验时间误差</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">ailover</td> 
   <td style="width:77px;">boolean</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">false</td> 
   <td style="width:435px;">是否开启失效转移<br> 仅<code>monitorExecution</code>开启，失效转移才有效</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">misfire</td> 
   <td style="width:77px;">boolean</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">true</td> 
   <td style="width:435px;">是否开启错过任务重新执行</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">job-sharding-strategy-class</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">true</td> 
   <td style="width:435px;">作业分片策略实现类全路径<br> 默认使用平均分配策略<br> 详情参见：<a href="http://dangdangdotcom.github.io/elastic-job/post/job_strategy" rel="nofollow">作业分片策略</a></td> 
  </tr> 
  <tr> 
   <td style="width:133px;">description</td> 
   <td style="width:77px;">String</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">&nbsp;</td> 
   <td style="width:435px;">作业描述信息</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">disabled</td> 
   <td style="width:77px;">boolean</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">false</td> 
   <td style="width:435px;">作业是否禁止启动<br> 可用于部署作业时，先禁止启动，部署结束后统一启动</td> 
  </tr> 
  <tr> 
   <td style="width:133px;">overwrite</td> 
   <td style="width:77px;">boolean</td> 
   <td style="width:96px;">否</td> 
   <td style="width:142px;">false</td> 
   <td style="width:435px;">本地配置是否可覆盖注册中心配置<br> 如果可覆盖，每次启动作业都以本地配置为准</td> 
  </tr> 
 </tbody> 
</table>

job:dataflow命名空间属性详细说明

job:dataflow命名空间拥有job:simple命名空间的全部属性，以下仅列出特有属性

<table> 
 <tbody> 
  <tr> 
   <th style="width:121px;">属性名</th> 
   <th style="width:84px;">类型</th> 
   <th style="width:92px;">是否必填</th> 
   <th style="width:135px;">缺省值</th> 
   <th style="width:417px;">描述</th> 
  </tr> 
  <tr> 
   <td style="width:121px;">process-count-interval-seconds</td> 
   <td style="width:84px;">int</td> 
   <td style="width:92px;">否</td> 
   <td style="width:135px;">300</td> 
   <td style="width:417px;">统计作业处理数据数量的间隔时间<br> 单位：秒</td> 
  </tr> 
  <tr> 
   <td style="width:121px;">concurrent-data-process-thread-count</td> 
   <td style="width:84px;">int</td> 
   <td style="width:92px;">否</td> 
   <td style="width:135px;">CPU核数*2</td> 
   <td style="width:417px;">同时处理数据的并发线程数<br> 不能小于1<br> 仅<code>ThroughputDataFlow</code>作业有效</td> 
  </tr> 
  <tr> 
   <td style="width:121px;">fetch-data-count</td> 
   <td style="width:84px;">int</td> 
   <td style="width:92px;">否</td> 
   <td style="width:135px;">1</td> 
   <td style="width:417px;">每次抓取的数据量</td> 
  </tr> 
  <tr> 
   <td style="width:121px;">streaming-process</td> 
   <td style="width:84px;">boolean</td> 
   <td style="width:92px;">否</td> 
   <td style="width:135px;">false</td> 
   <td style="width:417px;">是否流式处理数据<br> 如果流式处理数据, 则<code>fetchData</code>不返回空结果将持续执行作业<br> 如果非流式处理数据, 则处理数据完成后作业结束</td> 
  </tr> 
 </tbody> 
</table>

job:script命名空间属性详细说明，基本属性参照job:simple命名空间属性详细说明

job:script命名空间拥有job:simple命名空间的全部属性，以下仅列出特有属性

<table> 
 <thead> 
  <tr> 
   <th style="width:157px;">属性名</th> 
   <th style="width:82px;">类型</th> 
   <th style="width:85px;">是否必填</th> 
   <th style="width:107px;">缺省值</th> 
   <th style="width:418px;">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="width:157px;">script-command-line</td> 
   <td style="width:82px;">String</td> 
   <td style="width:85px;">否</td> 
   <td style="width:107px;">&nbsp;</td> 
   <td style="width:418px;">脚本型作业执行命令行</td> 
  </tr> 
 </tbody> 
</table>

job:listener命名空间属性详细说明

`job:listener`必须配置为`job:bean`的子元素

<table> 
 <tbody> 
  <tr> 
   <th style="width:164px;">属性名</th> 
   <th style="width:95px;">类型</th> 
   <th style="width:85px;">是否必填</th> 
   <th style="width:140px;">缺省值</th> 
   <th style="width:410px;">描述</th> 
  </tr> 
  <tr> 
   <td style="width:164px;">class</td> 
   <td style="width:95px;">String</td> 
   <td style="width:85px;"><code>是</code></td> 
   <td style="width:140px;">&nbsp;</td> 
   <td style="width:410px;">前置后置任务监听实现类，需实现<code>ElasticJobListener</code>接口</td> 
  </tr> 
  <tr> 
   <td style="width:164px;">started-timeout-milliseconds</td> 
   <td style="width:95px;">long</td> 
   <td style="width:85px;"><code>否</code></td> 
   <td style="width:140px;">Long.MAX_VALUE</td> 
   <td style="width:410px;">AbstractDistributeOnceElasticJobListener型监听器，最后一个作业执行前的执行方法的超时时间<br> 单位：毫秒</td> 
  </tr> 
  <tr> 
   <td style="width:164px;">completed-timeout-milliseconds</td> 
   <td style="width:95px;">long</td> 
   <td style="width:85px;"><code>否</code></td> 
   <td style="width:140px;">Long.MAX_VALUE</td> 
   <td style="width:410px;">AbstractDistributeOnceElasticJobListener型监听器，最后一个作业执行后的执行方法的超时时间<br> 单位：毫秒</td> 
  </tr> 
 </tbody> 
</table>

reg:bean命名空间属性详细说明

<table> 
 <tbody> 
  <tr> 
   <th style="width:155px;">属性名</th> 
   <th style="width:87px;">类型</th> 
   <th style="width:90px;">是否必填</th> 
   <th style="width:132px;">缺省值</th> 
   <th style="width:384px;">描述</th> 
  </tr> 
  <tr> 
   <td style="width:155px;">id</td> 
   <td style="width:87px;">String</td> 
   <td style="width:90px;"><code>是</code></td> 
   <td style="width:132px;">&nbsp;</td> 
   <td style="width:384px;">注册中心在<code>Spring</code>容器中的主键</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">server-lists</td> 
   <td style="width:87px;">String</td> 
   <td style="width:90px;"><code>是</code></td> 
   <td style="width:132px;">&nbsp;</td> 
   <td style="width:384px;">连接<code>Zookeeper</code>服务器的列表<br> 包括IP地址和端口号<br> 多个地址用逗号分隔<br> 如: host1:2181,host2:2181</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">namespace</td> 
   <td style="width:87px;">String</td> 
   <td style="width:90px;"><code>是</code></td> 
   <td style="width:132px;">&nbsp;</td> 
   <td style="width:384px;"><code>Zookeeper</code>的命名空间</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">base-sleep-time-milliseconds</td> 
   <td style="width:87px;">int</td> 
   <td style="width:90px;">否</td> 
   <td style="width:132px;">1000</td> 
   <td style="width:384px;">等待重试的间隔时间的初始值<br> 单位：毫秒</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">max-sleep-time-milliseconds</td> 
   <td style="width:87px;">int</td> 
   <td style="width:90px;">否</td> 
   <td style="width:132px;">3000</td> 
   <td style="width:384px;">等待重试的间隔时间的最大值<br> 单位：毫秒</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">max-retries</td> 
   <td style="width:87px;">int</td> 
   <td style="width:90px;">否</td> 
   <td style="width:132px;">3</td> 
   <td style="width:384px;">最大重试次数</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">session-timeout-milliseconds</td> 
   <td style="width:87px;">int</td> 
   <td style="width:90px;">否</td> 
   <td style="width:132px;">60000</td> 
   <td style="width:384px;">会话超时时间<br> 单位：毫秒</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">connection-timeout-milliseconds</td> 
   <td style="width:87px;">int</td> 
   <td style="width:90px;">否</td> 
   <td style="width:132px;">15000</td> 
   <td style="width:384px;">连接超时时间<br> 单位：毫秒</td> 
  </tr> 
  <tr> 
   <td style="width:155px;">digest</td> 
   <td style="width:87px;">String</td> 
   <td style="width:90px;">否</td> 
   <td style="width:132px;">无验证</td> 
   <td style="width:384px;">连接<code>Zookeeper</code>的权限令牌<br> 缺省为不需要权限验证</td> 
  </tr> 
 </tbody> 
</table>

注：提供一个详细的地址：[https://blog.csdn.net/qinxuefly/article/details/53112649][https_blog.csdn.net_qinxuefly_article_details_53112649]

[https_blog.csdn.net_qinxuefly_article_details_53112649]: https://blog.csdn.net/qinxuefly/article/details/53112649