SchedulerX:Spring jobs

Step 1: Add a dependency to the pom.xml file

Add a dependency and a main class to the pom.xml file of the application. In this example, a Spring Boot application is used.

Replace schedulerx2.version with the latest version of the SchedulerX agent. 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 scheduled Spring jobs.*/
public class SchedulerXWorkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerXWorkerApplication.class, args);
    }
}

/** Native scheduled Spring 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 scheduled job

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. Set Task type to SpringSchedule, and configure a class name and a method name.

   Parameter	Description
   Task name	The name of the job that you want to create.
   Description	The description of the job. Specify a concise and clear description to facilitate job search and management.
   Application ID	The group to which the job belongs. Select a value from the drop-down list.
   Task type	The programming language that you want to use to create the job. Valid values include Java, Shell, Python, Golang, Http, Node.js, XXL-JOB, and DataWorks. When you select Shell, Python, or Golang, an editor is displayed. You can enter a script in the editor. In this example, this parameter is set to SpringSchedule.
   spring scheduleConfiguration	The complete class name and method name of the job.
   Execution mode	The mode in which the job is run. The following execution modes are supported: Stand-alone operation: The job is run on a random worker. Broadcast run: The job is concurrently run on all workers, and the system waits until all workers complete the job. Note The parameters in the Advanced Configuration section vary based on the selected execution mode.
   Priority	If multiple jobs of the same application run on the same worker at the same time, jobs with high priorities are run first. However, if multiple jobs of the same application run on multiple workers, jobs with different priorities are scheduled to different workers. In this case, jobs with low priorities may be run first. SchedulerX uses preemptible queues to avoid this issue and ensure that a job with a higher priority in a queue is triggered first. For more information, see Preemptible queues.
   Task parameters	A random string that can be obtained from the context when SchedulerX runs the job.

4. Configure the trigger frequency.

   Note

   The frequency that is specified in the SchedulerX console prevails, and the configuration of the native annotation @Scheduled in the code of the scheduled Spring job becomes invalid. However, the annotation is retained in the code.

   The following table describes the parameters.

   Parameter	Description
   Time type	none: The job is triggered by using a workflow. cron: The job is scheduled based on a cron expression. api: The job is triggered by calling an API operation. fixed_rate: The job is triggered at a specified interval. second_delay: The job is triggered with a delay from 1 to 60 seconds. one_time: The job is triggered only once at the specified point in time.
   cron expression	The cron expression based on which the job is scheduled. You can manually enter a cron expression based on the cron syntax. You can also use the tool provided by SchedulerX to automatically generate a valid cron expression.
   Fixed frequency	The interval at which the job is triggered. This parameter is available only if the Task type parameter is set to fixed_rate. The value must be greater than 60. Unit: seconds. For example, a value of 200 indicates that the job is triggered at an interval of 200 seconds.
   Fixed delay	The fixed delay. This parameter is available only if the Task type parameter is set to second_delay. Valid values: 1 to 60. Unit: seconds. For example, the value 5 indicates that the job is triggered with a delay of 5 seconds.

   The following table describes the advanced timing configurations.

   Parameter	Description
   Time offset	Specify the offset between the timestamp of the data to be processed and the time when the job is triggered. You can obtain the offset value from the context when SchedulerX runs the job.
   Time zone	Select the time zone of a country or region or select a GMT time zone based on your business requirements.
   Calendar	Select Workday or Financial day.

5. Configure alert conditions and notification methods. For more information about the notification methods, see Notification contacts and notification contact groups.

   After you complete the configurations, SchedulerX can run scheduled Spring jobs. The console also provides native Spring jobs with enterprise-level O&M capabilities, including visualized management and control, job log query, execution chain view, and job execution notification and alerting.