Microservices Engine:Manage Spring scheduled jobs with 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 dependencies if you use 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>

Regardless of whether you use scheduled Spring jobs for the first time, keep the @EnableScheduling annotation enabled in your main class:

@SpringBootApplication
@EnableScheduling // Enable scheduled Spring jobs
public class SchedulerXWorkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerXWorkerApplication.class, args);
    }
}

@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");
    }
}

Configure SchedulerX to take over Spring jobs

Add the following properties to your application configuration file.

# Application access
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

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

Create a scheduled job manually

1. Log on to the MSE console and go to the SchedulerX Version page.

2. In the left-side navigation pane, click Tasks.

3. On the Tasks page, click Create task. In the Create task panel, select SpringSchedule from the Task type drop-down list and enter the class name and method name.

   Parameter	Description
   Task name	The name of the job.
   Description	A description to help with searching and managing jobs.
   Application ID	The application group that the job belongs to. Select a value from the drop-down list.
   Task type	The job type. Valid values: Java, Shell, Python, Golang, Http, Node.js, XXL-JOB, and DataWorks. Set this to SpringSchedule for Spring scheduled jobs.
   spring scheduleConfiguration	The fully qualified class name and method name of the job.
   Execution mode	How the job runs across the cluster. Stand-alone operation runs the job on one random worker. Broadcast run runs the job on all workers simultaneously, and the system waits until all workers complete the job. The advanced configuration options vary based on the selected execution mode.
   Priority	The job priority within the same application. Higher-priority jobs run first when multiple jobs compete for resources on the same worker. However, if multiple jobs run on different workers, jobs with lower priorities may run first because they are scheduled to different workers. SchedulerX uses preemptible queues to enforce priority ordering. For details, see Application-level throttling through job priority queues.
   Task parameters	A custom string accessible from the job context at runtime.

4. Configure the trigger frequency.

   Note

   The trigger frequency set in the SchedulerX console takes precedence over the @Scheduled annotation in your code. The annotation remains in the code but has no effect once SchedulerX manages the job.

   Parameter	Description
   Time type	The trigger mechanism: none (triggered by a workflow), cron (cron expression), api (triggered by API call), fixed_rate (fixed interval), second_delay (1--60 second delay), one_time (runs once at a specified time).
   cron expression	The cron expression for scheduling. Enter one manually or use the built-in cron generator.
   Fixed frequency	The interval in seconds. Available only when Time type is fixed_rate. Must be greater than 60.
   Fixed delay	The delay in seconds (1--60). Available only when Time type is second_delay.

   The following table describes the advanced timing parameters.

   Parameter	Description
   Time offset	The offset between the data processing timestamp and the job trigger time. Accessible from the job context at runtime.
   Time zone	The time zone for scheduling. Select a country or region, or a GMT offset.
   Calendar	Select Workday or Financial day to apply calendar-based scheduling.

5. Configure alert conditions and notification methods. For details, see Notification contacts and notification contact groups.

After configuration, SchedulerX manages your Spring scheduled jobs with visual management, job log queries, execution chain views, and alert notifications.

Verify the connection

1. Start your Spring application. In the MSE console, go to the SchedulerX Version page and click Applications in the left-side navigation pane. Check the Total number of instances column for your application. A value greater than 0 confirms that the application is connected.

2. In the left-side navigation pane, click Tasks. Find the job for your application and click Run once in the Operation column. A successful execution confirms that the setup is complete.

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";
}