參考阿里規范,優秀的 Java 項目代碼該如何分層?

1.背景

說起應用分層,大部分人都會認為這個不是很簡單嘛 就controller,service, mapper三層。看起來簡單,很多人其實并沒有把他們職責劃分開,在很多代碼中,controller做的邏輯比service還多,service往往當成透傳了,這其實是很多人開發代碼都沒有注意到的地方,反正功能也能用,至于放哪無所謂唄。這樣往往造成后面代碼無法復用,層級關系混亂,對后續代碼的維護非常麻煩。2021Java面試寶典

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

所以一個好的應用分層需要具備以下幾點:

  • 方便后續代碼進行維護擴展。

  • 分層的效果需要讓整個團隊都接受

  • 各個層職責邊界清晰

2.如何進行分層

2.1阿里規范

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

image

開放接口層: 可直接封裝 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優化分層

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

image

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

2.Service: 業務層,復用性較低,這里推薦每一個controller方法都得對應一個service,不要把業務編排放在controller中去做,為什么呢?

如果我們把業務編排放在controller層去做的話,如果以后我們要接入thrift,我們這里又需要把業務編排在做一次,這樣會導致我們每接入一個入口層這個代碼都得重新復制一份如下圖所示:

image

這樣大量的重復工作必定會導致我們開發效率下降,所以我們需要把業務編排邏輯都得放進service中去做:

image

3.Mannager: 可復用邏輯層。這里的Mannager可以是單個服務的,比如我們的cache,mq等等,當然也可以是復合的,當你需要調用多個Mannager的時候,這個可以合為一個Mannager,比如邏輯上的連表查詢等。如果是httpMannager或rpcMannager需要在這一層做一些數據轉換

4.DAO: 數據庫訪問層。主要負責“操作數據庫的某張表,映射到某個java對象”,dao應該只允許自己的Service訪問,其他Service要訪問我的數據必須通過對應的Service。

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類來傳輸。

每一個層基本都自己對應的領域模型,這樣就導致了有些人過于追求每一層都是用自己的領域模型,這樣就導致了一個對象可能會出現3次甚至4次轉換在一次請求中,當返回的時候同樣也會出現3-4次轉換,這樣有可能一次完整的請求-返回會出現很多次對象轉換。如果在開發中真的按照這么來,恐怕就別寫其他的了,一天就光寫這個重復無用的邏輯算了吧。

所以我們得采取一個折中的方案:

  1. 允許Service/Manager可以操作數據領域模型,對于這個層級來說,本來自己做的工作也是做的是業務邏輯處理和數據組裝。

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

  3. 同理,不允許DAO層的數據傳入到Controller/TService.

image

4.總結

總的來說業務分層對于代碼規范是比較重要,決定著以后的代碼是否可復用,是否職責清晰,邊界清晰。

當然這種分層其實見仁見智, 團隊中的所有人的分層習慣也不同,所以很難權衡出一個標準的準則,總的來說只要滿足職責邏輯清晰,后續維護容易,就是好的分層。2021Java面試寶典

最后,如果你的團隊有更好的分層,或者上面所描述的有什么錯誤的地方還請留言指正一下。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,797評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,179評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,628評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,642評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,444評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,948評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,040評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,185評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,717評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,794評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,418評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,414評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,750評論 2 370

推薦閱讀更多精彩內容