在阿里Java大牛們都是這樣對Java專案程式碼分層的
阿新 • • 發佈:2019-12-31
作者:咖啡拿鐵
程式碼分層,對於任何一個Java開發來說應該都不陌生。一個好的層次劃分不僅可以能使程式碼結構更加清楚,還可以使專案分工更加明確,可讀性大大提升,更加有利於後期的維護和升級。
從另外一個角度來看,好的程式碼分層架構,應該是可以很好的匹配上單一職責原則的。這樣就可以降低層與層之間的依賴,還能最大程度的複用各層的邏輯。本文就來介紹下Java 專案的程式碼到底應該如何分層。
從我們的業務開發中總結了一個較為的理想模型,這裡要先說明一下由於我們的rpc框架選用的是thrift可能會比其他的一些rpc框架例如dubbo會多出一層,作用和controller層類似
最上層controller和TService是我們阿里分層規範裡面的第一層:輕業務邏輯,引數校驗,異常兜底。通常這種介面可以輕易更換介面型別,所以業務邏輯必須要輕,甚至不做具體邏輯。
Service:業務層,複用性較低,這裡推薦每一個controller方法都得對應一個service,不要把業務編排放在controller中去做,為什麼呢?如果我們把業務編排放在controller層去做的話,如果以後我們要接入thrift,我們這裡又需要把業務編排在做一次,這樣會導致我們每接入一個入口層這個程式碼都得重新複製一份如下圖所示:
這樣大量的重複工作必定會導致我們開發效率下降,所以我們需要把業務編排邏輯都得放進service中去做:
Mannager:可複用邏輯層。這裡的Mannager可以是單個服務的,比如我們的cache,mq等等,當然也可以是複合的,當你需要呼叫多個Mannager的時候,這個可以合為一個Mannager,比如邏輯上的連表查詢等。如果是httpMannager或rpcMannager需要在這一層做一些資料轉換
DAO:資料庫訪問層。主要負責“操作資料庫的某張表,對映到某個java物件”,dao應該只允許自己的Service訪問,其他Service要訪問我的資料必須通過對應的Service。
歡迎大家一起交流,喜歡文章記得點個贊喲,感謝支援!
1.背景
說起應用分層,大部分人都會認為這個不是很簡單嘛 就controller,service,mapper三層。看起來簡單,很多人其實並沒有把他們職責劃分開,在很多程式碼中,controller做的邏輯比service還多,service往往當成透傳了,這其實是很多人開發程式碼都沒有注意到的地方,反正功能也能用,至於放哪無所謂唄。這樣往往造成後面程式碼無法複用,層級關係混亂,對後續程式碼的維護非常麻煩。 的確在這些人眼中分層只是一個形式,前輩們的程式碼這麼寫的,其他專案程式碼這麼寫的,那麼我也這麼跟著寫。但是在真正的團隊開發中每個人的習慣都不同,寫出來的程式碼必然帶著自己的標籤,有的人習慣controller寫大量的業務邏輯,有的人習慣在service中之間呼叫遠端服務,這樣就導致了每個人的開發程式碼風格完全不同,後續其他人修改的時候,一看,我靠這個人寫的程式碼和我平常的習慣完全不同,修改的時候到底是按著自己以前的習慣改,還是跟著前輩們走,這又是個艱難的選擇,選擇一旦有偏差,你的後輩又維護你的程式碼的時候,恐怕就要罵人了。 所以一個好的應用分層需要具備以下幾點:- 方便後續程式碼進行維護擴充套件。
- 分層的效果需要讓整個團隊都接受
- 各個層職責邊界清晰
2.如何進行分層
2.1阿里規範 在阿里的編碼規範中約束的分層如下: 開放介面層:可直接封裝 Service 方法暴露成 RPC 介面;通過 Web 封裝成 http 介面;進行 閘道器安全控制、流量控制等。 終端顯示層:各個端的模板渲染並執行顯示的層。當前主要是 velocity 渲染,JS 渲染, JSP 渲染,移動端展示等。 Web 層:主要是對訪問控制進行轉發,各類基本引數校驗,或者不復用的業務簡單處理等。 Service 層:相對具體的業務邏輯服務層。 Manager 層:通用業務處理層,它有如下特徵:1. 對第三方平臺封裝的層,預處理返回結果及轉化異常資訊;2. 對Service層通用能力的下沉,如快取方案、中介軟體通用處理;3. 與DAO層互動,對多個DAO的組合複用。 DAO 層:資料訪問層,與底層 MySQL、Oracle、Hbase 進行資料互動。 阿里巴巴規約中的分層比較清晰簡單明瞭,但是描述得還是過於簡單了,以及service層和manager層有很多同學還是有點分不清楚之間的關係,就導致了很多專案中根本沒有Manager層的存在。下面介紹一下具體業務中應該如何實現分層 2.2優化分層3.分層領域模型的轉換
在阿里巴巴編碼規約中列舉了下面幾個領域模型規約:- DO(Data Object):與資料庫表結構一一對應,通過DAO層向上傳輸資料來源物件。
- DTO(Data Transfer Object):資料傳輸物件,Service或Manager向外傳輸的物件。
- BO(Business Object):業務物件。由Service層輸出的封裝業務邏輯的物件。
- AO(Application Object):應用物件。在Web層與Service層之間抽象的複用物件模型,極為貼近展示層,複用度不高。
- VO(View Object):顯示層物件,通常是Web向模板渲染引擎層傳輸的物件。
- Query:資料查詢物件,各層接收上層的查詢請求。注意超過2個引數的查詢封裝,禁止使用Map類來傳輸。
4.總結
總的來說業務分層對於程式碼規範是比較重要,決定著以後的程式碼是否可複用,是否職責清晰,邊界清晰。 當然這種分層其實見仁見智,團隊中的所有人的分層習慣也不同,所以很難權衡出一個標準的準則,總的來說只要滿足職責邏輯清晰,後續維護容易,就是好的分層。 最後,如果你的團隊有更好的分層,或者上面所描述的有什麼錯誤的地方還請留言指正一下。歡迎大家一起交流,喜歡文章記得點個贊喲,感謝支援!