0
  • 聊天消息
  • 系統(tǒng)消息
  • 評(píng)論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會(huì)員中心
創(chuàng)作中心

完善資料讓更多小伙伴認(rèn)識(shí)你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

優(yōu)秀的代碼都是如何分層的?看了直呼NB!

jf_ro2CN3Fa ? 來源:芋道源碼 ? 2023-06-09 14:39 ? 次閱讀

1.背景

說起應(yīng)用分層,大部分人都會(huì)認(rèn)為這個(gè)不是很簡(jiǎn)單嘛 就controller,service, mapper三層。看起來簡(jiǎn)單,很多人其實(shí)并沒有把他們職責(zé)劃分開,在很多代碼中,controller做的邏輯比service還多,service往往當(dāng)成透?jìng)髁?,這其實(shí)是很多人開發(fā)代碼都沒有注意到的地方,反正功能也能用,至于放哪無所謂唄。這樣往往造成后面代碼無法復(fù)用,層級(jí)關(guān)系混亂,對(duì)后續(xù)代碼的維護(hù)非常麻煩。

的確在這些人眼中分層只是一個(gè)形式,前輩們的代碼這么寫的,其他項(xiàng)目代碼這么寫的,那么我也這么跟著寫。但是在真正的團(tuán)隊(duì)開發(fā)中每個(gè)人的習(xí)慣都不同,寫出來的代碼必然帶著自己的標(biāo)簽,有的人習(xí)慣controller寫大量的業(yè)務(wù)邏輯,有的人習(xí)慣在service中之間調(diào)用遠(yuǎn)程服務(wù),這樣就導(dǎo)致了每個(gè)人的開發(fā)代碼風(fēng)格完全不同,后續(xù)其他人修改的時(shí)候,一看,我靠這個(gè)人寫的代碼和我平常的習(xí)慣完全不同,修改的時(shí)候到底是按著自己以前的習(xí)慣改,還是跟著前輩們走,這又是個(gè)艱難的選擇,選擇一旦有偏差,你的后輩又維護(hù)你的代碼的時(shí)候,恐怕就要罵人了。

所以一個(gè)好的應(yīng)用分層需要具備以下幾點(diǎn):

方便后續(xù)代碼進(jìn)行維護(hù)擴(kuò)展。

分層的效果需要讓整個(gè)團(tuán)隊(duì)都接受

各個(gè)層職責(zé)邊界清晰

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序,支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址:https://github.com/YunaiV/ruoyi-vue-pro

視頻教程:https://doc.iocoder.cn/video/

2.如何進(jìn)行分層

2.1阿里規(guī)范

在阿里的編碼規(guī)范中約束的分層如下:

35275a80-068c-11ee-962d-dac502259ad0.jpg

開放接口層:可直接封裝 Service 方法暴露成 RPC 接口;通過 Web 封裝成 http 接口;進(jìn)行 網(wǎng)關(guān)安全控制、流量控制等。

終端顯示層:各個(gè)端的模板渲染并執(zhí)行顯示的層。當(dāng)前主要是 velocity 渲染,JS 渲染, JSP 渲染,移動(dòng)端展示等。

Web 層:主要是對(duì)訪問控制進(jìn)行轉(zhuǎn)發(fā),各類基本參數(shù)校驗(yàn),或者不復(fù)用的業(yè)務(wù)簡(jiǎn)單處理等。

Service 層:相對(duì)具體的業(yè)務(wù)邏輯服務(wù)層。

Manager 層:通用業(yè)務(wù)處理層,它有如下特征:1. 對(duì)第三方平臺(tái)封裝的層,預(yù)處理返回結(jié)果及轉(zhuǎn)化異常信息;2. 對(duì)Service層通用能力的下沉,如緩存方案、中間件通用處理;3. 與DAO層交互,對(duì)多個(gè)DAO的組合復(fù)用。

DAO 層:數(shù)據(jù)訪問層,與底層 MySQL、Oracle、Hbase 進(jìn)行數(shù)據(jù)交互。

阿里巴巴規(guī)約中的分層比較清晰簡(jiǎn)單明了,但是描述得還是過于簡(jiǎn)單了,以及service層和manager層有很多同學(xué)還是有點(diǎn)分不清楚之間的關(guān)系,就導(dǎo)致了很多項(xiàng)目中根本沒有Manager層的存在。下面介紹一下具體業(yè)務(wù)中應(yīng)該如何實(shí)現(xiàn)分層

2.2優(yōu)化分層

從我們的業(yè)務(wù)開發(fā)中總結(jié)了一個(gè)較為的理想模型,這里要先說明一下由于我們的rpc框架選用的是thrift可能會(huì)比其他的一些rpc框架例如dubbo會(huì)多出一層,作用和controller層類似

