Spring Boot Starter :: ElasticJob

ElasticJob > 用户手册 > 配置手册 > Spring Boot Starter

使用 Spring-boot 需在 pom.xml 文件中添加 elasticjob-spring-boot-starter 模块的依赖。

<dependency>
    <groupId>org.apache.shardingsphere.elasticjob</groupId>
    <artifactId>elasticjob-spring-boot-starter</artifactId>
    <version>${latest.release.version}</version>
</dependency>

注册中心配置

配置前缀：elasticjob.reg-center

可配置属性：

属性名	是否必填
server-lists	是
namespace	是
base-sleep-time-milliseconds	否
max-sleep-time-milliseconds	否
max-retries	否
session-timeout-milliseconds	否
connection-timeout-milliseconds	否
digest	否

配置格式参考：

YAML

elasticjob:
  regCenter:
    serverLists: localhost:6181
    namespace: elasticjob-springboot

Properties

elasticjob.reg-center.namespace=elasticjob-springboot
elasticjob.reg-center.server-lists=localhost:6181

作业配置

配置前缀：elasticjob.jobs

可配置属性：

属性名	是否必填
elasticJobClass / elasticJobType	是
cron	否
timeZone	否
jobBootstrapBeanName	否
sharding-total-count	是
sharding-item-parameters	否
job-parameter	否
monitor-execution	否
failover	否
misfire	否
max-time-diff-seconds	否
reconcile-interval-minutes	否
job-sharding-strategy-type	否
job-executor-service-handler-type	否
job-error-handler-type	否
job-listener-types	否
description	否
props	否
disabled	否
overwrite	否

elasticJobClass 与 elasticJobType 互斥，每项作业只能有一种类型

如果配置了 cron 属性则为定时调度作业，Starter 会在应用启动时自动启动；否则为一次性调度作业，需要通过 jobBootstrapBeanName 指定 OneOffJobBootstrap Bean 的名称，在触发点注入 OneOffJobBootstrap 的实例并手动调用 execute() 方法。

配置格式参考：

YAML

elasticjob:
  jobs:
    simpleJob:
      elasticJobClass: org.apache.shardingsphere.elasticjob.kernel.example.job.SpringBootSimpleJob
      cron: 0/5 * * * * ?
      timeZone: GMT+08:00
      shardingTotalCount: 3
      shardingItemParameters: 0=Beijing,1=Shanghai,2=Guangzhou
    scriptJob:
      elasticJobType: SCRIPT
      cron: 0/10 * * * * ?
      shardingTotalCount: 3
      props:
        script.command.line: "echo SCRIPT Job: "
    manualScriptJob:
      elasticJobType: SCRIPT
      jobBootstrapBeanName: manualScriptJobBean
      shardingTotalCount: 9
      props:
        script.command.line: "echo Manual SCRIPT Job: "

Properties

elasticjob.jobs.simpleJob.elastic-job-class=org.apache.shardingsphere.elasticjob.kernel.example.job.SpringBootSimpleJob
elasticjob.jobs.simpleJob.cron=0/5 * * * * ?
elasticjob.jobs.simpleJob.timeZone=GMT+08:00
elasticjob.jobs.simpleJob.sharding-total-count=3
elasticjob.jobs.simpleJob.sharding-item-parameters=0=Beijing,1=Shanghai,2=Guangzhou
elasticjob.jobs.scriptJob.elastic-job-type=SCRIPT
elasticjob.jobs.scriptJob.cron=0/5 * * * * ?
elasticjob.jobs.scriptJob.sharding-total-count=3
elasticjob.jobs.scriptJob.props.script.command.line=echo SCRIPT Job:
elasticjob.jobs.manualScriptJob.elastic-job-type=SCRIPT
elasticjob.jobs.manualScriptJob.job-bootstrap-bean-name=manualScriptJobBean
elasticjob.jobs.manualScriptJob.sharding-total-count=3
elasticjob.jobs.manualScriptJob.props.script.command.line=echo Manual SCRIPT Job:

事件追踪配置

配置前缀：elasticjob.tracing

属性名	可选值	是否必填	描述
type	RDB	否
includeJobNames		否	作业白名单
excludeJobNames		否	作业黑名单

includeJobNames 与 excludeJobNames 互斥，事件追踪配置只能有一种属性

includeJobNames 与 excludeJobNames 都为空时，默认为所有作业加载事件追踪

目前仅提供了 RDB 类型的事件追踪数据源实现。 Spring IoC 容器中存在 DataSource 类型的 bean 且配置数据源类型为 RDB 时会自动配置事件追踪，无须显式创建。

配置格式参考：

YAML

elasticjob:
  tracing:
    type: RDB
    excludeJobNames: [ job-name-1, job-name-2 ]

Properties

elasticjob.tracing.type=RDB
elasticjob.tracing.excludeJobNames=[ job-name ]

作业信息导出配置

配置前缀：elasticjob.dump

属性名	缺省值	是否必填
enabled	true	否
port		是

Spring Boot 提供了作业信息导出端口快速配置，只需在配置中指定导出所用的端口号即可启用导出功能。如果没有指定端口号，导出功能不会生效。

配置参考：

YAML

elasticjob:
  dump:
    port: 9888

Properties

elasticjob.dump.port=9888