架構(gòu)師必備 - DDD之落地實(shí)踐
哈嘍,大家好,我是指北君。
?今天帶大家認(rèn)識(shí)下DDD,一個(gè)聽(tīng)起來(lái)很垃圾卻真的很牛X的設(shè)計(jì)思想,架構(gòu)師必備!?
前言
在日常工作中,接手或維護(hù)的工程,大多數(shù)使用的是三層架構(gòu),即controller、service、dao三層,在使用的過(guò)程中,會(huì)遇到很多問(wèn)題:
- 面向數(shù)據(jù)建模,面向過(guò)程編程,沒(méi)有真正“面向?qū)ο蟆?/li>
- 只注重結(jié)果,不注重過(guò)程,service層動(dòng)輒數(shù)百上千行,充斥著過(guò)程代碼、膠水代碼,要么臃腫、要么流水賬、要不重復(fù)、要么邏輯分散,后期極難維護(hù)
- 代碼耦合嚴(yán)重,層與層之間互相調(diào)用、逆向調(diào)用,牽一發(fā)而動(dòng)全身
- 代碼無(wú)法體現(xiàn)業(yè)務(wù),在大家都不愛(ài)寫注釋的情況下,隨著時(shí)間的推移,代碼業(yè)務(wù)邏輯將無(wú)人理解,不敢改也改不動(dòng)。
那么有沒(méi)有一個(gè)好的解決方案呢?今天要講的DDD就是一個(gè)不錯(cuò)的選擇。
DDD
DDD,即領(lǐng)域驅(qū)動(dòng)設(shè)計(jì),完美的解決了以上問(wèn)題:
- 面向領(lǐng)域建模,面向?qū)ο缶幊?,代碼直接映射現(xiàn)實(shí)世界概念,貼近業(yè)務(wù),離客戶更近
- 領(lǐng)域邏輯高內(nèi)聚,符合Java開(kāi)發(fā)原則
- 技術(shù)細(xì)節(jié)變更如數(shù)據(jù)庫(kù)、緩存、定時(shí)器等的變更對(duì)業(yè)務(wù)邏輯影響比較小,非常適合插件式架構(gòu)
- 代碼可讀性、可維護(hù)性更強(qiáng),對(duì)后續(xù)擴(kuò)展、移植等支持更好,分層更加科學(xué)
DDD的概念,在網(wǎng)上很容易找到,這里就不贅述了。
然而網(wǎng)上DDD的文章雖然很多,但大多數(shù)是理論知識(shí),介紹的無(wú)非就是一些名詞:戰(zhàn)略設(shè)計(jì)、戰(zhàn)術(shù)設(shè)計(jì)、核心域、支撐域、值對(duì)象、實(shí)體、聚合... 對(duì)我們實(shí)際落地卻沒(méi)有太多的幫助,下面介紹下我在SpringBoot中應(yīng)用DDD的落地方案。
落地方案
1、代碼分層
代碼分層
- 用戶接口層:圖中的api包(即controller層,我嫌controller后綴太長(zhǎng)...)
- 應(yīng)用層:這里使用了命令模式,并且讀寫分離成了兩個(gè)包(command、query),如果不使用命令模式可以合并成一個(gè)service包
- 領(lǐng)域?qū)樱篸omain包,使用JPA(對(duì)DDD有良好的支持)
- 基礎(chǔ)設(shè)施層:infra包,其他所有的公用組件都放在這里,如果使用DIP依賴倒置,那么實(shí)現(xiàn)類也放在這里。
- model模型:model包,用于存放不同層間傳遞的對(duì)象,這些對(duì)象我試過(guò)放到好些地方,最后發(fā)現(xiàn)還是提出來(lái)統(tǒng)一放在一個(gè)包下比較好(便于服務(wù)間調(diào)用時(shí)共用對(duì)象)
2、層級(jí)關(guān)系及模型傳遞
分層及調(diào)用關(guān)系
3、分層詳細(xì)說(shuō)明
- api包(controller)
@Tag(name = "用戶", description = "用戶")
@RestController
@RequestMapping(value = "/api/sys-user")
public class SysUserApi extends BaseApi {
@ApiResult
@Operation(summary = "根據(jù)ID查詢用戶")
@GetMapping("/{id}")
public SysUserVo get(@PathVariable Long id) {
return queryExecutor.execute(new SysUserByIdQry(id));
}
@Pagination(total = true)
@ApiResult
@Operation(summary = "分頁(yè)查詢用戶")
@GetMapping
public List<SysUserVo> getList(SysUserQo sysUserQo) {
return queryExecutor.execute(new SysUserListQry(sysUserQo));
}
@ApiResult
@Operation(summary = "新增用戶")
@PostMapping
public void save(@Valid @RequestBody SysUserDto sysUserDto) {
commandExecutor.execute(new SysUserCommonCmd(sysUserDto));
}
}
在BaseApi中封裝了兩個(gè)命令執(zhí)行類queryExecutor和commandExecutor,調(diào)用應(yīng)用層時(shí)執(zhí)行不同的命令即可,無(wú)需@Autowired引入不同的服務(wù)
@ApiResult加上這個(gè)自定義注解后,對(duì)返回結(jié)果統(tǒng)一封裝
@Pagination加上這個(gè)自定義注解后,會(huì)自動(dòng)將分頁(yè)參數(shù)存入線程變量,后面查詢時(shí)也會(huì)自動(dòng)獲取分頁(yè)參數(shù),返回結(jié)果統(tǒng)一封裝時(shí)也會(huì)加上分頁(yè)信息
Qo是查詢參數(shù)對(duì)象,Dto是增刪改等命令參數(shù)對(duì)象,返回對(duì)象為Vo,這里要注意,Entity絕對(duì)不能暴露到這一層,需要轉(zhuǎn)換為Vo再返回
在這一層中,每個(gè)方法幾乎就是一行執(zhí)行命令的語(yǔ)句,一般情況不進(jìn)行業(yè)務(wù)邏輯(當(dāng)然也有特殊情況咯)
- command包
@AllArgsConstructor
public class SysDeptAddCmd implements Command<Void> {
private SysDeptDto sysDeptDto;
@Override
public Void execute(Executor executor) {
// 獲取命令的接收者:領(lǐng)域服務(wù)
SysDeptManager receiver = executor.getReceiver(SysDeptManager.class);
// 對(duì)象模型轉(zhuǎn)換,由DTO轉(zhuǎn)為Entity,使用了MapStruct
SysDept sysDept = SysDeptMapper.INSTANCE.toSysDept(sysDeptDto);
// 使用JPA保存
receiver.save(sysDept);
return null;
}
}
增刪改命令,很薄的一層,作為一項(xiàng)工作的組織者,幾乎沒(méi)有業(yè)務(wù)邏輯,調(diào)用領(lǐng)域服務(wù)和充血對(duì)象方法
命令模式,實(shí)現(xiàn)自定義Command接口,泛型為返回值
通過(guò)屬性和構(gòu)造方法(使用lombok注解)接收參數(shù)
一個(gè)命令里只有一個(gè)execute方法,缺點(diǎn)是會(huì)產(chǎn)生大量的命令類,一個(gè)類相當(dāng)于之前service類中的一個(gè)方法,但是這樣符合了單一職責(zé)原則
通過(guò)executor.getRecerver方法獲取到領(lǐng)域服務(wù)(manager)
DTO絕對(duì)不下探到領(lǐng)域?qū)又?,需要先由DTO轉(zhuǎn)換為Entity(轉(zhuǎn)換方法這里使用的MapStruct,以后再單獨(dú)細(xì)講)
- query包
@AllArgsConstructor
public class SysDeptByIdQry extends CommonQry<SysDeptVo> {
private Long id;
@Override
public SysDeptVo execute(Executor executor) {
if (id == null) {
throw new BusinessException("部門ID不能為空");
}
QSysDept sysDept = QSysDept.sysDept;
return queryFactory.select(this.fields())
.from(sysDept)
.where(sysDept.deleted.eq(false), sysDept.id.eq(id))
.fetchOne();
}
/**
* 部門VO映射
*
* @return QBean<SysDeptVo>
*/
public static QBean<SysDeptVo> fields() {
QSysDept sysDept = QSysDept.sysDept;
return Projections.fields(
SysDeptVo.class,
sysDept.deptName,
sysDept.orderNum,
sysDept.id
);
}
}
命令模式,繼承自定義CommonQry基類(此類也實(shí)現(xiàn)了自定義的Command接口,其中引用了QueryDSL的queryFactory類,且封裝了分頁(yè)方法),泛型為返回值
query包中的查詢命令與command包中的命令大體相同,唯一區(qū)別是query命令理論上直接查詢數(shù)據(jù)庫(kù),不調(diào)用領(lǐng)域?qū)?/p>
由于JPA對(duì)于復(fù)雜查詢不太好用,這里強(qiáng)烈推薦使用QueryDSL(以后再單獨(dú)細(xì)講),圖中是一個(gè)簡(jiǎn)單的使用例子
- domain包
類較多,代碼部分不一一羅列:
由Entity類自動(dòng)生成數(shù)據(jù)庫(kù)表,僅維護(hù)Entity類(屏蔽數(shù)據(jù)庫(kù))
設(shè)計(jì)Entity時(shí)根據(jù)實(shí)際業(yè)務(wù)靈活使用@OneToMany、@OneToOne等注解(聚合根的概念)
聚合根不要太大,80%的情況一個(gè)聚合根中只包含一個(gè)實(shí)體(不要過(guò)度設(shè)計(jì)成大聚合根)
不要使用貧血模型,而是要面向?qū)ο?,屬于?duì)象的方法要放到對(duì)象中,但是對(duì)象中不建議引入倉(cāng)庫(kù)repository類,需要操作數(shù)據(jù)庫(kù)的方法寫在領(lǐng)域服務(wù)manager里
業(yè)務(wù)邏輯盡量寫在領(lǐng)域服務(wù)(manager)中,不斷提取、抽象不同的方法供應(yīng)用層調(diào)用
適當(dāng)?shù)氖褂妙I(lǐng)域事件,JPA可以在Entity中使用@DomainEvents注解來(lái)發(fā)送領(lǐng)域事件
心得
通過(guò)DDD對(duì)業(yè)務(wù)理解更加透徹,寫的代碼可以更好的傳達(dá)客戶的業(yè)務(wù)訴求
能夠盡情的編寫低耦合的、符合單一職責(zé)、開(kāi)閉等原則、封裝、繼承、多態(tài)的代碼,是很身心愉悅的
前期相比傳統(tǒng)架構(gòu)代碼量更多,開(kāi)發(fā)人員前期投入更多:
- 領(lǐng)域的合理劃分、實(shí)體的合理設(shè)計(jì)
- 大量的DTO、VO等數(shù)據(jù)對(duì)象
- 大量的數(shù)據(jù)對(duì)象轉(zhuǎn)換方法
- 大量的命令類
- ...
但是,除非是特別簡(jiǎn)單的功能,對(duì)于一個(gè)中等復(fù)雜的系統(tǒng),這些前期的付出還是值得的,一張圖說(shuō)明:
小結(jié)
以上簡(jiǎn)單介紹了下我對(duì)DDD的理解和實(shí)踐,并通過(guò)實(shí)際的代碼展現(xiàn)了如何在SpringBoot中應(yīng)用DDD,希望能為大家提供一個(gè)思路。