352fb702-068c-11ee-962d-dac502259ad0.jpg

1.最上層controller和TService是我們阿里分層規(guī)范里面的第一層:輕業(yè)務(wù)邏輯,參數(shù)校驗(yàn),異常兜底。通常這種接口可以輕易更換接口類型,所以業(yè)務(wù)邏輯必須要輕,甚至不做具體邏輯。

2.Service:業(yè)務(wù)層,復(fù)用性較低,這里推薦每一個(gè)controller方法都得對(duì)應(yīng)一個(gè)service,不要把業(yè)務(wù)編排放在controller中去做,為什么呢?如果我們把業(yè)務(wù)編排放在controller層去做的話,如果以后我們要接入thrift,我們這里又需要把業(yè)務(wù)編排在做一次,這樣會(huì)導(dǎo)致我們每接入一個(gè)入口層這個(gè)代碼都得重新復(fù)制一份如下圖所示:

353c7492-068c-11ee-962d-dac502259ad0.jpg

這樣大量的重復(fù)工作必定會(huì)導(dǎo)致我們開發(fā)效率下降,所以我們需要把業(yè)務(wù)編排邏輯都得放進(jìn)service中去做:

3554a3be-068c-11ee-962d-dac502259ad0.jpg

3.Mannager:可復(fù)用邏輯層。這里的Mannager可以是單個(gè)服務(wù)的,比如我們的cache,mq等等,當(dāng)然也可以是復(fù)合的,當(dāng)你需要調(diào)用多個(gè)Mannager的時(shí)候,這個(gè)可以合為一個(gè)Mannager,比如邏輯上的連表查詢等。如果是httpMannager或rpcMannager需要在這一層做一些數(shù)據(jù)轉(zhuǎn)換

4.DAO:數(shù)據(jù)庫訪問層。主要負(fù)責(zé)“操作數(shù)據(jù)庫的某張表,映射到某個(gè)java對(duì)象”,dao應(yīng)該只允許自己的Service訪問,其他Service要訪問我的數(shù)據(jù)必須通過對(duì)應(yīng)的Service。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序,支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址:https://github.com/YunaiV/yudao-cloud

視頻教程:https://doc.iocoder.cn/video/

3.分層領(lǐng)域模型的轉(zhuǎn)換

在阿里巴巴編碼規(guī)約中列舉了下面幾個(gè)領(lǐng)域模型規(guī)約:

DO(Data Object):與數(shù)據(jù)庫表結(jié)構(gòu)一一對(duì)應(yīng),通過DAO層向上傳輸數(shù)據(jù)源對(duì)象。

DTO(Data Transfer Object):數(shù)據(jù)傳輸對(duì)象,Service或Manager向外傳輸?shù)膶?duì)象。

BO(Business Object):業(yè)務(wù)對(duì)象。由Service層輸出的封裝業(yè)務(wù)邏輯的對(duì)象。

AO(Application Object):應(yīng)用對(duì)象。在Web層與Service層之間抽象的復(fù)用對(duì)象模型,極為貼近展示層,復(fù)用度不高。

VO(View Object):顯示層對(duì)象,通常是Web向模板渲染引擎層傳輸?shù)膶?duì)象。

Query:數(shù)據(jù)查詢對(duì)象,各層接收上層的查詢請(qǐng)求。注意超過2個(gè)參數(shù)的查詢封裝,禁止使用Map類來傳輸。

層次 領(lǐng)域模型
Controller/TService VO/DTO
Service/Manager AO/BO
DAO DO

每一個(gè)層基本都自己對(duì)應(yīng)的領(lǐng)域模型,這樣就導(dǎo)致了有些人過于追求每一層都是用自己的領(lǐng)域模型,這樣就導(dǎo)致了一個(gè)對(duì)象可能會(huì)出現(xiàn)3次甚至4次轉(zhuǎn)換在一次請(qǐng)求中,當(dāng)返回的時(shí)候同樣也會(huì)出現(xiàn)3-4次轉(zhuǎn)換,這樣有可能一次完整的請(qǐng)求-返回會(huì)出現(xiàn)很多次對(duì)象轉(zhuǎn)換。如果在開發(fā)中真的按照這么來,恐怕就別寫其他的了,一天就光寫這個(gè)重復(fù)無用的邏輯算了吧。

所以我們得采取一個(gè)折中的方案:

1.允許Service/Manager可以操作數(shù)據(jù)領(lǐng)域模型,對(duì)于這個(gè)層級(jí)來說,本來自己做的工作也是做的是業(yè)務(wù)邏輯處理和數(shù)據(jù)組裝。

