SchedulerX：Spring Boot應用接入SchedulerX

1.1基本配置

1.2通知配置

1. 在pom.xml增加依賴配置

   在SpringBoot應用程式的pom.xml檔案中添加SchedulerxWorker依賴，以便在Spring Boot應用程式中使用SchedulerX提供的功能。

   說明

   SchedulerX支援SpringBoot2.x和3.x版本接入。

   <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx2-spring-boot-starter</artifactId>
     <version>${schedulerx2.version}</version>
     <!--如果使用logback，需要將log4j和log4j2排除 -->
     <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. 配置參數

   在SpringBoot應用的設定檔application.properties中添加SchedulerXWorker所需要的參數，例如串連資訊、認證資訊等，以便串連到SchedulerX應用。

   spring.schedulerx2.endpoint=${endpoint}
   spring.schedulerx2.namespace=${namespace}
   spring.schedulerx2.groupId=${groupId}
   # 僅1.2.1及以上版本支援配置appKey
   spring.schedulerx2.appKey=${appKey}
   
   # 如果不使用appKey，可以使用阿里雲AK/SK，或者使用stsToken
   #spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
   #spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey} 
   #spring.schedulerx2.stsToken=${aliyunStsToken}                  

   參數來源：

   在分布式任務調度平台左側導覽列的應用管理頁面，單擊目標應用操作列的接入配置，選擇接入的服務類型為Spring Boot。

   

   重要

   檢查SchedulerX地區和用戶端地區是否保持一致，否則會造成建立串連失敗。

   若您使用的是非阿里雲伺服器或本地環境，確保您已開放公網存取權限，並在任務調度平台公網地區建立應用。具體資訊，可參見在本地接入公網環境。

   說明

   如果您的用戶端應用程式套件含多個業務，或者需要將定時任務隔離做許可權管理，可以通過在控制台上建立多個應用，實現定時任務的精細化管理。例如，用戶端應用animals在控制台上建立了animals.dog和animals.cat兩個應用，無需為兩個應用分別申請執行個體，只需在設定檔application.properties中，通過配置spring.schedulerx2.groupId=${groupId}，並以逗號分隔多個應用來實現，如：spring.schedulerx2.groupId=animals.dog,animals.cat。

   參數說明：

   • endpoint：初始化SchedulerxWorker時，將使用您部署應用的地區（Region）和對應的endpoint。更多資訊，請參見Endpoint列表。

   • namespace：命名空間ID，可以在控制台的命名空間頁面擷取。

   • groupId和appKey：groupId應用ID，appKey為應用key，可以在控制台應用管理頁面擷取。

   • aliyunAccessKey和aliyunSecretKey：aliyunAccessKey為阿里雲帳號的AccessKeyID，aliyunSecretKey為阿里雲帳號的AccessKeySecret。您可以登入使用者資訊管理主控台，在安全資訊管理頁面擷取。

   • 更多參數請參見下表：

     key	描述	設定值	起始版本
     spring.schedulerx2.enabled	是否啟用SchedulerX 2.0的starter。預設為true，無需設定。	true false	0.1.7
     spring.schedulerx2.endpoint	設定Region所在的Endpoint。更多資訊，請參見Endpoint列表。	無	0.1.7
     spring.schedulerx2.namespace	設定命名空間的UID，可以在控制台命名空間頁面擷取。	無	0.1.7
     spring.schedulerx2.groupId	應用ID，可以在控制台應用管理頁面擷取。	無	0.1.7
     spring.schedulerx2.appKey	應用Key，可以在控制台應用管理頁面擷取。	無	1.2.1
     spring.schedulerx2.host	如果有多個IP（例如VPN或者多網卡），可以設定真實的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統計用戶端執行個體的指標。容器（K8s）環境需要手動開啟，預設為false。	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模型檢測所有子任務結束的頻率，單位毫秒。如果秒層級任務需要加快調度頻率時，可以設定。	3000	1.2.5.2
     spring.schedulerx2.enableSecondDelayCycleIntervalMs	設定second_delay延遲的單位為毫秒。如果將該值設定為true，控制台設定的秒層級延遲將會變成毫秒，可以加快調度頻率，預設為false。	true false	1.2.5.2
     spring.schedulerx2.broadcastMasterExecEnable	主節點是否參與廣播任務執行。預設為true。	true false	1.8.13
     spring.schedulerx2.broadcastDispatchRetryTimes	廣播分發失敗重試次數，預設不重試；稍候再試預設2s，且不可配置。	3	1.8.13
     spring.schedulerx2.enableSecondDelayStandaloneDispatch	是否開啟秒層級單機任務分發執行，預設為false。	true false	1.8.13

3. 建立任務處理類

   在SpringBoot應用中建立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);
       }
   }              

登入分布式任務調度平台，在左側導覽列的應用管理，單擊目標應用操作列的查看執行個體，查看執行個體詳情資訊。