如何形成統(tǒng)一設(shè)計(jì)風(fēng)格-實(shí)踐篇
一 背景
在上一篇《業(yè)務(wù)團(tuán)隊(duì)如何統(tǒng)一架構(gòu)設(shè)計(jì)風(fēng)格?》中,探討了一種業(yè)務(wù)架構(gòu)的設(shè)計(jì)規(guī)范,以期達(dá)到這些目標(biāo):用標(biāo)準(zhǔn)約束技術(shù)細(xì)節(jié);用技術(shù)工具而非文檔推行標(biāo)準(zhǔn);持續(xù)重構(gòu)而非造新輪子;重視業(yè)務(wù)建模。但通篇表述較為抽象。本篇將總結(jié)團(tuán)隊(duì)近來的架構(gòu)演進(jìn)工作,以更具體的技術(shù)細(xì)節(jié),詳細(xì)闡釋該理念,作為“統(tǒng)一業(yè)務(wù)設(shè)計(jì)風(fēng)格”的實(shí)踐篇。文中詳述了多個(gè)層面的設(shè)計(jì)規(guī)約和基于規(guī)約的搭建方式,并在末尾回答了上一篇的諸多疑問。
二 總覽
上圖以電商產(chǎn)品為例,展示了一套標(biāo)準(zhǔn)框架的各層設(shè)計(jì)單元。先簡(jiǎn)單了解下概念,下一章節(jié)會(huì)詳細(xì)解釋各層的設(shè)計(jì)規(guī)約和搭建方式:
- 產(chǎn)品模式層
以產(chǎn)品合約描述完整的功能列表;以簽署人身份來定位產(chǎn)品功能的適用場(chǎng)景;以合約分組來描述一個(gè)獨(dú)立完備的功能域,分組的集合就是產(chǎn)品功能的范圍和邊界。通過對(duì)合約分組進(jìn)行組裝,可以快速搭建商業(yè)產(chǎn)品。
- 業(yè)務(wù)模型層
為了減少不同技術(shù)同學(xué)對(duì)領(lǐng)域進(jìn)行建模的風(fēng)格差異,我們對(duì)業(yè)務(wù)模型的使用場(chǎng)景做了諸多約定,串聯(lián)起倉儲(chǔ)管理/業(yè)務(wù)流程/業(yè)務(wù)組件等基礎(chǔ)模塊。所有人更關(guān)注于業(yè)務(wù)在模型上的表達(dá),而大大減少了對(duì)實(shí)現(xiàn)細(xì)節(jié)的關(guān)注。基于對(duì)領(lǐng)域的分析,可以快速搭建業(yè)務(wù)模型。
- 業(yè)務(wù)流程層
用一套標(biāo)準(zhǔn)的業(yè)務(wù)流程框架,描述業(yè)務(wù)模型的完整執(zhí)行流程:業(yè)務(wù)組件是一套高內(nèi)聚的業(yè)務(wù)功能集合,基于組件配置將業(yè)務(wù)模型的信息適配為標(biāo)準(zhǔn)參數(shù),交由基礎(chǔ)設(shè)施執(zhí)行具體功能;流程引擎負(fù)責(zé)創(chuàng)建和管理流程實(shí)例,接收指令來觸發(fā)組件動(dòng)作的執(zhí)行,并實(shí)現(xiàn)狀態(tài)推進(jìn)/條件跳轉(zhuǎn)和異常處理等分支管控的需求。通過對(duì)業(yè)務(wù)組件/基礎(chǔ)設(shè)施的抽象和沉淀,可以快速搭建業(yè)務(wù)流程。
- 數(shù)據(jù)視圖層
用一套標(biāo)準(zhǔn)的數(shù)據(jù)流機(jī)制,來滿足視圖層的定制化需求:數(shù)據(jù)流訂閱器用于采集數(shù)據(jù),物理來源包含區(qū)塊鏈跨鏈數(shù)據(jù)/業(yè)務(wù)DB數(shù)據(jù)/文件系統(tǒng)數(shù)據(jù)/離線任務(wù)數(shù)據(jù)等;數(shù)據(jù)流消費(fèi)器用來加工原始數(shù)據(jù),生成展示層數(shù)據(jù)/待核對(duì)數(shù)據(jù)/數(shù)據(jù)指標(biāo)等等。訂閱器確保了數(shù)據(jù)來源的穩(wěn)定和低成本的快速接入,消費(fèi)器則交由技術(shù)同學(xué)自行定制業(yè)務(wù)邏輯。在不干擾領(lǐng)域建模的基礎(chǔ)上,可以快速搭建數(shù)據(jù)視圖。
三 規(guī)約詳解
1 產(chǎn)品模式
產(chǎn)品合約
1)規(guī)約
- 產(chǎn)品合約以全局視角,描述完整的業(yè)務(wù)模式,包括:服務(wù)的目標(biāo)客戶,依賴的業(yè)務(wù)領(lǐng)域,輸出的服務(wù)等等
- 產(chǎn)品合約的內(nèi)容是一份靜態(tài)描述文件,需要由簽署身份列表來界定使用場(chǎng)景
2)實(shí)例
以電商產(chǎn)品為例,商家單獨(dú)簽署的產(chǎn)品合約被作為商家合約,描述了商品的上架要求;商家+平臺(tái)+買家共同簽署的產(chǎn)品合約,則適用于交易下單場(chǎng)景。
3)搭建
- 新增/修改
- 低代碼:基于業(yè)務(wù)需求,在產(chǎn)品中心設(shè)計(jì)產(chǎn)品模板,明確合約分組和具體內(nèi)容
- 使用:
- 接入時(shí)編碼,一次性:在業(yè)務(wù)系統(tǒng)內(nèi)編寫對(duì)應(yīng)產(chǎn)品合約和簽署身份的模型類,完成和產(chǎn)品中心的對(duì)接,包括合約的創(chuàng)建/失效,基于簽署身份的合約查詢等等
合約分組
1)規(guī)約
合約分組以局部視角,描述某個(gè)高度內(nèi)聚的業(yè)務(wù)領(lǐng)域所提供的功能和依賴的配置信息,包括:業(yè)務(wù)模型,業(yè)務(wù)服務(wù),業(yè)務(wù)流程,業(yè)務(wù)組件等等
多個(gè)合約分組共同組成一個(gè)可交付業(yè)務(wù)的產(chǎn)品合約
2)實(shí)例
電商產(chǎn)品合約下,商品分組描述了商品上架的流程和配置,下單分組約束了訂單創(chuàng)建的流程和服務(wù)信息,退貨分組則說明了退貨流程和買家能夠享受的客戶服務(wù)。
3)搭建
- 新增/修改
- 低代碼:以元數(shù)據(jù)的方式定義一個(gè)合約分組,包含模型/流程/配置等等,每一個(gè)配置都可以用鍵路徑/配置值類型和限制等描述
- 使用
- 硬編碼:在業(yè)務(wù)系統(tǒng)內(nèi)定義合約分組的模型類,完成與產(chǎn)品合約內(nèi)容交互的寫入和讀取,在業(yè)務(wù)代碼處顯式獲取業(yè)務(wù)分組實(shí)例
- 低代碼:搭建合約查詢->分組解析->配置獲取的通用框架(引入緩存避免重復(fù)查詢),業(yè)務(wù)層只需要通過元數(shù)據(jù)描述,就可以獲取對(duì)應(yīng)分組內(nèi)的配置信息
2 業(yè)務(wù)領(lǐng)域
模型
1)規(guī)約
業(yè)務(wù)模型描述一個(gè)領(lǐng)域內(nèi)的核心業(yè)務(wù)實(shí)體,是唯一貫通業(yè)務(wù)流程和業(yè)務(wù)組件的業(yè)務(wù)實(shí)例
一個(gè)業(yè)務(wù)模型內(nèi)可以關(guān)聯(lián)其他模型,但應(yīng)避免出現(xiàn)循環(huán)依賴
一個(gè)完備的業(yè)務(wù)模型描述需要包含:數(shù)據(jù)模型,視圖模型,業(yè)務(wù)模型/數(shù)據(jù)模型/視圖模型的三者轉(zhuǎn)換,業(yè)務(wù)模型倉儲(chǔ)等
2)實(shí)例
退貨業(yè)務(wù),基于退貨單推進(jìn)業(yè)務(wù)流程,各業(yè)務(wù)組件從退貨單獲取必要的業(yè)務(wù)信息,執(zhí)行退貨/退款/通知等業(yè)務(wù)功能;退貨單關(guān)聯(lián)自一個(gè)正向訂單,但正向訂單不可反向依賴退貨單;一個(gè)退貨單模型對(duì)應(yīng)一張主單據(jù)表和多張退貨明細(xì)表,倉儲(chǔ)需要負(fù)責(zé)完成業(yè)務(wù)模型<->數(shù)據(jù)模型的雙向讀寫
3)搭建
- 硬編碼:編寫業(yè)務(wù)模型(Model)/數(shù)據(jù)模型(DO)/數(shù)據(jù)交互(Mapper)/視圖模型(VO)/轉(zhuǎn)換層(Converter)/倉儲(chǔ)(Repository)等等
- 低代碼:用元數(shù)據(jù)描述,自動(dòng)生成DO/VO/Mapper/Converter;基于底座提供的倉儲(chǔ)組件,也可以通過元數(shù)據(jù)描述,自動(dòng)生成業(yè)務(wù)模型倉儲(chǔ)的實(shí)例
服務(wù)
1)規(guī)約
1、業(yè)務(wù)服務(wù)是一套以業(yè)務(wù)領(lǐng)域?yàn)閱挝?interface)作聚合,開放給內(nèi)外所有使用方的最小業(yè)務(wù)功能單元(method)
2、業(yè)務(wù)服務(wù)需要一套定義規(guī)范(annotation/aop等),對(duì)每一個(gè)功能單元有清晰直觀的元數(shù)據(jù)描述,用以實(shí)現(xiàn)服務(wù)發(fā)現(xiàn)/文檔生成/權(quán)限管控/穩(wěn)定性保障等等。元數(shù)據(jù)包括:業(yè)務(wù)域,業(yè)務(wù)動(dòng)作,讀/寫,錯(cuò)誤碼范圍,返回值模型等等
3、業(yè)務(wù)服務(wù)的入?yún)ⅲ拗茷橐粋€(gè)sysParam和一個(gè)bizParam,前者為調(diào)用來源/冪等ID/產(chǎn)品碼/租戶ID等系統(tǒng)參數(shù),后者為各業(yè)務(wù)自行定義的模型參數(shù),建議為可全鏈路透?jìng)?rpc->api->flow->component)的POJO
4、業(yè)務(wù)服務(wù)以Result形式返回,錯(cuò)誤碼盡量控制在元數(shù)據(jù)描述的范圍內(nèi),不泄漏任何exception給調(diào)用方。返回的業(yè)務(wù)信息,建議為POJO或VO
5、業(yè)務(wù)服務(wù)不局限于調(diào)用方的物理來源,只需要在對(duì)接層增加簡(jiǎn)單的轉(zhuǎn)換邏輯,做授權(quán)管控即可
6、寫服務(wù)的實(shí)現(xiàn),需要有事務(wù)管理機(jī)制
2)實(shí)例
- public interface DemoOrderService {
- /**
- * 下單申請(qǐng)
- * @param sysParam sysParam
- * @param bizParam bizParam
- * @return result
- */
- @ApiFunction(apiType = ApiType.SUBMIT, funcBiz = "ORDER",funcAction = "APPLY",
- returnType = OrderApplyResponse.class, errorCodeType = CommonErrorCodeEnum.class)
- CommonResult<OrderApplyResponse> apply(ApiReqSysParam sysParam, OrderApplyInfo bizParam);
- }
3)搭建
- 新增/修改
- 定義-低代碼:基于元數(shù)據(jù)描述,自動(dòng)生成interface+method+errorcode+POJO等等
- 實(shí)現(xiàn)
- 硬編碼:簡(jiǎn)單需求/不可模板化/無法流程化的業(yè)務(wù)需求,直接編碼
- 低代碼:對(duì)于標(biāo)準(zhǔn)的流程發(fā)起服務(wù)(申請(qǐng)上架/申請(qǐng)下單/申請(qǐng)退貨),用模板實(shí)現(xiàn)合約分組加載->流程配置加載->流程初始化(冪等)->流程觸發(fā)->結(jié)果處理;對(duì)于標(biāo)準(zhǔn)的流程推進(jìn)服務(wù)(通知回執(zhí)/調(diào)度推進(jìn)),用模板實(shí)現(xiàn)流程配置加載->流程觸發(fā)->結(jié)果處理等等。隨著更多服務(wù)場(chǎng)景的出現(xiàn),可以有更多模板化的業(yè)務(wù)服務(wù)。
- 使用
- 硬編碼:與所有interface的使用一樣,組裝請(qǐng)求->調(diào)用->處理結(jié)果
- 低代碼:基于元數(shù)據(jù)描述和業(yè)務(wù)配置,將當(dāng)前業(yè)務(wù)對(duì)象/外部參數(shù)映射為服務(wù)入?yún)⒌腜OJO,異常處理模板化,成功返回的結(jié)果以同樣方式映射回業(yè)務(wù)對(duì)象或外部響應(yīng)
流程
1)規(guī)約
1、Flow用于描述一個(gè)完整的業(yè)務(wù)流程,基于單個(gè)業(yè)務(wù)模型,推進(jìn)一個(gè)或多個(gè)業(yè)務(wù)子環(huán)節(jié)
2、對(duì)于單個(gè)業(yè)務(wù)模型的同一類型業(yè)務(wù)流程,可以有多個(gè)Flow定義,以滿足不同業(yè)務(wù)模式的定制需求
3、Flow包含遷轉(zhuǎn) (transition) ,組件 (component) 和動(dòng)作 (action) 三級(jí)結(jié)構(gòu),運(yùn)作原理如下:每次觸發(fā) (operate) 對(duì)應(yīng)于組件的一次action,所有action都成功的component會(huì)完結(jié),而所有component都成功的transition將會(huì)觸發(fā)Flow和業(yè)務(wù)模型的狀態(tài)遷轉(zhuǎn)。
4、Flow的目標(biāo)是將復(fù)雜流程拆解成多個(gè)原子化的業(yè)務(wù)動(dòng)作,相互解耦
5、Flow需要結(jié)合業(yè)務(wù)服務(wù)/消息/調(diào)度等調(diào)用入口的觸發(fā),才能實(shí)現(xiàn)完備的流程推進(jìn)
6、Flow需要依賴外部調(diào)用方提供事務(wù)管理機(jī)制(通常是業(yè)務(wù)服務(wù)),需要依賴業(yè)務(wù)模型倉儲(chǔ)來控制模型的加載和存儲(chǔ)
2)實(shí)例
- <?xml version="1.0" encoding="UTF-8"?>
- <flow id="OrderApply" version="001" desc="標(biāo)準(zhǔn)下單流程">
- <config>
- <model class="xxx.xxx.Order"/>
- </config>
- <init type="INIT" desc="初始化">
- <action operate="INIT.INIT"/>
- </init>
- <transitions>
- <transition from="INIT" to="ITEM_OCCUPIED">
- <component type="ITEM" desc="扣減庫存">
- <action operate="ITEM.OCCUPY"/>
- </component>
- </transition>
- <transition from="ITEM_OCCUPIED" to="DISCOUNT_OCCUPIED">
- <component type="DISCOUNT" desc="扣減優(yōu)惠">
- <action operate="DISCOUNT.OCCUPY"/>
- </component>
- </transition>
- <transition from="DISCOUNT_OCCUPIED" to="SUCCESS">
- <component type="NOTIFY" desc="下單成功通知">
- <action operate="NOTIFY.SELLER"/>
- <action operate="NOTIFY.BUYER"/>
- </component>
- </transition>
- </transitions>
- </flow>
3)搭建
- 新增/修改
- 低代碼:Flow自身的運(yùn)作由底座組件支撐,只需一次性編碼;若需要定義業(yè)務(wù)流程,可基于業(yè)務(wù)組件模板和業(yè)務(wù)模型,動(dòng)態(tài)生成Flow配置文件;加上版本控制和隔離機(jī)制,就可以防止兼容性問題
- 使用
- 硬編碼:Flow初始化場(chǎng)景,從當(dāng)前業(yè)務(wù)領(lǐng)域的合約分組中,獲取需要的Flow配置,初始化流程并推進(jìn);Flow推進(jìn)場(chǎng)景,基于modelId+modelType+operate+request,可以用模版化代碼自動(dòng)觸發(fā)
- 低代碼:通過對(duì)合約分組中Flow配置的標(biāo)準(zhǔn)化,可以將Flow初始化場(chǎng)景也以模板化的方式實(shí)現(xiàn);當(dāng)一個(gè)現(xiàn)有業(yè)務(wù)服務(wù)需要支持新定制的業(yè)務(wù)流程時(shí),只需調(diào)整合約內(nèi)的配置即可
組件
1)規(guī)約
1、業(yè)務(wù)組件是某一類業(yè)務(wù)動(dòng)作的聚合,面向業(yè)務(wù)功能設(shè)計(jì),不局限于任何一個(gè)業(yè)務(wù)模型
2、業(yè)務(wù)組件的業(yè)務(wù)動(dòng)作,是原子化的最小業(yè)務(wù)單元,粒度暫無強(qiáng)制要求,但以解耦和復(fù)用程度為衡量依據(jù);建議其依賴一個(gè)到多個(gè)基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù),以模板化的方式提供標(biāo)準(zhǔn)的業(yè)務(wù)動(dòng)作實(shí)現(xiàn)
3、對(duì)于某個(gè)業(yè)務(wù)模型,業(yè)務(wù)組件通過開放適配器(詳見【基礎(chǔ)設(shè)施-適配】)的方式支持受控定制,或以完全復(fù)寫的方式實(shí)現(xiàn)排他定制(不允許其他業(yè)務(wù)復(fù)用)
4、所有的核心業(yè)務(wù)邏輯,都應(yīng)收歸到業(yè)務(wù)組件層及其以下(無流程的簡(jiǎn)單業(yè)務(wù)服務(wù)除外),包括但不限于:參數(shù)校驗(yàn),業(yè)務(wù)校驗(yàn),重入/冪等控制,業(yè)務(wù)模型變更,合約分組變更,計(jì)算規(guī)則,外部服務(wù)交互等等
5、業(yè)務(wù)組件需要一套定義規(guī)范(xml/annotation等),對(duì)其支持的業(yè)務(wù)動(dòng)作和業(yè)務(wù)模型有清晰直觀的元數(shù)據(jù)描述,用以搭建業(yè)務(wù)流程。元數(shù)據(jù)包括:業(yè)務(wù)動(dòng)作列表和對(duì)應(yīng)的觸發(fā)點(diǎn)(operate),支持的業(yè)務(wù)模型列表
2)實(shí)例
- 核身組件定義類
- public interface BizModelDiscountComponent<T extends BizModel> extends BizModelComponent<T> {
- /**
- * 占用優(yōu)惠
- * @param context
- */
- void occupy(FlowContext context);
- /**
- * 退回優(yōu)惠
- * @param context
- */
- void refund(FlowContext context);
- }
- 核身組件元數(shù)據(jù)配置
- <componentTemplate type="DISCOUNT" desc="優(yōu)惠">
- <interface name="xxx.xxx.BizModelDiscountComponent"/>
- <bizModelMappings>
- <bizModelMapping>
- <bizModel class="xxx.xxx.Order"/>
- <componentEntry name="orderDiscountComponent"/>
- </bizModelMapping>
- <bizModelMapping>
- <bizModel class="xxx.xxx.RefundOrder"/>
- <componentEntry name="refundOrderDiscountComponent"/>
- </bizModelMapping>
- </bizModelMappings>
- <triggerMappings>
- <triggerMapping>
- <triggerTemplate operatePostfix="OCCUPY"/>
- <methodEntry name="occupy"/>
- </triggerMapping>
- <triggerMapping>
- <triggerTemplate operatePostfix="REFUND"/>
- <methodEntry name="refund"/>
- </triggerMapping>
- </triggerMappings>
- </componentTemplate>
適配器Adapter的解釋,詳見【模型適配】小節(jié)
- public abstract class AbstractBizModelDiscountComponent<T extends BizModel> implements BizModelDiscountComponent<T> {
- @Resource
- private DiscountApiService discountApiService;
- @Override
- public void occupy(FlowContext context) {
- // TODO AdapterConfigInfo根據(jù)context從當(dāng)前合約中獲取
- T bizModel = (T) context.getBizModel();
- getDiscountAdapter().processOnOccupyResult(
- bizModel,
- discountApiService.occupy(getDiscountAdapter().toOccupyInfo(bizModel, new AdapterConfigInfo()))
- );
- }
- @Override
- public void refund(FlowContext context) {
- // TODO AdapterConfigInfo根據(jù)context從當(dāng)前合約中獲取
- T bizModel = (T) context.getBizModel();
- getDiscountAdapter().processOnRefundResult(
- bizModel,
- discountApiService.refund(getDiscountAdapter().toRefundInfo(bizModel, new AdapterConfigInfo()))
- );
- }
- @SuppressWarnings("unchecked")
- protected BizModelToDiscountAdapter<T> getDiscountAdapter(){
- return (BizModelToDiscountAdapter<T>) FlowInstanceFactory.instanceBizAdapter(
- "DISCOUNT", (Class<? extends BizModel>) TypeUtils.getRealClassOfParameterizedType(this));
- }
- }
3)搭建
- 新增/修改
- 硬編碼:全新業(yè)務(wù)組件基本無法低代碼化,需要開發(fā)有足夠的設(shè)計(jì)思維和大局觀,權(quán)衡復(fù)用度和成本后實(shí)現(xiàn)初版;隨著業(yè)務(wù)發(fā)展,逐步抽象出模板化的業(yè)務(wù)組件實(shí)現(xiàn);很多場(chǎng)景下,如果避免不了復(fù)雜的定制邏輯,可以自行以策略/職責(zé)鏈/工廠等多種設(shè)計(jì)模式落地,這依賴于開發(fā)者的建模能力,不做強(qiáng)制要求
- 低代碼:已有的業(yè)務(wù)組件應(yīng)用于新業(yè)務(wù)模型的場(chǎng)景,如果已經(jīng)抽象出合約配置+適配器+基礎(chǔ)設(shè)施的標(biāo)準(zhǔn)模板,只需做合約配置即可(通知/核身/存證上鏈等場(chǎng)景適合)
- 使用
- 低代碼:在Flow底座中完成業(yè)務(wù)組件的編排/發(fā)現(xiàn)和觸發(fā),一次性編碼;完成Flow配置,即完成業(yè)務(wù)組件的裝配
3 基礎(chǔ)設(shè)施
注:此處的基礎(chǔ)設(shè)施與DDD中的概念有很大差異,請(qǐng)勿混淆
規(guī)約
基礎(chǔ)設(shè)施是一套以高復(fù)用高內(nèi)聚低變化的外部服務(wù)能力為單位(interface)作聚合,開放給業(yè)務(wù)服務(wù)/業(yè)務(wù)組件使用的最小功能單元(method)
基礎(chǔ)設(shè)施可以是對(duì)渠道能力的封裝,如外部商家渠道服務(wù)/跨境渠道服務(wù)等;也可以是對(duì)通用技術(shù)能力的封裝,如優(yōu)惠服務(wù)/商品服務(wù)/客戶服務(wù)等
基礎(chǔ)設(shè)施和業(yè)務(wù)服務(wù)的差異在于:前者的核心功能通常由外部服務(wù)提供,在當(dāng)前系統(tǒng)內(nèi)的核心職責(zé)是參數(shù)組裝/場(chǎng)景識(shí)別/返回解析和異常處理
基礎(chǔ)設(shè)施的定義不依賴于外部服務(wù),入?yún)樽孕卸x的標(biāo)準(zhǔn)POJO,返回值同樣以Result封裝,屏蔽外部服務(wù)的exception和業(yè)務(wù)異常,業(yè)務(wù)返回同樣是標(biāo)準(zhǔn)POJO
實(shí)例
- 基礎(chǔ)設(shè)施-信息通知
- public interface NotifyGateway {
- /**
- * 通知(郵件/短信/站內(nèi)信)
- * @param notifyInfo
- * @return
- */
- CommonResult<NotifyResponse> notify(NotifyInfo notifyInfo);
- }
搭建
- 新增/修改
- 硬編碼:基礎(chǔ)設(shè)施的接入通常是一次性的,低代碼的價(jià)值不易發(fā)揮
- 使用
- 硬編碼:在業(yè)務(wù)服務(wù)/業(yè)務(wù)組件等調(diào)用方代碼中,組裝入?yún)?>調(diào)用->解析返回
- 低代碼:在業(yè)務(wù)組件中,基于下文將介紹的適配機(jī)制,可以實(shí)現(xiàn):合約配置+模板化業(yè)務(wù)組件,低代碼復(fù)用現(xiàn)有基礎(chǔ)設(shè)施
4 模型適配
規(guī)約
- 模型適配用于銜接業(yè)務(wù)模型和基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù),實(shí)現(xiàn)模型->入?yún)⒑头祷?>模型的雙向處理
- 在模板化的業(yè)務(wù)組件中,適配器和基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù)的調(diào)用鏈已經(jīng)固化,各業(yè)務(wù)模型的組件實(shí)例只需要實(shí)現(xiàn)對(duì)應(yīng)的適配器,即可完成業(yè)務(wù)定制
- 適配器通常與產(chǎn)品合約配置結(jié)合,描述業(yè)務(wù)模型->基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù)入?yún)⒌挠成潢P(guān)系
實(shí)例
- 適配器-業(yè)務(wù)模型->網(wǎng)銀簽名
- public abstract class BizModelToDiscountAdapter<U extends BizModel> implements BizModelAdapter<U> {
- @Override
- final public String getType(){
- return "DISCOUNT";
- }
- /**
- * 生成扣減申請(qǐng)
- * @param bizModel
- * @return
- */
- abstract public OccupyInfo toOccupyInfo(U bizModel, AdapterConfigInfo configInfo);
- /**
- * 處理扣減結(jié)果
- * @param bizModel
- * @param result
- */
- abstract public void processOnOccupyResult(U bizModel, CommonResult<OccupyResponse> result);
- //...
- }
- 訂單模型Order,需要使用優(yōu)惠扣減服務(wù)時(shí),需要實(shí)現(xiàn)適配器BizModelToDiscountAdapter:
- @BizAdapter
- public class OrderToDiscountAdapter extends BizModelToDiscountAdapter<Order> {
- @Override
- public List<ConfigDef> getConfigDefs() {
- return Lists.newArrayList(
- ConfigEnum.DISCOUNT_TYPE,
- ConfigEnum.DISCOUNT_TERM
- );
- }
- @Override
- public OccupyInfo toOccupyInfo(Order bizModel, AdapterConfigInfo configInfo) {
- // 解析出客戶選擇的優(yōu)惠類型
- return new OccupyInfo();
- }
- @Override
- public void processOnOccupyResult(Order bizModel, CommonResult<OccupyResponse> result) {
- // TODO 根據(jù)扣減成功的優(yōu)惠,重新計(jì)算訂單金額
- }
- // ...
- }
搭建
- 新增/修改
- 定義-硬編碼:當(dāng)業(yè)務(wù)組件和基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù)出現(xiàn)調(diào)用關(guān)系時(shí)首次定義,通常不再變更
- 實(shí)現(xiàn)-低代碼:可以用一套靈活的合約配置描述映射關(guān)系,實(shí)現(xiàn)一次編碼后只需配置維護(hù);但是,這既依賴于DSL級(jí)別的描述能力,也需要業(yè)務(wù)模型和基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù)的設(shè)計(jì)者,都具備較高的抽象能力,成本較高
- 使用
- 硬編碼:當(dāng)業(yè)務(wù)開發(fā)抽象出可模板化的業(yè)務(wù)組件時(shí),即完成了首次接入;當(dāng)基礎(chǔ)設(shè)施/業(yè)務(wù)服務(wù)出現(xiàn)新模式時(shí),需要進(jìn)行適配調(diào)整
四 總結(jié)
啰嗦了這么多,為避免被過度細(xì)節(jié)沖淡主題。最后以幾個(gè)問題做個(gè)小結(jié):
1 業(yè)務(wù)設(shè)計(jì)規(guī)范體現(xiàn)在哪里?
架構(gòu)層面,從產(chǎn)品合約->業(yè)務(wù)領(lǐng)域->基礎(chǔ)設(shè)施,我們對(duì)應(yīng)用做了模塊拆解,在不同層面設(shè)計(jì)了業(yè)務(wù)規(guī)約,約束了各模塊的職責(zé);技術(shù)層面,通過多個(gè)底座組件,一定程度上實(shí)現(xiàn)了平臺(tái)和業(yè)務(wù)定制的隔離,限制了業(yè)務(wù)細(xì)節(jié)的無序散布。
2 業(yè)務(wù)設(shè)計(jì)只有合適沒有標(biāo)準(zhǔn),為何要強(qiáng)制規(guī)范?
規(guī)范的目的不是標(biāo)準(zhǔn)本身,本文提出的標(biāo)準(zhǔn)也未必適合所有問題域。想傳達(dá)的是,團(tuán)隊(duì)內(nèi)需要有業(yè)務(wù)設(shè)計(jì)的某種共識(shí)和沉淀,在每次迭代需求和每次項(xiàng)目產(chǎn)出的基礎(chǔ)上,持續(xù)積累持續(xù)重構(gòu)持續(xù)優(yōu)化,這對(duì)新人融入/個(gè)人成長(zhǎng)和團(tuán)隊(duì)協(xié)作都很有幫助。
3 如何快速支撐業(yè)務(wù),研發(fā)效能提升體現(xiàn)在哪里?
需要明確的是,對(duì)于全新的業(yè)務(wù)需求,不會(huì)帶來明顯的效能提升,甚至?xí)榱藵M足設(shè)計(jì)規(guī)范,帶來一定程度的額外成本。但當(dāng)多人協(xié)作,工作交接,或是現(xiàn)有功能部分可復(fù)用的場(chǎng)景下,會(huì)減少很多不必要的溝通和維護(hù)成本。舉例來說,當(dāng)一個(gè)業(yè)務(wù)需求出現(xiàn)時(shí),研發(fā)人員需要做如下判斷:
- 業(yè)務(wù)模型:是否需要新的業(yè)務(wù)模型,是否需要調(diào)整現(xiàn)有模型
- 業(yè)務(wù)服務(wù):xxxxxxxxxxxx業(yè)務(wù)服務(wù),xxxxxxxxxxxx現(xiàn)有服務(wù)
- 業(yè)務(wù)流程:xxxxxxxxxxxx業(yè)務(wù)流程,xxxxxxxxxxxx現(xiàn)有流程
- 業(yè)務(wù)組件:xxxxxxxxxxxx業(yè)務(wù)組件,xxxxxxxxxxxx現(xiàn)有組件
- 基礎(chǔ)設(shè)施:xxxxxxxxxxxx基礎(chǔ)設(shè)施,xxxxxxxxxxxx現(xiàn)有設(shè)施
- 產(chǎn)品合約/合約分組:基于上述判斷,評(píng)估產(chǎn)品合約和合約分組的組裝
帶來的效能提升有這樣幾點(diǎn):業(yè)務(wù)領(lǐng)域的每個(gè)模塊互相解耦,研發(fā)過程并行化,投入人員1+1可以=2;改造范圍更易于定位,資源評(píng)估更為準(zhǔn)確,進(jìn)度把控更加清晰;針對(duì)頻繁變動(dòng)且成本過高的模塊,進(jìn)行針對(duì)性的重構(gòu),影響范圍可控;上文中的很多處規(guī)約,都有潛在的低代碼化可能,能進(jìn)一步提升搭建效率。