Spring Cloud Task 一個允許短期運行的微服務組件
簡介
Spring Cloud Task允許用戶使用Spring Cloud開發和運行短期的微服務,并在本地、云中甚至在Spring Cloud數據流上運行它們。只需添加@EnableTask并將應用程序作為Spring Boot應用程序運行(單個應用程序上下文)。
Spring Cloud Task使創建短期微服務變得容易。它提供了在生產環境中按需執行短期JVM進程的功能。
環境要求
你需要安裝Java(Java 8或更高的版本)。要進行構建,還需要安裝Maven。
數據庫要求
Spring Cloud Task使用關系數據庫存儲已執行任務的結果。雖然你可以在沒有數據庫的情況下開始開發任務(任務的狀態記錄為任務存儲庫更新的一部分),但對于生產環境,你希望使用受支持的數據庫。Spring Cloud Task 目前支持以下數據庫:
- DB2
- H2
- HSQLDB
- MySql
- Oracle
- Postgres
- SqlServer
依賴管理
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-task</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
配置文件
server:
port: 8082
---
spring:
datasource:
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/tasks?serverTimezone=GMT%2B8&nullCatalogMeansCurrent=true
username: root
password: root
type: com.zaxxer.hikari.HikariDataSource
hikari:
minimumIdle: 10
maximumPoolSize: 200
autoCommit: true
idleTimeout: 30000
poolName: MasterDatabookHikariCP
maxLifetime: 1800000
connectionTimeout: 30000
connectionTestQuery: SELECT 1
---
spring:
h2:
console:
enabled: true
settings:
web-allow-others: true
path: /h2
---
spring:
application:
name: taskDemo
---
logging:
level:
org.springframework.cloud.task: DEBUG
簡單任務
@SpringBootApplication
@EnableTask
public class SpringCloudTaskDemoApplication {
@Bean
public CommandLineRunner helloRunner() {
return new CommandLineRunner() {
@Override
public void run(String... args) throws Exception {
System.out.println("開始執行任務") ;
TimeUnit.SECONDS.sleep(1) ;
System.out.println("任務執行完成") ;
}
};
}
public static void main(String[] args) {
SpringApplication.run(SpringCloudTaskDemoApplication.class, args);
}
}
注意這里需要@EnableTask開啟功能,然后自定義了一個CommandLineRunner類型的Bean。我們的任務都應該在CommandLineRunner或者ApplicationRunner中執行。
執行
run方法執行完以后我們的JVM進程也跟著結束了。這就是所謂的短期任務了,我們不需要任務一直執行,只需要在需要的時候執行即可。
任務執行完以后會在數據表中記錄相關的執行結果信息。
這些表記錄了本次任務執行的相關信息,成功,失敗等。
事件監聽
我們任務的執行在每一個節點上都可以進行相關的監聽處理
@Component
public class TaskListenerConfig {
@BeforeTask
public void before(TaskExecution taskExecution) {
System.out.println("任務執行前") ;
}
@AfterTask
public void after(TaskExecution taskExecution) {
System.out.println("任務執行后") ;
}
@FailedTask
public void fail(TaskExecution taskExecution, Throwable throwable) {
System.out.println("任務執行失敗," + throwable.getMessage()) ;
}
}
以上是通過注解的方式實現,我們也可以通過實現TaskExecutionListener接口的方式實現。
@Component
public class DemoListener implements TaskExecutionListener {
@Override
public void onTaskStartup(TaskExecution taskExecution) {
}
@Override
public void onTaskEnd(TaskExecution taskExecution) {
}
@Override
public void onTaskFailed(TaskExecution taskExecution, Throwable throwable) {
}
}
任務監聽發生異常
如果TaskExecutionListener事件處理程序引發異常,則該事件處理程序的所有偵聽器處理都將停止。例如,如果已啟動三個onTaskStartup偵聽器,并且第一個onTaskStartup事件處理程序引發異常,則不會調用其他兩個onTaskStartup方法。但是,會調用TaskExecutionListeners的其他事件處理程序(onTaskEnd和onTaskFailed)。因為執行這些回調方法都是在不同的階段執行的,所以只會影響那個階段的事件并不會影響其它階段事件。
限制任務執行
如果你要控制每個任務只允許同時允許一個,那么我們可以通過如下方式控制:
添加依賴:
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-core</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-jdbc</artifactId>
</dependency>
上面2個依賴是必須的,這是限制任務執行所需要的。
添加配置:
spring:
cloud:
task:
singleInstanceEnabled: true
開啟單任務執行。
完畢!!