SchedulerX:Spring Boot アプリケーションの SchedulerX への接続

前提条件

開始する前に、以下をご確認ください。

• Spring Boot 2.x または 3.x のプロジェクト

• (オプション) リソース分離のための名前空間。詳細については、「名前空間の管理」の「名前空間の作成」セクションをご参照ください。

ステップ 1：SchedulerX アプリケーションの作成

ステップ 2：SchedulerX 依存関係の追加

Spring Boot プロジェクトの pom.xml ファイルに schedulerx2-spring-boot-starter の依存関係を追加します。

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>1.11.5</version>  <!-- 最新バージョンに置き換えてください -->
</dependency>

プロジェクトが Logback を使用している場合は、バンドルされている Log4j の依存関係を除外します。

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

ステップ 3：接続パラメーターの構成

application.properties ファイルに以下のプロパティを追加します。

# 必須: SchedulerX 接続設定
spring.schedulerx2.endpoint=${endpoint}
spring.schedulerx2.namespace=${namespace}
spring.schedulerx2.groupId=${groupId}
# appKey パラメーターはバージョン 1.2.1 以降でのみサポートされます。
spring.schedulerx2.appKey=${appKey}

# appKey を使用しない場合は、Alibaba Cloud AccessKey と SecretKey、または STS トークンを使用できます。
#spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
#spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey}
#spring.schedulerx2.stsToken=${aliyunStsToken}

パラメーターの取得方法：

SchedulerX コンソールにログインします。左側のナビゲーションペインで [Applications] をクリックします。管理したいアプリケーションを見つけ、[Operation] 列の [AccessConfig] をクリックします。[AccessConfig] パネルで、ドロップダウンから [Spring Boot] を選択します。

パラメーターの説明：

• endpoint：SchedulerxWorker のエンドポイントです。値は、アプリケーションがデプロイされているリージョンのエンドポイントと一致する必要があります。詳細については、「エンドポイント」をご参照ください。

• [名前空間]: アプリケーションが属する名前空間の ID です。名前空間 ID は、SchedulerX コンソールの [名前空間] ページで確認できます。

• groupId と appKey: アプリケーションの ID とキーです。SchedulerX コンソールの [アプリケーション] ページで確認できます。

• aliyunAccessKey と aliyunSecretKey：Alibaba Cloud アカウントの AccessKey ID と AccessKey シークレットです。AccessKey ペアは、ユーザー管理コンソールの [Security Management] ページで確認できます。

アプリケーションが YAML を使用している場合は、代わりにこれらの設定を application.yml ファイルに追加します。

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

ステップ 4：ジョブプロセッサーの作成

JavaProcessor を継承するクラスを作成して、ジョブのロジックを定義します。次の例では、実行ごとにメッセージを出力します。

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);  // 成功したことを示すために true を返します
    }
}

• @Component はクラスを Spring Bean として登録し、SchedulerX がそれを検出できるようにします。

• JavaProcessor を継承し、process をオーバーライドしてジョブのロジックを定義します。

• 成功の場合は new ProcessResult(true) を、失敗の場合は new ProcessResult(false) を返します。

ステップ 5：接続の確認

1. Spring Boot アプリケーションを起動します。

2. MSE SchedulerX コンソールにログインします。左側のナビゲーションペインで [Applications] をクリックします。

3. アプリケーションを見つけ、[Operation] 列の [View instances] をクリックします。

   

4. [Total number of instances] 列を確認します。

   • 0：接続に失敗しました。設定パラメーター (リージョン、エンドポイント、名前空間、GroupID) とネットワーク接続を確認してください。

   • 0 より大きい場合：接続に成功しました。

次のステップ

接続が確認できたら、SchedulerX コンソールでジョブを作成してジョブプロセッサーをトリガーします。「ジョブの管理」の「ジョブの作成」セクションをご参照ください。

トラブルシューティング

関連ドキュメント

• エージェントの SchedulerX への接続 (Spring Boot 以外の接続方法)

• アラートに関する FAQ

• Spring ジョブに関する FAQ

• 権限に関する FAQ

• 接続に関する FAQ