Spring Cloud Task 一個允許短期運行的微服務(wù)組件
簡介
Spring Cloud Task允許用戶使用Spring Cloud開發(fā)和運行短期的微服務(wù),并在本地、云中甚至在Spring Cloud數(shù)據(jù)流上運行它們。只需添加@EnableTask并將應(yīng)用程序作為Spring Boot應(yīng)用程序運行(單個應(yīng)用程序上下文)。
Spring Cloud Task使創(chuàng)建短期微服務(wù)變得容易。它提供了在生產(chǎn)環(huán)境中按需執(zhí)行短期JVM進程的功能。
環(huán)境要求
你需要安裝Java(Java 8或更高的版本)。要進行構(gòu)建,還需要安裝Maven。
數(shù)據(jù)庫要求
Spring Cloud Task使用關(guān)系數(shù)據(jù)庫存儲已執(zhí)行任務(wù)的結(jié)果。雖然你可以在沒有數(shù)據(jù)庫的情況下開始開發(fā)任務(wù)(任務(wù)的狀態(tài)記錄為任務(wù)存儲庫更新的一部分),但對于生產(chǎn)環(huán)境,你希望使用受支持的數(shù)據(jù)庫。Spring Cloud Task 目前支持以下數(shù)據(jù)庫:
- 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
簡單任務(wù)
@SpringBootApplication
@EnableTask
public class SpringCloudTaskDemoApplication {
@Bean
public CommandLineRunner helloRunner() {
return new CommandLineRunner() {
@Override
public void run(String... args) throws Exception {
System.out.println("開始執(zhí)行任務(wù)") ;
TimeUnit.SECONDS.sleep(1) ;
System.out.println("任務(wù)執(zhí)行完成") ;
}
};
}
public static void main(String[] args) {
SpringApplication.run(SpringCloudTaskDemoApplication.class, args);
}
}
注意這里需要@EnableTask開啟功能,然后自定義了一個CommandLineRunner類型的Bean。我們的任務(wù)都應(yīng)該在CommandLineRunner或者ApplicationRunner中執(zhí)行。
執(zhí)行
run方法執(zhí)行完以后我們的JVM進程也跟著結(jié)束了。這就是所謂的短期任務(wù)了,我們不需要任務(wù)一直執(zhí)行,只需要在需要的時候執(zhí)行即可。
任務(wù)執(zhí)行完以后會在數(shù)據(jù)表中記錄相關(guān)的執(zhí)行結(jié)果信息。
這些表記錄了本次任務(wù)執(zhí)行的相關(guān)信息,成功,失敗等。
事件監(jiān)聽
我們?nèi)蝿?wù)的執(zhí)行在每一個節(jié)點上都可以進行相關(guān)的監(jiān)聽處理
@Component
public class TaskListenerConfig {
@BeforeTask
public void before(TaskExecution taskExecution) {
System.out.println("任務(wù)執(zhí)行前") ;
}
@AfterTask
public void after(TaskExecution taskExecution) {
System.out.println("任務(wù)執(zhí)行后") ;
}
@FailedTask
public void fail(TaskExecution taskExecution, Throwable throwable) {
System.out.println("任務(wù)執(zhí)行失敗," + throwable.getMessage()) ;
}
}
以上是通過注解的方式實現(xiàn),我們也可以通過實現(xiàn)TaskExecutionListener接口的方式實現(xiàn)。
@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) {
}
}
任務(wù)監(jiān)聽發(fā)生異常
如果TaskExecutionListener事件處理程序引發(fā)異常,則該事件處理程序的所有偵聽器處理都將停止。例如,如果已啟動三個onTaskStartup偵聽器,并且第一個onTaskStartup事件處理程序引發(fā)異常,則不會調(diào)用其他兩個onTaskStartup方法。但是,會調(diào)用TaskExecutionListeners的其他事件處理程序(onTaskEnd和onTaskFailed)。因為執(zhí)行這些回調(diào)方法都是在不同的階段執(zhí)行的,所以只會影響那個階段的事件并不會影響其它階段事件。
限制任務(wù)執(zhí)行
如果你要控制每個任務(wù)只允許同時允許一個,那么我們可以通過如下方式控制:
添加依賴:
<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個依賴是必須的,這是限制任務(wù)執(zhí)行所需要的。
添加配置:
spring:
cloud:
task:
singleInstanceEnabled: true
開啟單任務(wù)執(zhí)行。
完畢!!