Spring scheduled jobs

Step 1: Add pom dependency

For a Spring Boot application, add the following dependency to the pom.xml file.

Set schedulerx2.version to the latest agent version. For more information, see Agent release notes.

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>${schedulerx2.version}</version>
  <!-- If you use Logback, you must exclude the Log4j and Log4j2 dependencies -->
  <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>

@SpringBootApplication
@EnableScheduling /** Enable Spring scheduled jobs */
public class SchedulerXWorkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerXWorkerApplication.class, args);
    }
}
/** A native Spring scheduled job class */
@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");
    }
}

Step 3: Create a scheduled job manually (optional)

1. Log on to the MSE SchedulerX console.

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

3. On the Task Management page, click Add Task. Select the SpringSchedule task type, and configure the class name and method name for the scheduled job.

   Parameter	Description
   Task name	The name of the job.
   Description	A brief description of the job to simplify searching and management.
   Application ID	The application group to which the job belongs. Select a value from the drop-down list.
   Task Type	The language in which the job is implemented. Supported types include Java, Shell, Python, Go, HTTP, Node.js, XXL-JOB, and DataWorks. For Shell, Python, and Go, an editor appears where you can write the job script. In this topic, the task type is SpringSchedule.
   Spring Schedule configuration	The fully qualified class name and the method name of the scheduled job.
   Execution Mode	The mode in which the job is executed. The following modes are supported: Stand-alone operation: Runs on one randomly selected machine. Broadcast run: Runs on all machines at the same time and waits for all of them to finish. Note The parameters in the advanced settings vary depending on the selected execution mode.
   Priority	When multiple jobs in the same application run on the same instance, jobs with a higher priority are executed first. However, if jobs are distributed across multiple instances, a lower-priority job might be executed first if it is scheduled to a different instance. SchedulerX prevents this using a preemptible priority queue, which ensures that high-priority jobs in the queue are always executed first. For more information, see Use job priority queues for application-level rate limiting.
   Task Parameters	You can retrieve these parameters from the job context at runtime.

4. Configure the trigger frequency.

   Note

   The frequency configured in the console takes precedence. The configuration in the native @Scheduled annotation in your Spring scheduled job code is ignored, but you must keep the annotation in the code.

   The time parameters are described as follows:

   Parameter	Description
   Time type	none: No scheduling type. Usually triggered by a workflow. cron: A cron expression. api: Triggered by an API call. fixed_rate: A fixed frequency. second_delay: A fixed delay in seconds. one_time: A one-time job.
   cron expression (for cron type only)	Enter a cron expression. You can either enter it directly or use a tool to generate and validate it.
   Fixed frequency (for fixed_rate type only)	The minimum supported frequency is 60 seconds. For example, a value of 200 schedules the job to run every 200 seconds.
   Fixed delay (for second_delay type only)	Valid values are 1 to 60. For example, a value of 5 triggers the job after a 5-second delay.

   The advanced configuration parameters are described as follows:

   Parameter	Description
   Data Timestamp Offset	This value can be retrieved from the job context during scheduling.
   Time zone	You can select a time zone based on your needs, including common countries or regions, as well as standard GMT formats.
   Calendar	Select Workday or Financial day.

5. Set alert conditions and notification channels. For more information about notification channels, see Notification contacts.

   After you complete these steps, the SchedulerX platform takes over and runs your Spring scheduled jobs. You can use enterprise-grade features such as visual management, job log queries, execution tracing, and alert notifications.