SchedulerX:Integrate Spring jobs with SchedulerX

Step 1: Add the dependency

In a Spring Boot application, add the SchedulerX dependency to your pom.xml file.

Use the latest agent version for schedulerx2.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 Log4j and Log4j2. -->
  <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 (Optional): Manually create a task

1. Log on to the SchedulerX console.

2. In the left-side navigation pane, click task management.

3. On the task management page, click Create Task. Select SpringSchedule as the task type and configure the class and method name.

   Parameter	Description
   Name	A unique name to identify the task.
   Description	An optional description to help you search for and manage the task.
   Application ID	The application group that the task belongs to. Select an option from the drop-down list.
   Job Type	The processor type for the task. Valid values: Java, Shell, Python, Go, HTTP, Node.js, SpringSchedule, XXL-JOB, and DataWorks. If you select Shell, Python, or Go, a script editor appears. For this tutorial, select SpringSchedule.
   Spring Schedule Configuration	The fully qualified class name and method name of the task.
   Execution Mode	Specifies how the task is executed across multiple instances. The following modes are supported: Stand-alone operation: Runs the task on a randomly selected instance. Broadcast run: Runs the task on all instances simultaneously. Note The advanced settings change based on the selected execution mode.
   Priority	If multiple tasks within the same application are ready to run on the same instance, the task with the higher priority runs first. SchedulerX uses a preemptible priority queue to ensure high-priority tasks are executed first, even across different instances. For more information, see Application-level Throttling with a Priority Queue.
   Job Parameters	A custom string that can be retrieved from the job context at runtime.

4. Configure the schedule.

   Note

   The schedule configured in the console overrides the schedule specified in the @Scheduled annotation in your code. However, you must keep the annotation in your code.

   The following table describes the time-based parameters.

   Parameter	Description
   Time Type	none: The task is not scheduled and is typically triggered by a workflow. cron: The task is scheduled using a cron expression. api: The task is triggered by an API call. fixed_rate: The task is triggered at a fixed frequency. second_delay: The task is triggered after a fixed delay in seconds. one_time: The task runs only once.
   Cron Expression (for cron time type only)	Enter a standard cron expression. You can also use the built-in tool to generate and validate the expression.
   Fixed frequency (for fixed_rate time type only)	Enter the interval in seconds. The value must be greater than or equal to 60. For example, a value of 200 means the task runs every 200 seconds.
   Fixed delay (for second_delay time type only)	Enter the delay in seconds. The value must be from 1 to 60. For example, a value of 5 means the task is triggered 5 seconds after the scheduled time.

   The following table describes the advanced configuration parameters.

   Parameter	Description
   Data Timestamp Offset	The offset between the data timestamp and the schedule time. You can retrieve this value from the job context at runtime.
   Time Zone	Select a time zone based on your business requirements. Both regional and standard GMT time zones are supported.
   Calendar	You can select a calendar, such as a workday or financial day calendar, to restrict task execution to specific days.

5. Set alert rules and notification channels. For more information, see Manage Notification Contacts.

   After you complete these steps, SchedulerX manages your Spring jobs and provides enterprise-grade capabilities, such as visual monitoring, log queries, execution tracing, and alerting.