概述

本文是Spring Cloud Task系列的第三篇文章吗冤，如果你尚未使用過Spring Cloud Task，請(qǐng)
移步spring cloud task1 簡(jiǎn)介與示例九府。

Spring Cloud Task開箱即用的屬性配置項(xiàng)由DefaultTaskConfigurer和SimpleTaskConfiguration類來管理椎瘟，本篇文章對(duì)Spring Cloud Task的各個(gè)方面的默認(rèn)配置項(xiàng)進(jìn)行分析，循序漸進(jìn)侄旬，再討論如何根據(jù)實(shí)際業(yè)務(wù)需求去定制Spring Cloud Task的配置肺蔚。

主要內(nèi)容

數(shù)據(jù)源配置

1. 數(shù)據(jù)源選擇

spring cloud task使用數(shù)據(jù)源（如mysql）來存儲(chǔ)task的執(zhí)行結(jié)果。如果沒有自定義配置數(shù)據(jù)源勾怒，則默認(rèn)使用 H2 嵌入式內(nèi)存數(shù)據(jù)庫作為數(shù)據(jù)源來啟動(dòng)發(fā)布task婆排。不過內(nèi)存數(shù)據(jù)庫中存儲(chǔ)的task信息并沒有被持久化，所以在生產(chǎn)環(huán)境下我們需要配置自己的數(shù)據(jù)源笔链。

如果你的應(yīng)用中只有一個(gè)DataSource段只，Spring Cloud Task默認(rèn)會(huì)用task倉庫管理此數(shù)據(jù)源。被task倉庫管理數(shù)據(jù)源里不但存儲(chǔ)有你的業(yè)務(wù)數(shù)據(jù)鉴扫，還會(huì)有task倉庫的相關(guān)數(shù)據(jù)定義與記錄赞枕。單數(shù)據(jù)源應(yīng)用是最為簡(jiǎn)單方便的，很適合小型應(yīng)用坪创。

當(dāng)應(yīng)用中有多個(gè)數(shù)據(jù)源時(shí)炕婶，框架支持根據(jù)業(yè)務(wù)需求選擇最合適數(shù)據(jù)源存儲(chǔ)的任務(wù)信息數(shù)據(jù)。通過自定義繼承自TaskConfigure的配置類可以達(dá)到在多數(shù)據(jù)源情況下選擇合適的任務(wù)數(shù)據(jù)源的目的莱预。

2. 任務(wù)表前綴

Spring Cloud Task支持自定義任務(wù)倉庫所管理的數(shù)據(jù)庫表表名的前綴柠掂，默認(rèn)情況下表名前綴是 TASK_ ，像 TASK_EXCUTION 依沮、TASK_EXECUTION_PARAMS 這兩張表表名都是以 TASK_ 開頭的涯贞。在特殊情況下可能會(huì)有需要自定義表前綴的需求，如數(shù)據(jù)庫先前就已經(jīng)定義好了表名危喉，或在該數(shù)據(jù)源中已經(jīng)存在了不同業(yè)務(wù)需求的任務(wù)倉庫所定義的任務(wù)相關(guān)的表宋渔，這些都需要我們改變?nèi)蝿?wù)倉庫數(shù)據(jù)表的表名前綴。

通過設(shè)置spring.cloud.task.tablePrefix屬性辜限，可以自定義表名前綴

 spring.cloud.task.tablePrefix=<yourPrefix>

3. 開啟/關(guān)閉數(shù)據(jù)庫表初始化

Spring Cloud Task會(huì)在task啟動(dòng)時(shí)自動(dòng)在數(shù)據(jù)源中創(chuàng)建任務(wù)相關(guān)的表皇拣，如果數(shù)據(jù)源中已經(jīng)存在這些表，設(shè)置spring.cloud.task.initialize.enable的值為false就可以關(guān)閉自動(dòng)建表的功能薄嫡，該屬性的默認(rèn)值為true氧急。

spring.cloud.task.initialize.enable=<true or false>

任務(wù)task id配置

1. 外部生成任務(wù)的Task Id

