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>  <!-- Replace with the latest 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 に次のプロパティを追加します。

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

パラメーターソース:

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

パラメーターの説明:

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

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

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

• aliyunAccessKey および aliyunSecretKey: お客様の Alibaba Cloud アカウントの AccessKey ID および AccessKey Secret です。AccessKey ペアは、User 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);  // Return true to indicate success
    }
}

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

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

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

ステップ 5: 接続の検証

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

2. 「MSE SchedulerX コンソール」にログインします。左側のナビゲーションウィンドウで、[アプリケーション] をクリックします。

3. アプリケーションを見つけ、[インスタンスの表示] を [操作] 列でクリックします。

   

4. [インスタンスの総数] 列を確認します:

   • 0: 接続に失敗しました。構成パラメーター (リージョン、エンドポイント、名前空間、および GroupID) を確認し、ネットワーク接続を検証してください。

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

次のステップ

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

トラブルシューティング

関連ドキュメント

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

• 「アラートに関するよくある質問」

• 「Spring ジョブに関するよくある質問」

• 「権限に関するよくある質問」

• 「接続に関するよくある質問」