SchedulerX:Spring jobs

How it works

SchedulerX replaces the default Spring task scheduler with its own scheduling engine:

1. Add the SchedulerX Spring Boot starter dependency to your project.

2. Set spring.schedulerx2.task.scheduling.scheduler=schedulerx in your application properties.

3. SchedulerX takes control of all @Scheduled methods and manages their execution through the console.

After takeover, the SchedulerX console controls scheduling frequency. The cron expressions in your @Scheduled annotations remain in the code but no longer determine when jobs run.

Execution modes:

Auto-synchronized jobs default to Broadcast run to preserve native Spring behavior. To run a job on only one node, change the Execution mode to Stand-alone operation in the console.

Prerequisites

• SchedulerX agent version 1.8.13 or later

• A Spring Boot application connected to SchedulerX. For setup instructions, see Connect a Spring Boot application to SchedulerX

Add the Maven dependency

Add the schedulerx2-spring-boot-starter dependency to your pom.xml. Replace schedulerx2.version with the latest version from the agent release notes.

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>${schedulerx2.version}</version>
  <!-- Exclude Log4j if your application uses Logback -->
  <exclusions>
    <exclusion>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
    </exclusion>
    <exclusion>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
    </exclusion>
    <exclusion>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
    </exclusion>
  </exclusions>
</dependency>

Keep @EnableScheduling in your main class regardless of whether SchedulerX handles scheduling:

@SpringBootApplication
@EnableScheduling // Required -- do not remove
public class SchedulerXWorkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerXWorkerApplication.class, args);
    }
}

Existing @Scheduled job classes need no changes:

@Service
public class SpringScheduledProcessor {
    @Scheduled(cron = "0/2 * * * * ?")
    public void hello() {
        logger.info(DateUtil.now() + " hello world. start");
        logger.info(DateUtil.now() + " hello world. end");
    }
}

Adding the dependency alone does not change job behavior. SchedulerX does not take over Spring scheduled jobs by default -- they continue running in the Spring container until you enable takeover in the next step.

Configure SchedulerX takeover

Add these properties to your application.properties file:

# Connect to SchedulerX
spring.schedulerx2.endpoint=${endpoint}
spring.schedulerx2.namespace=${namespace}
spring.schedulerx2.groupId=${groupId}
spring.schedulerx2.appKey=${appKey}

# Enable SchedulerX to take over Spring scheduled jobs
spring.schedulerx2.task.scheduling.scheduler=schedulerx

To get the connection parameters (endpoint, namespace, groupId, appKey):

1. Log on to the SchedulerX console.

2. In the left-side navigation pane, click Application Management.

3. Find your application and click Access configuration in the Operation column.

If you have not created an application in SchedulerX yet, create one before proceeding.

# Enable automatic job synchronization
spring.schedulerx2.task.scheduling.sync=true
spring.schedulerx2.regionId=<region-id>
spring.schedulerx2.aliyunAccessKey=<your-access-key>
spring.schedulerx2.aliyunSecretKey=<your-secret-key>

Verify the connection

1. Start your Spring Boot application.

2. Log on to the SchedulerX console.

3. In the left-side navigation pane, click Application Management.

4. Check the Total number of instances column for your application. A value greater than 0 confirms the connection.

1. In the left-side navigation pane, click Task Management.

2. Find your job and click Run once in the Operation column.

3. Verify that the job runs successfully.

After verification, SchedulerX provides enterprise-level capabilities for your Spring jobs, including visualized management and control, log queries, execution chain tracing, and alerting.

FAQ

JobContext jobContext = ContainerFactory.getContainerPool().getContext();

@Scheduled(cron = "0/5 * * * * ?")
public ProcessResult helloStandalone1() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return new ProcessResult(true, "Processing result");
}

@Scheduled(cron = "0/5 * * * * ?")
public String helloStandalone2() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return "Processing result";
}

JobContext jobContext = ContainerFactory.getContainerPool().getContext();

@Scheduled(cron = "0/5 * * * * ?")
public ProcessResult helloStandalone1() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return new ProcessResult(true, "Processing result");
}

@Scheduled(cron = "0/5 * * * * ?")
public String helloStandalone2() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return "Processing result";
}