Task
简介
为了短期或者一次性执行某种任务,比如统计,更新数据等所使用的短期框架,也可以与flow data 大数据分析进行结合,但本文章只说明Task单独使用
搭建
1. 使用spring cloud的框架
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.demo</groupId>
<artifactId>task</artifactId>
<version>1.0</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.5.RELEASE</version>
<relativePath/>
<!-- lookup parent thirdpart repository -->
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<!-- 短期任务 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-task</artifactId>
</dependency>
<!-- task依赖,不要去除 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<!-- jpa jar -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
添加注解
在Application中添加注解
@EnableDiscoveryClient
@SpringBootApplication
@EnableConfigurationProperties
@EnableTask
public class Application{
public static void main(String[] args) {
SpringApplication.run(Application.class,args);
}
}
添加任务执行
使用注解方式,添加任务,任务的执行会分为三部分:
- @BeforeTask 任务开始
- @AfterTask 任务结束
- @FailedTask 任务异常,如果发生会优先结束执行
@Component
public class taskRunner{
@BeforeTask
public void onTaskStartup(TaskExecution taskExecution) {
logger.info("任务执行 start");
}
@AfterTask
public void onTaskEnd(TaskExecution taskExecution) {
logger.info("任务执行 end");
}
@FailedTask
public void onTaskEndFailed(TaskExecution taskExecution, Throwable throwable) {
logger.info("任务执行 failed"");
}
}
这样就可以正常运行一个简单的Task了。
配置
一、配置项说明 TaskConfigurer
TaskConfigurer是一个允许用户自定义Spring Cloud Task组件配置的策略接口,其默认实现DefaultTaskConfigurer提供了应用的默认逻辑(当应用上下文中没有DataSource时使用内存Map作为任务仓库存储。当上下文中有DataSource时,使用依赖于 JDBC 的组件实现任务仓库。)。
这里有个疑问:有数据库的情况下,必须创建和存储任务数据,没办法不保存数据。如下场景,更新业务数据库中数据,但是不想在数据库中添加任务的相关结构;或者单独存储任务的数据,在一个任务中执行了不同的业务数据的操作;
TaskConfigurer主要包含三种组件,如表1所示:
组件名 | 描述 | 默认值(由 TaskConfigurer 提供) |
---|---|---|
TaskRepository | TaskRepository接口的实现类,作为任务仓库使用 | SimpleTaskRepository |
TaskExplorer | TaskExplorer接口的实现类(任务探测器是只读访问任务仓库的组件) | SimpleTaskExplorer |
PlatformTransactionManager | 对任务仓库执行更新操作时所使用的事务管理器 | 如果应用上下文中配置有DataSource,默认的事务管理器为DataSourceTransactionManager。如果应用上下文中没有数据源,则默认的事务管理器是ResourcelessTransactionManager。 |
表1 TaskConfigurer的三种主要组件
在定制 TaskConfigurer 时推荐直接继承已有的成熟TaskConfigurer接口,例如继承 DefaultTaskConfigurer,覆盖所需要的getter就足够了。否则的话,你需要重写整个 TaskConfigurer 的逻辑。
二、执行方式
spring:
cloud:
task:
closecontext-enabled: true # 执行完成后,关闭服务
三、数据库配置
默认情况下,会使用H2 嵌入式内存数据库作为数据源来启动发布task,如果需要进行存储任务执行的情况,可以对在配置文件中添加相关的配置,这里我介绍下使用JPA的使用方式:
spring.cloud.task配置开头,例如:spring.cloud.task.tablePrefix
下面对配置项进行说明:
配置项 | 说明 |
---|---|
tablePrefix | 数据库表,命名前缀:默认为TASK_ |
executionid | 任务实例ID,存储到数据库 |
external-execution-id | 外部任务ID |
parent-execution-id | 父类任务ID,可以在一个任务中调用另一个任务 |
single-instance-enabled | 启用单个实例模式 |