Host ElasticJob jobs on SchedulerX 2.0

Step 1: Create a namespace and an application

Before you begin, create a namespace and an application in the SchedulerX console. For more information, see Create a namespace and Create an application.

In the SchedulerX console, click Application Management in the left-side navigation pane. In the application list, confirm that your application has been created. You can view details such as the application name, groupId/appKey, version, used/max jobs, and total instances.

Step 2: Add the ElasticJob dependency

In the pom.xml file, add the schedulerx2-plugin-elasticjob dependency above the existing elasticjob dependency.

 <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx2-plugin-elasticjob</artifactId>
     <version>3.0.2.2</version>
</dependency>
<dependency>
    <groupId>org.apache.shardingsphere.elasticjob</groupId>
    <artifactId>elasticjob-lite-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

Step 3: Configure the SchedulerX scheduler

In the application.yml file, add the elasticjob.scheduler=schedulerx configuration item and the spring.schedulerx2 configuration.

elasticjob:
  regCenter:
    serverLists: 127.0.0.1:2181
    namespace: elasticjob-test
  scheduler: schedulerx # Set the scheduler to schedulerx. Otherwise, the native ElasticJob scheduler is used.
  jobs:
    simpleJob:
      elasticJobClass: com.alibaba.elasticjob.test.processor.SpringBootSimpleJob
      cron: 0/10 * * * * ?
      shardingTotalCount: 1
      overwrite: true
    shardingJob:
      elasticJobClass: com.alibaba.elasticjob.test.processor.SpringBootShardingJob
      cron: 0 * * * * ?
      shardingTotalCount: 3
      shardingItemParameters: 0=Beijing,1=Shanghai,2=Guangzhou
      overwrite: true
# Add the following SchedulerX configuration.
spring:
   schedulerx2:
      endpoint: acm.aliyun.com
      namespace: 433d8b23-xxxx-xxxx-xxxx-90d4d1b9a4af
      groupId: xueren_primary
      appKey: xxxxxxxxxxx
      regionId: public
      aliyunAccessKey: xxxxxxxxxxxx
      aliyunSecretKey: xxxxxxxxxxxx

If you need to switch back to the ElasticJob scheduler, you can use JVM -D options to change it at runtime:

-Dspring.schedulerx2.enabled=false -Delasticjob.scheduler=elasticjob

Step 4: Add a component scan to your startup class

The program now automatically scans com.alibaba.schedulerx.plugin.* at startup. The following is a code example:

@SpringBootApplication
@ComponentScan(value = "com.alibaba.elasticjob.*")
@ComponentScan(value = "com.alibaba.schedulerx.test.*")
@ComponentScan(value = "com.alibaba.schedulerx.plugin.*")
public class SpringBootMain {
    // CHECKSTYLE:OFF
    public static void main(final String[] args) throws InterruptedException {
    // CHECKSTYLE:ON
        SpringApplication.run(SpringBootMain.class, args);
    }
}

Step 5 (Optional): Configure the logging service

You can configure a logging service to collect logs from your client. The following example uses log4j2. For more information, see Logging services for SchedulerX.

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="off">
	<Appenders>
		<Console name="Console" target="SYSTEM_OUT">
			<PatternLayout
				pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %m%n" />
		</Console>
		<SchedulerxLog4j2Appender name="schedulerxLog"
            timeFormat="yyyy-MM-dd'T'HH:mmZ"
            timeZone="UTC"
            ignoreExceptions="true">
        <PatternLayout pattern="%d %-5level [%thread] %logger{0}: %msg"/>
    </SchedulerxLog4j2Appender>
	</Appenders>
	<Loggers>
		<Root level="info">
			<AppenderRef ref="Console" />
		</Root>
		<Logger name="schedulerx" level="info" additivity="false">
			<AppenderRef ref="schedulerxLog" />
		</Logger>
	</Loggers>
</Configuration>

The following code provides an example of a Java job class:

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.shardingsphere.elasticjob.api.ShardingContext;
import org.apache.shardingsphere.elasticjob.simple.job.SimpleJob;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import com.alibaba.schedulerx.test.service.HelloService;
@Component
public class SpringBootSimpleJob implements SimpleJob {
    private static final Logger LOGGER = LogManager.getLogger("schedulerx");
    @Autowired
    private HelloService helloService;
    @Override
    public void execute(ShardingContext context) {
        LOGGER.info("jobName:" + context.getJobName() + ", hello:" + helloService.hello());
    }
}

Step 6: Verify the job execution

After starting the application, SchedulerX automatically syncs the jobs to the console. During this process:

• If a cron expression uses a second-level frequency, the time type is converted to second_delay.

• If the sharding count is greater than 1, the job runs in sharding mode. Otherwise, it runs in standalone mode.

You can view the job execution logs directly from the console.

The logs show that the three shards of the job shardingJob executed successfully. Each log entry has a level of INFO and contains shardingItem=0, shardingItem=1, shardingItem=2, and shardingTotal=3, which indicates that the sharding job is running correctly on different instances.