考慮到任務(wù)被請(qǐng)求和基礎(chǔ)設(shè)施實(shí)際執(zhí)行之間的時(shí)間差颗胡，Spirng Cloud Task允許用戶在任務(wù)被請(qǐng)求時(shí)創(chuàng)建一個(gè)任務(wù)實(shí)例，任務(wù)執(zhí)行實(shí)例會(huì)生成一個(gè)Task Id态蒂，通過這個(gè)Task Id就可以跟蹤任務(wù)的執(zhí)行情況并實(shí)時(shí)對(duì)任務(wù)執(zhí)行實(shí)例進(jìn)行調(diào)整杭措。

在任務(wù)倉庫TaskRepository的實(shí)現(xiàn)類里調(diào)用createTaskExecution方法就可以創(chuàng)建并持久化一個(gè)任務(wù)執(zhí)行實(shí)例。

使用下面的配置可以讓你的任務(wù)使用自動(dòng)生成的任務(wù)id钾恢。

 spring.cloud.task.executionid=<yourtaskId>

2. 外部任務(wù)Task Id

Spring Cloud Task允許用戶為任務(wù)執(zhí)行實(shí)例保存一個(gè)外部的任務(wù)id手素，例如當(dāng)任務(wù)在平臺(tái)上啟動(dòng)時(shí)，Cloud Foundry會(huì)為任務(wù)提供一個(gè)task id瘩蚪。使用下面的配置可以讓你的任務(wù)使用外部生成的task id泉懦。

spring.cloud.task.external-execution-id=<externalTaskId>

3. 父任務(wù)Task Id

Spirng Cloud Task允許任務(wù)執(zhí)行實(shí)例保存其父任務(wù)的task id。如果在一個(gè)任務(wù)執(zhí)行的過程中調(diào)用了另一個(gè)任務(wù)疹瘦，一般情況下崩哩，我們會(huì)在子任務(wù)中保存其父任務(wù)的id以方便數(shù)據(jù)查找或任務(wù)出現(xiàn)問題時(shí)跟蹤維護(hù)。此時(shí)可以在子任務(wù)中配置以下屬性來完成保存父任務(wù)task id的需求言沐。

spring.cloud.task.parent-execution-id=<parentExecutionTaskId>

任務(wù)配置

1. TaskConfigurer

TaskConfigurer是一個(gè)允許用戶自定義Spring Cloud Task組件配置的策略接口邓嘹，其默認(rèn)實(shí)現(xiàn)DefaultTaskConfigurer提供了應(yīng)用的默認(rèn)邏輯(當(dāng)應(yīng)用上下文中沒有DataSource時(shí)使用內(nèi)存Map作為任務(wù)倉庫存儲(chǔ)。當(dāng)上下文中有DataSource時(shí)险胰，使用依賴于 JDBC 的組件實(shí)現(xiàn)任務(wù)倉庫汹押。)。

TaskConfigurer主要包含三種組件起便，如表1所示棚贾。

表1 TaskConfigurer的三種主要組件

在定制 TaskConfigurer 時(shí)推薦直接繼承已有的成熟TaskConfigurer接口怯伊，例如繼承 DefaultTaskConfigurer，覆蓋所需要的getter就足夠了判沟。否則的話震贵，你需要重寫整個(gè) TaskConfigurer 的邏輯。

2. 任務(wù)名

大多數(shù)情況下水评，Spring Boot中所配置的應(yīng)用名就是任務(wù)名。不過有時(shí)可能需要為任務(wù)指定一個(gè)其它的名字媚送，比如在使用Spring Data Flow平臺(tái)（任務(wù)名一般是隨任務(wù)定義的名稱而改變）時(shí)中燥，就需要一種能夠自定義任務(wù)名的方法了。

Spring Cloud Task提供了 TaskNameResolver 接口來定制任務(wù)名塘偎，其默認(rèn)實(shí)現(xiàn)是 SimpleTaskNameResolver 類疗涉，可以通過下面兩種方式來使用SimpleTaskNameResolver拿霉。

