SchedulerX:Connect a Spring Boot application to SchedulerX

Procedure

To connect a Spring Boot application to SchedulerX, perform the following steps:

1. Add dependencies to the pom.xml file: After you add the dependencies, the Spring Boot application can use the features provided by SchedulerX.

2. Configure parameters: In the properties or yml file, configure the parameters required for SchedulerXWorker to connect to the specified SchedulerX application.

3. Create a job class: Create one or more JobProcessor classes in the application to implement specific job logic so that SchedulerX can schedule and manage jobs.

Prerequisites

• Optional. A namespace is created. For more information, see Create a namespace.

• One or more resources are created. For more information, see Create resources.

• A Spring Boot application is created.

Step 1: Add dependencies to the pom.xml file

Add SchedulerxWorker dependencies to the pom.xml file of the Spring Boot application to allow the Spring Boot application to use the features provided by SchedulerX.

<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>                   

Step 2: Configure parameters

In the application.properties configuration file of the Spring Boot application, add parameters required by SchedulerXWorker, such as connection information and authentication information. Such parameters are required for the Spring Boot application to connect to the SchedulerX application.

spring.schedulerx2.endpoint=${endpoint}
spring.schedulerx2.namespace=${namespace}
spring.schedulerx2.groupId=${groupId}
# If your agent version is 1.2.1 or later, you must specify the application key.
spring.schedulerx2.appKey=${appKey}

# If your agent version is earlier than 1.2.1, you must specify an AccessKey ID and an AccessKey secret. To enable other special configurations, such as defining job synchronization and automatic synchronization of Spring jobs in the configuration file, you must configure the following parameters.
#spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
#spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey}                  

Parameter sources

1. Log on to the SchedulerX console. In the left-side navigation pane, click Application Management. On the Application Management page, find the application that you want to manage and click Access configuration in the Operation column. In the Access configuration panel, select Spring Boot from the drop-down list.

   

   

   Important

   Check whether SchedulerX and the agent are in the same region. If not, the agent fails to connect to SchedulerX.

   Note

   If an application contains multiple services or you want to classify the Cron jobs of an application, you can create multiple groups. For example, you created groups animals.dogs and animals.cats for the application animals. In this case, you do not need to separately add workers to the two groups. You can append the two groups to groupId= in the configurations of the agent. Example: groupId=animals.dogs,animals.cats.

2. The following list describes the parameters in the sample code.

   • endpoint: the endpoint of SchedulerxWorker. The value of this parameter must match the endpoint of the region in which your application is deployed. For more information, see Endpoints.

   • namespace: the ID of the namespace to which the application belongs. You can view the namespace ID on the Namespace page of the SchedulerX console.

   • groupId and appKey: the ID and the key of the application. You can view the values on the Application Management page of the SchedulerX console.

   • aliyunAccessKey and aliyunSecretKey: the AccessKey ID and the AccessKey secret of your Alibaba Cloud account. You can view the AccessKey pair on the Security Management page of the User Management console.

The following table describes the parameters that you can configure based on your business requirements.

Step 3: Create a job class

Enable job scheduling for the Spring Boot application

package com.aliyun.schedulerx.test.job;

import com.alibaba.schedulerx.worker.domain.JobContext;
import com.alibaba.schedulerx.worker.processor.JavaProcessor;
import com.alibaba.schedulerx.worker.processor.ProcessResult;

@Component
public class MyHelloJob extends JavaProcessor {

    @Override
    public ProcessResult process(JobContext context) throws Exception {
        System.out.println("hello schedulerx2.0");
        return new ProcessResult(true);
    }
}              

Verify the result

FAQ

• For more information about the frequently asked questions (FAQ) on SchedulerX, see Index.

• For more information about how to handle alerts when you use SchedulerX, see FAQ about alerts.

• For more information about how to connect Spring jobs to SchedulerX, see FAQ about Spring jobs.

• For more information about the permissions and connection issues of SchedulerX, see FAQ about permissions and FAQ about connections.

References

• For more information about the terms of SchedulerX, see Terms.