SchedulerX:Spring Boot アプリケーションを SchedulerX に接続する

1.1 基本構成

1.2 通知設定

1. pom.xml ファイルに必要な依存関係を追加します。

   Spring Boot アプリケーションの pom.xml ファイルに必要な SchedulerxWorker 依存関係を追加して、Spring Boot アプリケーションが SchedulerX によって提供される機能を使用できるようにします。

   説明

   SchedulerX は Spring Boot 2.x および 3.x アプリケーションをサポートしています。

   <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx2-spring-boot-starter</artifactId>
     <version>${schedulerx2.version}</version>
     <!-- Logback を使用する場合は、Log4j と Log4j 2 を除外する必要があります。 -->
     <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>                   

   重要

   <version>${schedulerx2.version}</version> を最新のエージェントバージョンに置き換えてください。例: <version>1.11.5</version>。詳細については、「エージェントのリリースノート」をご参照ください。

2. パラメーターの構成

   Spring Boot アプリケーションの application.properties 構成ファイルに、接続情報や認証情報など、SchedulerxWorker に必要なパラメーターを追加します。このようなパラメーターは、Spring Boot アプリケーションが SchedulerX アplication に接続するために必要です。

   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 コンソールにログインします。左側のナビゲーションウィンドウで、[アプリケーション] をクリックします。[アプリケーション] ページで、管理するアプリケーションを見つけ、[操作] 列の [アクセス設定] をクリックします。[アクセス設定] パネルで、ドロップダウンリストから [Spring Boot] を選択します。

   

   重要

   SchedulerX とエージェントが同じリージョンにあるかどうかを確認してください。そうでない場合、エージェントは SchedulerX への接続に失敗します。

   Spring Boot アプリケーションが Alibaba Cloud 以外のサーバーまたはオンプレミス環境で実行されている場合は、Spring Boot アプリケーションへのインターネットアクセスを有効にし、インターネットリージョンに SchedulerX アプリケーションを作成していることを確認してください。詳細については、「オンプレミス環境からインターネット経由で SchedulerX に接続する」をご参照ください。

   説明

   クライアントアプリケーションに複数のサービスが含まれている場合、または権限管理のためにスケジュールされたタスクを分離する必要がある場合は、コンソールで複数のアプリケーションを作成して、詳細な管理を実現できます。たとえば、animals という名前のクライアントアプリケーションの場合、コンソールで animals.dog と animals.cat の 2 つのアプリケーションを作成できます。これら 2 つのアプリケーションに対して個別のワーカーをリクエストする必要はありません。application.properties 構成ファイルで spring.schedulerx2.groupId=${groupId} を構成し、アプリケーション名をカンマで区切ってリストするだけで済みます。例: spring.schedulerx2.groupId=animals.dog,animals.cat。

   パラメーターの説明:

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

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

   • groupId と appKey: アプリケーションの ID とキー。これらの値は、SchedulerX コンソールの [アプリケーション] ページで表示できます。

   • aliyunAccessKey と aliyunSecretKey: Alibaba Cloud アカウントの AccessKey ID と AccessKey Secret。AccessKey ペアは、ユーザー管理コンソールの [セキュリティ管理] ページで表示できます。

   • 次の表に、必要に応じて構成できるパラメーターを示します。

     キー	説明	値	初期バージョン
     spring.schedulerx2.enabled	SchedulerX 2.0 のスターターを有効にするかどうかを指定します。デフォルト値: true。このパラメーターを構成する必要はありません。	true false	0.1.7
     spring.schedulerx2.endpoint	指定されたリージョンのエンドポイント。詳細については、「エンドポイント」をご参照ください。	N/A	0.1.7
     spring.schedulerx2.namespace	名前空間の UID。名前空間の UID は、SchedulerX コンソールの [名前空間] ページで表示できます。	N/A	0.1.7
     spring.schedulerx2.groupId	アプリケーションの ID。アプリケーション ID は、SchedulerX コンソールの [アプリケーション] ページで表示できます。	N/A	0.1.7
     spring.schedulerx2.appKey	アプリケーションのキー。アプリケーションキーは、SchedulerX コンソールの [アプリケーション] ページで表示できます。	N/A	1.2.1
     spring.schedulerx2.host	複数の IP アドレスが存在する場合の実際の IP アドレス。エージェントが VPN または複数のネットワークインターフェイスカード (NIC) を使用している場合、複数の IP アドレスが存在する可能性があります。	N/A	0.1.7
     spring.schedulerx2.port	エージェントがリッスンするポート。ポートを指定しない場合、システムは利用可能なポートをランダムに選択します。	N/A	0.1.7
     spring.schedulerx2.blockAppStart	SchedulerX が初期化を完了できなかった場合に、アプリケーションの起動をブロックするかどうかを指定します。デフォルト値: true。	true false	1.1.0
     spring.schedulerx2.shareContainerPool	エージェント上のすべてのジョブがスレッドプールを共有できるようにするかどうかを指定します。デフォルト値: false。	true false	1.2.1.2
     spring.schedulerx2.sharePoolSize	すべてのジョブがプールを共有できるようにする場合のスレッドプールのサイズ。デフォルト値: 64。	N/A	1.2.1.2
     spring.schedulerx2.label	ラベル。エージェントにラベルを追加して、ラベルを使用してジョブ管理用のワーカーを指定できます。この機能は、カナリアリリースやストレステストシナリオに適しています。	N/A	1.2.2.2
     spring.schedulerx2.enableCgroupMetrics	cgroup を使用してエージェントのメトリックを収集するかどうかを指定します。デフォルト値: false。Kubernetes 環境では、この機能を手動で有効にする必要があります。	true false	1.2.2.2
     spring.schedulerx2.cgroupPathPrefix	コンテナー内の cgroup のパス。	デフォルトのパスは /sys/fs/cgroup/cpu/ です。パスが既に存在する場合、このパラメーターを構成する必要はありません。	1.2.2.2
     spring.schedulerx2.enableHeartbeatLog	${user.home}/logs/schedulerx/heartbeat.log ファイルにハートビートログを表示するかどうかを指定します。 デフォルト値: true。	true false	1.2.4
     spring.schedulerx2.mapMasterStatusCheckInterval	Map モデルですべてのタスクが完了したかどうかを SchedulerX がチェックする間隔。単位: ミリ秒。秒単位のジョブのスケジューリング頻度を上げる場合は、このパラメーターを構成します。	3000	1.2.5.2
     spring.schedulerx2.enableSecondDelayCycleIntervalMs	秒単位のジョブでミリ秒精度を有効にするかどうかを指定します。デフォルト値: false。このパラメーターを true に設定すると、コンソールで指定された秒単位のジョブのスケジューリング間隔は、秒ではなくミリ秒として解釈されます。これにより、ジョブのスケジューリング頻度が向上します。	true false	1.2.5.2
     spring.schedulerx2.broadcastMasterExecEnable	ブロードキャストジョブを実行するためにプライマリノードが必要かどうかを指定します。デフォルト値: true。	true false	1.8.13
     spring.schedulerx2.broadcastDispatchRetryTimes	ブロードキャストが失敗した後の最大リトライ回数。デフォルトでは、リトライは実行されません。リトライ間隔は 2 秒に固定されています。	3	1.8.13
     spring.schedulerx2.enableSecondDelayStandaloneDispatch	秒単位のスタンドアロンジョブのディスパッチを有効にするかどうかを指定します。デフォルト値: false。	true false	1.8.13

3. JobProcessor クラスの作成

   Spring Boot アプリケーションに JobProcessor クラスを作成して、ジョブのスケジューリングを有効にします。

   次のサンプルコードは、単純な JobProcessor クラスをスケジュールして定期的にメッセージを表示する方法を示しています。この例では、メッセージ hello schedulerx2.0 が表示されます。

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

Microservices Engine (MSE) コンソールにログインします。左側のナビゲーションウィンドウで、[タスクスケジューリング] > [SchedulerX バージョン] を選択します。[SchedulerX バージョン] ページで、左側のペインにある [アプリケーション] をクリックします。次に、管理するアプリケーションを見つけ、[操作] 列の [インスタンスの表示] をクリックします。