+++ title = “Spring Boot Starter” weight = 2 chapter = true +++

To use the Spring boot, user need to add the dependency of the elasticjob-lite-spring-boot-starter module in the pom.xml file.

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

Registry Center Configuration

Prefix: elasticjob.reg-center

Configuration:

Property name	Required
server-lists	Yes
namespace	Yes
base-sleep-time-milliseconds	No
max-sleep-time-milliseconds	No
max-retries	No
session-timeout-milliseconds	No
connection-timeout-milliseconds	No
digest	No

Reference:

YAML

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

Properties

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

Job Configuration

Prefix: elasticjob.jobs

Configuration:

Property name	Required
elasticJobClass / elasticJobType	Yes
cron	No
timeZone	No
jobBootstrapBeanName	No
sharding-total-count	Yes
sharding-item-parameters	No
job-parameter	No
monitor-execution	No
failover	No
misfire	No
max-time-diff-seconds	No
reconcile-interval-minutes	No
job-sharding-strategy-type	No
job-executor-service-handler-type	No
job-error-handler-type	No
job-listener-types	No
description	No
props	No
disabled	No
overwrite	No

“elasticJobClass” and “elasticJobType” are mutually exclusive.

If cron was configured, the job will be created as a ScheduleJobBootstrap. The Starter will start scheduling when application is ready. Otherwise, the job will be created as a OneOffJobBootstrap with a name specified by “jobBootstrapBeanName”. It requires manual injection and execution.

Reference:

YAML

elasticjob:
  jobs:
    simpleJob:
      elasticJobClass: org.apache.shardingsphere.elasticjob.lite.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.lite.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:

Event Trace Configuration

Prefix: elasticjob.tracing

Property name	Options	Required	Description
type	RDB	No
includeJobNames		No	allow list of job
excludeJobNames		No	block list of job

“includeJobNames” and “excludeJobNames” are mutually exclusive.

Load all Job When “includeJobNames” and “excludeJobNames” are null.

RDB is the only supported type at present. If Spring IoC container contained a bean of DataSource and RDB was set in configuration, an instance of TracingConfiguration will be created automatically.

Reference:

YAML

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

Properties

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

Dump Job Info Configuration

Prefix: elasticjob.dump

Property name	Default value	Required
enabled	true	No
port		Yes

Designate a port as dump port in configurations. The Spring Boot Starter will enable dumping automatically. If the port for job dump was missing, dump won't be enabled.

Reference:

YAML

elasticjob:
  dump:
    port: 9888

Properties

elasticjob.dump.port=9888