• Spring Boot 的屬性(任意一種配置 Spring Boot 屬性的方法都可以)spring.cloud.task.name。
• 經(jīng)由 Spring Boot 的規(guī)則獲取到的應(yīng)用名(通過 ApplicationContext#getId 方法獲取)咱扣。

任務(wù)執(zhí)行監(jiān)聽器配置

任務(wù)執(zhí)行監(jiān)聽器由TaskExecutionListener接口的實(shí)現(xiàn)類擔(dān)任绽淘，其允許用戶注冊(cè)監(jiān)聽task生命周期中發(fā)生的特定事件。當(dāng)task發(fā)生下面三種事件時(shí)闹伪，監(jiān)聽器會(huì)得到通知沪铭。

1. onTaskStartup - 在 TaskExecution 存儲(chǔ)進(jìn) TaskRepository 之前。
2. onTaskEnd - 在修改 TaskRepository 中所存儲(chǔ)的 TaskExecution 數(shù)據(jù)的最終狀態(tài)之前偏瓤。
3. onTaskFailed - 在任務(wù)拋出一個(gè)無法處理的異常后杀怠，將要調(diào)用 onTaskEnd 方法之前。

Spring Cloud Task 還支持在 bean 的方法上添加注解的方式來為任務(wù)執(zhí)行實(shí)例 TaskExecution 添加事件監(jiān)聽處理邏輯厅克。詳見下面三個(gè)注解赔退。

• @BeforeTask - 表示使用指定方法處理 onTaskStartup 事件。
• @AfterTask - 表示使用指定方法處理 onTaskEnd 事件证舟。
• @FailedTask - 表示使用指定方法處理 onTaskFailed 事件硕旗。

代碼1是這三個(gè)注解的使用示例。

public class MyBean {

    @BeforeTask
    public void methodA(TaskExecution taskExecution) {
    }

    @AfterTask
    public void methodB(TaskExecution taskExecution) {
    }

    @FailedTask
    public void methodC(TaskExecution taskExecution, Throwable throwable) {
    }
}

代碼1 事件監(jiān)聽處理注解的使用示例

引用

本文是我在學(xué)習(xí)使用Spring Cloud Task 時(shí)的筆記女责，在本文的寫過過程中參考了大量其它資料漆枚，有些材料來源于網(wǎng)絡(luò)，我由衷的表示感謝鲤竹，但由于原作者不明浪读，恕不能一一記述。

1. Spring Cloud Task Reference Guide.[Michael Minella, Glenn Renfro].v1.2.4RELEASE
2. Spring Cloud Task 項(xiàng)目倉庫
3. Spring Cloud Data Flow Reference Guide#Task

關(guān)于

示例源碼

Spring Cloud Task learning 的 task-demo-with-datasource 子項(xiàng)目

后記

Spring Cloud Task是一個(gè)優(yōu)秀的項(xiàng)目辛藻，但是我找遍網(wǎng)絡(luò)碘橘，也難以找出系統(tǒng)的、準(zhǔn)確的中文相關(guān)文檔吱肌。本系列文章以保證對(duì)Spring Cloud Task相關(guān)概念和設(shè)計(jì)理解的正確性為標(biāo)準(zhǔn)痘拆，盡量采用通俗易懂的語言，希望能給各位帶來一些便捷氮墨。

本文內(nèi)容主要是對(duì) Spring Cloud Task 1.2.2-RELEASE 官方文檔的翻譯纺蛆，不過作者水平有限，有不盡然的地方敬請(qǐng)指出规揪。本項(xiàng)目和文檔中所用的內(nèi)容僅供學(xué)習(xí)和研究之用桥氏，轉(zhuǎn)載或引用時(shí)請(qǐng)指明出處。如果你對(duì)文檔有疑問或問題猛铅，請(qǐng)?jiān)陧?xiàng)目中給我留言或發(fā)email到
weiwei02@vip.qq.com 我的github:
https://github.com/weiwei02/ 我相信技術(shù)能夠改變世界 字支。

鏈接

• 上篇文章Spring Cloud Task2 生命周期特性與任務(wù)倉庫數(shù)據(jù)結(jié)構(gòu)
• 下篇文章正在準(zhǔn)備中