Connect a Spring Boot application to SchedulerX

Video demo

For a video demonstration of how to connect a Spring Boot application to SchedulerX, see Video demo.

Prerequisites

Before you begin, make sure you have:

• A Spring Boot 2.x or 3.x project

• (Optional) A namespace for resource isolation -- see the "Create a namespace" section of Namespace management

Step 1: Create a SchedulerX application

Step 2: Add the SchedulerX dependency

Add the schedulerx2-spring-boot-starter dependency to the pom.xml file of your Spring Boot project:

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>1.11.5</version>  <!-- Replace with the latest version -->
</dependency>

If your project uses Logback, exclude the bundled Log4j dependencies:

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>1.11.5</version>
  <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 3: Configure connection parameters

Add the following properties to application.properties:

# Required: SchedulerX connection settings
spring.schedulerx2.endpoint=${endpoint}
spring.schedulerx2.namespace=${namespace}
spring.schedulerx2.groupId=${groupId}
# The appKey parameter is supported only in versions 1.2.1 and later.
spring.schedulerx2.appKey=${appKey}

# If you do not use an appKey, you can use an Alibaba Cloud AccessKey and SecretKey, or an STS token.
#spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
#spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey}
#spring.schedulerx2.stsToken=${aliyunStsToken}

Parameter sources:

Log in to the SchedulerX console. In the left-side navigation pane, click Applications. Find the application that you want to manage and click AccessConfig in the Operation column. In the AccessConfig panel, select Spring Boot from the dropdown.

Parameter description:

• endpoint: The endpoint of SchedulerxWorker. The value 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 Namespaces page of the SchedulerX console.

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

• aliyunAccessKey and aliyunSecretKey: The AccessKey ID and AccessKey secret of your Alibaba Cloud account.

If the application uses YAML, add these settings to application.yml instead:

spring:
  schedulerx2:
    endpoint: ${endpoint}
    namespace: ${namespace}
    groupId: ${groupId}
    appKey: ${appKey}

Step 4: Create a job processor

Create a class that extends JavaProcessor to define job logic. The following example prints a message on each run:

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;
import org.springframework.stereotype.Component;

@Component
public class MyHelloJob extends JavaProcessor {

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

• @Component registers the class as a Spring bean so SchedulerX can discover it.

• Extend JavaProcessor and override process to define the job logic.

• Return new ProcessResult(true) for success or new ProcessResult(false) for failure.

Step 5: Verify the connection

1. Start your Spring Boot application.

2. Log in to the MSE SchedulerX console. In the left-side navigation pane, click Applications.

3. Find your application and click View instances in the Operation column.

   

4. Check the Total number of instances column:

   • 0: The connection failed. Check your configuration parameters (region, endpoint, namespace, and GroupID) and verify network connectivity.

   • Greater than 0: The connection succeeded.

What to do next

After the connection is verified, create a job in the SchedulerX console to trigger your job processor. See the "Create a job" section of Job management.

Troubleshooting

See also

• Connect an agent to SchedulerX -- other connection methods (non-Spring Boot)

• FAQ about alerts

• FAQ about Spring jobs

• FAQ about permissions

• FAQ about connections