Spring Boot应用接入SchedulerX

方案概览

将Spring Boot应用快速接入SchedulerX分为以下几步：

1. 在pom.xml增加依赖配置：添加依赖后，Spring Boot应用即可使用SchedulerX提供的功能。

2. 配置参数：在properties或者yml中配置SchedulerXWorker所需要的参数，连接指定的SchedulerX应用。

3. 创建任务处理类：在应用中创建一个或多个JobProcessor类，用于实现具体的任务逻辑处理，以便SchedulerX能够对其进行调度和管理。

视频演示

前提条件

• （可选）已创建命名空间。具体操作，请参见创建命名空间。

• 已创建资源。具体操作，请参见创建资源。

• 已创建SpringBoot应用。

步骤一：在pom.xml增加依赖配置

在SpringBoot应用程序的pom.xml文件中添加SchedulerxWorker依赖，以便在Spring Boot应用程序中使用SchedulerX提供的功能。

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>${schedulerx2.version}</version>
  <!--如果使用logback，需要将log4j和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>                   

步骤二：配置参数

在SpringBoot应用的配置文件application.properties中添加SchedulerXWorker所需要的参数，例如连接信息、认证信息等，以便连接到SchedulerX应用。

spring.schedulerx2.endpoint=${endpoint}
spring.schedulerx2.namespace=${namespace}
spring.schedulerx2.groupId=${groupId}
# 1.2.1及以上版本设置appKey
spring.schedulerx2.appKey=${appKey}

# 1.2.1以下版本设置AK/SK，开启其他特殊配置（例如配置文件定义任务同步、Spring任务自动同步）也需要额外配置以下参数
#spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
#spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey}                  

参数来源

1. 登录分布式任务调度平台，在应用管理 > 接入配置中，选择接入的服务类型为Spring Boot。

   

   

   重要

   检查SchedulerX地域和客户端地域是否保持一致，否则会造成建立连接失败。

   说明

   如果一个应用包含多个业务，或者需要将定时任务进行归类，可以建立多个分组。例如，应用animals新建了两个分组animals.dogs和animals.cats，此时无需申请两批实例分别接入这两个分组，在应用客户端中将这两个分组配置到groupId=后面即可，例如groupId=animals.dogs,animals.cats。

2. 示例代码中的参数说明如下。

   • endpoint：初始化SchedulerxWorker时，将使用您部署应用的地域（Region）和对应的endpoint。更多信息，请参见Endpoint列表。

   • namespace：命名空间ID，可以在控制台的命名空间页面获取。

   • groupId和appKey：groupId应用ID，appKey为应用key，可以在控制台应用管理页面获取。

   • aliyunAccessKey和aliyunSecretKey：aliyunAccessKey为阿里云账号的AccessKeyID，aliyunSecretKey为阿里云账号的AccessKeySecret。您可以登录用户信息管理控制台，在安全信息管理页面获取。

其它需求请参考下表中的参数进行配置。

步骤三：创建任务处理类

在SpringBoot中实现调度

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);
    }
}              

结果验证

常见问题

• SchedulerX常见问题汇总，请参见索引。

• 使用SchedulerX时，对于报警信息的处理，请参见报警常见问题。

• Spring任务接入SchedulerX任务调度中的常见问题，请参见Spring任务问题。

• 使用SchedulerX中的权限和接入问题，请参见权限问题和接入问题。

相关文档

• 如果你想了解SchedulerX相关名词解释，详情请参见名词解释。