SpringCloud2.x Task

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 启用单个实例模式
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容