SchedulerX:Spring ジョブ

仕組み

SchedulerX は、デフォルトの Spring タスクスケジューラを独自のスケジューリングエンジンで置き換えます。

1. プロジェクトに SchedulerX Spring Boot Starter の依存関係を追加します。

2. アプリケーションのプロパティファイルに spring.schedulerx2.task.scheduling.scheduler=schedulerx を設定します。

3. SchedulerX がすべての @Scheduled メソッドの実行をコンソール経由で制御します。

ジョブの引き継ぎ後、スケジュール頻度は SchedulerX コンソールで制御されます。@Scheduled アノテーション内の cron 式はコード内に残りますが、ジョブの実行タイミングを決定しなくなります。

実行モード：

自動同期されたジョブは、ネイティブな Spring 動作を維持するため、デフォルトで ブロードキャスト実行 モードになります。ジョブを単一ノードでのみ実行したい場合は、コンソールで 実行モード を スタンドアローン実行 に変更してください。

前提条件

• SchedulerX エージェントのバージョンが 1.8.13 以降

• SchedulerX に接続済みの Spring Boot アプリケーション。設定手順については、「Spring Boot アプリケーションを SchedulerX に接続する」をご参照ください。

Maven 依存関係の追加

schedulerx2-spring-boot-starter の依存関係を pom.xml に追加します。schedulerx2.version は、エージェントのリリースノート から最新バージョンに置き換えてください。

<dependency>
  <groupId>com.aliyun.schedulerx</groupId>
  <artifactId>schedulerx2-spring-boot-starter</artifactId>
  <version>${schedulerx2.version}</version>
  <!-- アプリケーションで Logback を使用している場合、Log4j を除外 -->
  <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>

SchedulerX がスケジューリングを処理するかどうかに関わらず、メインクラスには @EnableScheduling を保持してください。

@SpringBootApplication
@EnableScheduling // 必須：削除しないでください
public class SchedulerXWorkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerXWorkerApplication.class, args);
    }
}

既存の @Scheduled ジョブクラスは、変更の必要はありません。

@Service
public class SpringScheduledProcessor {
    @Scheduled(cron = "0/2 * * * * ?")
    public void hello() {
        logger.info(DateUtil.now() + " hello world. start");
        logger.info(DateUtil.now() + " hello world. end");
    }
}

依存関係を追加しただけではジョブの動作は変化しません。SchedulerX はデフォルトで Spring スケジュールジョブを引き継ぎません。次のステップで引き継ぎを有効化するまで、ジョブは Spring コンテナ内で引き続き実行されます。

SchedulerX による引き継ぎの構成

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

# SchedulerX への接続
spring.schedulerx2.endpoint=${endpoint}
spring.schedulerx2.namespace=${namespace}
spring.schedulerx2.groupId=${groupId}
spring.schedulerx2.appKey=${appKey}

# Spring スケジュールジョブの SchedulerX による引き継ぎを有効化
spring.schedulerx2.task.scheduling.scheduler=schedulerx

接続パラメーター（endpoint、namespace、groupId、appKey）を取得するには、以下の手順を実行します。

1. SchedulerX コンソール にログインします。

2. 左側のナビゲーションウィンドウで、アプリケーション管理 をクリックします。

3. 対象のアプリケーションを見つけ、アクセス構成 を 操作 列からクリックします。

まだ SchedulerX にアプリケーションを作成していない場合は、まずアプリケーションを作成してください。

# 自動ジョブ同期を有効化
spring.schedulerx2.task.scheduling.sync=true
spring.schedulerx2.regionId=<region-id>
spring.schedulerx2.aliyunAccessKey=<your-access-key>
spring.schedulerx2.aliyunSecretKey=<your-secret-key>

接続の確認

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

2. SchedulerX コンソール にログインします。

3. 左側のナビゲーションウィンドウで、アプリケーション管理 をクリックします。

4. アプリケーションの インスタンス総数 列を確認します。0 より大きい値が表示されれば、接続が成功しています。

1. 左側のナビゲーションウィンドウで、タスク管理 をクリックします。

2. 対象のジョブを見つけ、1 回実行 を 操作 列からクリックします。

3. ジョブが正常に実行されることを確認します。

確認後、SchedulerX により、Spring ジョブに対して視覚化された管理・制御、ログ照会、実行チェーンのトレーシング、アラート機能といった企業向け機能が提供されます。

よくある質問

JobContext jobContext = ContainerFactory.getContainerPool().getContext();

@Scheduled(cron = "0/5 * * * * ?")
public ProcessResult helloStandalone1() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return new ProcessResult(true, "Processing result");
}

@Scheduled(cron = "0/5 * * * * ?")
public String helloStandalone2() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return "Processing result";
}

JobContext jobContext = ContainerFactory.getContainerPool().getContext();

@Scheduled(cron = "0/5 * * * * ?")
public ProcessResult helloStandalone1() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return new ProcessResult(true, "Processing result");
}

@Scheduled(cron = "0/5 * * * * ?")
public String helloStandalone2() {
    try {
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. start");
        TimeUnit.SECONDS.sleep(2L);
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. end");
    } catch (Exception e) {
        e.printStackTrace();
        logger.info(DateUtil.now() + " " + Thread.currentThread().getName() + " hello world. exception end..");
    }
    return "Processing result";
}