2.Controller/TService層的領(lǐng)域模型不允許傳入DAO層,這樣就不符合職責(zé)劃分了。

3.同理,不允許DAO層的數(shù)據(jù)傳入到Controller/TService.

356a162c-068c-11ee-962d-dac502259ad0.jpg

4.總結(jié)

總的來說業(yè)務(wù)分層對(duì)于代碼規(guī)范是比較重要,決定著以后的代碼是否可復(fù)用,是否職責(zé)清晰,邊界清晰。

當(dāng)然這種分層其實(shí)見仁見智, 團(tuán)隊(duì)中的所有人的分層習(xí)慣也不同,所以很難權(quán)衡出一個(gè)標(biāo)準(zhǔn)的準(zhǔn)則,總的來說只要滿足職責(zé)邏輯清晰,后續(xù)維護(hù)容易,就是好的分層。

最后,如果你的團(tuán)隊(duì)有更好的分層,或者上面所描述的有什么錯(cuò)誤的地方還請(qǐng)留言指正一下。

聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點(diǎn)僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場(chǎng)。文章及其配圖僅供工程師學(xué)習(xí)之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請(qǐng)聯(lián)系本站處理。 舉報(bào)投訴
  • 編碼
    +關(guān)注

    關(guān)注

    6

    文章

    921

    瀏覽量

    54714
  • 代碼
    +關(guān)注

    關(guān)注

    30

    文章

    4700

    瀏覽量

    68108

原文標(biāo)題:優(yōu)秀的代碼都是如何分層的?看了直呼NB!

文章出處:【微信號(hào):芋道源碼,微信公眾號(hào):芋道源碼】歡迎添加關(guān)注!文章轉(zhuǎn)載請(qǐng)注明出處。

