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

1.1 基本設定

1.2 通知設定

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

   必要な SchedulerxWorker 依存関係を Spring Boot アプリケーションの pom.xml ファイルに追加して、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 アプリケーションに接続するために必要です。

   spring.schedulerx2.endpoint=${endpoint}
   spring.schedulerx2.namespace=${namespace}
   spring.schedulerx2.groupId=${groupId}
   # エージェントのバージョンが 1.2.1 以後の場合は、アプリケーションキーを指定する必要があります。
   spring.schedulerx2.appKey=${appKey}
   
   # エージェントのバージョンが 1.2.1 より前の場合は、アクセスキー ID とアクセスキーシークレットを指定する必要があります。ジョブの同期や設定ファイルでの Spring ジョブの自動同期の定義など、その他の特別な設定を有効にするには、次のパラメーターを設定する必要があります。
   #spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
   #spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey}                  

   パラメーターソース:

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

   

   重要

   SchedulerX とエージェントが同じリージョンにあるかどうかを確認します。そうでない場合、エージェントは SchedulerX に接続できません。

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

   説明

   Spring Boot アプリケーションに複数のサービスモジュールが含まれている場合、または権限管理のために CRON ジョブを分離する場合は、SchedulerX コンソールで複数のアプリケーションを作成して、CRON ジョブのきめ細かい管理を実装できます。たとえば、SchedulerX コンソールでアプリケーション animals 用にアプリケーション animals.dog と animals.cat が作成されます。この場合、2 つのアプリケーションのワーカーを個別に申請する必要はありません。代わりに、application.properties 設定ファイルで spring.schedulerx2.groupId=${groupId} を指定するだけです。${groupId} をアプリケーション名に置き換えます。複数のアプリケーション名はコンマ (,) で区切ります。例: spring.schedulerx2.groupId=animals.dog,animals.cat。

   パラメーターの説明:

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

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

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

   • aliyunAccessKey と aliyunSecretKey: Alibaba Cloud アカウントのアクセスキー ID とアクセスキーシークレット。ユーザー管理 コンソールの [セキュリティ管理] ページでアクセスキーペアを確認できます。

   • 次の表では、ビジネス要件に基づいて設定できるパラメーターについて説明します。

     パラメーター	説明	値	初期バージョン
     spring.schedulerx2.enabled	SchedulerX 2.0 のスターターを有効にするかどうかを指定します。デフォルト値: true。このパラメーターを設定する必要はありません。	true false	0.1.7
     spring.schedulerx2.endpoint	指定したリージョンのエンドポイント。詳細については、エンドポイント をご参照ください。	該当なし	0.1.7
     spring.schedulerx2.namespace	ネームスペースの UID。ネームスペース UID は、SchedulerX コンソールの [ネームスペース] ページで確認できます。	該当なし	0.1.7
     spring.schedulerx2.groupId	アプリケーションの ID。アプリケーション ID は、SchedulerX コンソールの [アプリケーション] ページで確認できます。	該当なし	0.1.7
     spring.schedulerx2.appKey	アプリケーションのキー。アプリケーションキーは、SchedulerX コンソールの [アプリケーション] ページで確認できます。	該当なし	1.2.1
     spring.schedulerx2.host	複数の IP アドレスが存在する場合の実際の IP アドレス。エージェントが VPN または複数のネットワークインターフェースカード (NIC) を使用している場合、複数の IP アドレスが存在する可能性があります。	該当なし	0.1.7
     spring.schedulerx2.port	エージェントがリッスンするポート。ポートを指定しない場合、システムは使用可能なポートをランダムに選択します。	該当なし	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。	該当なし	1.2.1.2
     spring.schedulerx2.label	ラベル。エージェントにラベルを追加して、ラベルを使用してジョブ管理のワーカーを指定できます。この機能は、カナリアリリースとストレステストのシナリオに適しています。	該当なし	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	SchedulerX が Map モデルですべてのタスクが完了したかどうかを確認する間隔。単位: ミリ秒。秒単位のジョブのスケジューリング頻度を増やしたい場合は、このパラメーターを設定します。	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"); // SchedulerX 2.0 の挨拶メッセージを表示
           return new ProcessResult(true);
       }
   }              

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