收藏 人收藏

    評(píng)論

    相關(guān)推薦

    聊一聊MCU的軟件分層

    在功能實(shí)現(xiàn)上這段代碼沒有問題。但如果硬件做變動(dòng)呢?例如更換為其它品牌的mcu或者IO口更改呢?while(1)里面的代碼是不是都要發(fā)生變動(dòng)呢?不同的mcu底層庫是有區(qū)別的。換一個(gè)MCU要通篇改動(dòng)代碼非常惡心!工作量也巨大!非常有
    發(fā)表于 07-07 14:43 ?996次閱讀
    聊一聊MCU的軟件<b class='flag-5'>分層</b>

    請(qǐng)問LWIP使用標(biāo)準(zhǔn)的socket開發(fā)代碼都是無操作系統(tǒng)下的代碼?

    ,bind,等函數(shù),但是當(dāng)寫了代碼,我看了下,有個(gè)NO_SYS 定義成1了,即使我改成其他0,又有其他錯(cuò)誤。我看了下web_server,像什么tcp_recv都是注冊(cè)成回調(diào)函數(shù),請(qǐng)問
    發(fā)表于 09-16 06:51

    給嵌入式代碼也來個(gè)分層

    給嵌入式代碼也來個(gè)分層 一、遇到的問題代碼結(jié)構(gòu)也會(huì)有缺陷:(1)開發(fā)效率低:每次使用片內(nèi)的某一資源(例如定時(shí)器等),筆者都要去查詢CC2430中文手冊(cè),比較eggache~(2)代碼
    發(fā)表于 03-23 13:54

    MCU級(jí)軟件有必要分層

    一、MCU級(jí)軟件有必要分層嗎?1.1 如果不分層會(huì)怎樣?看下面這段示例代碼void main(){sys_init()while(1){ //用PA1控制LED亮滅GPIO_SetBits
    發(fā)表于 11-03 08:57

    ModBus主機(jī)底層的分層和軟件層面的任務(wù)調(diào)度

    開始本篇之前我想先談一下為什么要把一個(gè)ModBus主機(jī)分成4篇來寫,一是代碼分層理念,隨著工作時(shí)間的增長(zhǎng)以及工作的深入你會(huì)發(fā)現(xiàn)分層是那么的至關(guān)重要不僅僅是代碼的可讀性更重要的是更方便
    發(fā)表于 03-01 07:29

    【學(xué)習(xí)打卡】OpenHarmony的開源以及分層介紹

    例子,就像買房一樣,有些人買的是毛坯房,有些人買的是精裝修的房子,開源軟件更像是毛坯房,你買回來之后可以根據(jù)自己的需要進(jìn)行改裝,但是房子本身的水電都是齊全的。所謂的軟件分層中的層指的是代碼中的邏輯分隔
    發(fā)表于 07-11 17:36

    中科創(chuàng)達(dá)現(xiàn)場(chǎng)展出NB-IoT解決方案及其優(yōu)秀的應(yīng)用案例

    12月21日,中科創(chuàng)達(dá)攜Thundersoft TurboX? NB-IoT解決方案及其優(yōu)秀的應(yīng)用案例亮相ELEXCON深圳國(guó)際電子展暨嵌入式系統(tǒng)展。
    的頭像 發(fā)表于 12-29 09:36 ?5566次閱讀

    淺談Java Web項(xiàng)目代碼如何分層

    在軟件體系架構(gòu)設(shè)計(jì)中,分層式結(jié)構(gòu)是最常見,也是最重要的一種結(jié)構(gòu)。微軟推薦的分層式結(jié)構(gòu)一般分為三層,從下至上分別為:數(shù)據(jù)訪問層、業(yè)務(wù)邏輯層(又或稱為領(lǐng)域?qū)樱?、表示層。這也是Java Web中重要的三層架構(gòu)中的三個(gè)層次。區(qū)分層次的目
    發(fā)表于 05-11 10:23 ?3757次閱讀
    淺談Java Web項(xiàng)目<b class='flag-5'>代碼</b>如何<b class='flag-5'>分層</b>

    通信技術(shù)NB-IoT為什么可以這么優(yōu)秀?

    本文主要介紹了NB-IoT的行業(yè)應(yīng)用以及為什么NB-IoT這么優(yōu)秀的原因?
    的頭像 發(fā)表于 09-24 09:34 ?6408次閱讀
    通信技術(shù)<b class='flag-5'>NB</b>-IoT為什么可以這么<b class='flag-5'>優(yōu)秀</b>?

    都是通信技術(shù),NB-IoT為什么可以這么優(yōu)秀?

    景、NB-IoT技術(shù)優(yōu)勢(shì)以及NB-IoT技術(shù)是否能解決該應(yīng)用場(chǎng)景的一些難點(diǎn)。拋開成本問題不談,NB-IoT的海量連接、深度覆蓋、低功耗等優(yōu)勢(shì)都是需要前提條件的,了解這些前提條件與應(yīng)用場(chǎng)
    的頭像 發(fā)表于 10-25 19:43 ?4079次閱讀
    <b class='flag-5'>都是</b>通信技術(shù),<b class='flag-5'>NB</b>-IoT為什么可以這么<b class='flag-5'>優(yōu)秀</b>?

    如何進(jìn)行單片機(jī)代碼架構(gòu)的分層

    最近看了一個(gè)大神吳堅(jiān)鴻的文章,他的軟件架構(gòu)寫得還是不錯(cuò)的,但是代碼風(fēng)格一般,全局變量滿天飛,但開發(fā)出來的產(chǎn)品穩(wěn)定,性能也好。不管怎么說,在企業(yè)里,老板只追求結(jié)果,不追求過程,即使代碼寫得再不好,能實(shí)現(xiàn)功能就不錯(cuò)了。在這里,我借鑒
    發(fā)表于 06-12 17:45 ?1次下載
    如何進(jìn)行單片機(jī)<b class='flag-5'>代碼</b>架構(gòu)的<b class='flag-5'>分層</b>

    讓你看了頭大的代碼

    1、下面一段代碼將注釋和代碼混在了一起,不認(rèn)真看還真不知道。   高亮顯示后:   2、看到這種多層嵌套惡心
    的頭像 發(fā)表于 09-16 18:08 ?1609次閱讀
    讓你<b class='flag-5'>看了</b>頭大的<b class='flag-5'>代碼</b>

    九個(gè)單片機(jī)仿真優(yōu)秀案例及源代碼

    九個(gè)單片機(jī)仿真優(yōu)秀案例及源代碼
    發(fā)表于 03-17 09:13 ?161次下載
    九個(gè)單片機(jī)仿真<b class='flag-5'>優(yōu)秀</b>案例及源<b class='flag-5'>代碼</b>

    優(yōu)秀代碼的應(yīng)用分層都是如何實(shí)現(xiàn)的

    開放接口層:可直接封裝 Service 方法暴露成 RPC 接口;通過 Web 封裝成 http 接口;進(jìn)行 網(wǎng)關(guān)安全控制、流量控制等。
    的頭像 發(fā)表于 10-11 09:37 ?1182次閱讀

    Linux內(nèi)核代碼60%都是驅(qū)動(dòng)?

    為什么Linux內(nèi)核代碼60%都是驅(qū)動(dòng)? 如果每支持新的設(shè)備就加入驅(qū)動(dòng),內(nèi)核會(huì)不會(huì)變得越來越臃腫?
    的頭像 發(fā)表于 07-11 11:48 ?785次閱讀
    Linux內(nèi)核<b class='flag-5'>代碼</b>60%<b class='flag-5'>都是</b>驅(qū)動(dòng)?