The Clean Architecture
Robert C. Martin (Uncle Bob)
原文: https://blog.cleancoder.com/u...
譯:祝坤榮
在過去幾年我們看到關於系統架構的很多想法。這些包括:
- Alistair Cockburn的六邊形架構(也叫做埠與介面卡),Steve Freeman, 和 Nat Pryce在他們精彩的著作Growing Object Oriented Software( http://www.amazon.com/Growing... 。
- Jeffrey Palermo的Onion Architecture ( http://jeffreypalermo.com/blo...
- 去年一片部落格裡的 Screaming Architecture ( http://blog.cleancoders.com/2...
- James Coplien 與Trygve Reenskaug的DCI( http://www.amazon.com/Lean-Ar... 。
- Ivar Jacobson的書: Object Oriented Software Engineering: A Use-Case Driven Approach 的BCE( http://www.amazon.com/Object-... )
儘管這些架構在一些細節上都有不同,它們仍是相似的。他們都有同樣的目標,隔離關注點。他們都通過將軟體分層來達到隔離。每個都至少有一層業務規則,另一層作為介面。
每個這些架構產出的系統都是:
- 獨立的框架。架構不依賴一些存在類庫的特性。這樣你可以像工具一樣使用這種框架,而不需要讓你的系統受到它的約束條件。
- 可測試。業務規則可以脫離UI,資料庫,web伺服器或其他外部元素進行測試。
- 獨立的UI。UI可以很容易的更換,系統的其他部分不需要變更。例如,Web UI可以被換成控制檯UI,不需要變更業務規則。
- 獨立的資料庫。你可以交換Oracle或SQL Server,用於Mongo,BigTable,CouchDB或其他的東西。你的業務規則不與資料庫繫結。
- 獨立的外部代理。實際你的業務規則並不知道關於外部世界的任何事情。
這篇文章上面的圖試著將以上所有架構整合成一個可執行的想法。
依賴規則
同心圓表示軟體的不同部分。大體上,你走的越遠,軟體的級別更高。外部的圓是機制,內部的圓是策略。
讓這個架構工作的覆蓋規則是 依賴規則 。這個規則說明了原始碼依賴只能向內。內部圓不能知道任何外部圓的事。實踐中,外部圓裡一些宣告的名字不能被內部圓裡的程式碼提到。這包括,函式,類,變數或其他任何軟體實體。
同樣的,外部圓使用的資料格式不應該被內部圓使用,尤其是當這些格式是被外部圓使用的框架生成的時候。我們不想讓外部圓的東西影響到內部圓。
實體
實體封裝 企業域 範圍的業務規則。實體可以是一個有方法的物件,也可以是一組資料結構和函式。只要企業裡不同的應用可以使用這些實體就可以。
如果你不是企業級,而只是寫一個單體應用,那麼這些實體就是應用的業務物件。它們封裝了最通用和高層的規則。當外部變化時它們基本不太會變化。例如,你不會認為這些物件會因為頁面導航或安全方面的變化而改變。任何特定應用的操作都不應該影響實體層。
用例
這層的軟體包含 特定應用 的業務規則。它封裝並實現了系統的所有用例。這些用例組織了實體中的資料流向,並指揮這些實體使用他們的 企業域 業務規則來完成用例的目標。
我們不期望這層影響實體。我們也不希望這層會在如資料庫,UI,或其他常用框架這樣的外部變化時被影響。這層隔離了以上關注點。
當然我們期望對於應用操作的變化會影響用例而進一步影響到這層的軟體。 如果一個用例的細節變化了,那麼這層的程式碼肯定也會被影響。
介面介面卡
這層的軟體是一組介面卡,其將資料轉換成從用例和實體最合適的格式,到對於一些類似資料庫或網站這種外部設施最合適的格式。在這一層,舉個例子,會包含GUI的MVC架構。Presenters, Views,與Controllers都屬於這裡。模型基本就是從controllers傳遞到用例的資料結構,並從用例返回到presenters和views。
類似的,資料被轉換了,在這層,從對於實體和用例合適的結構,變成對於持久層框架使用的結構。這圈內的程式碼不應該知道資料庫。如果資料庫是一個SQL資料庫,那麼所有SQL都應該在這層內,特別是此層與資料庫有關的部分。
這層其他介面卡也需要將資料從類似外部服務的外部的結構,轉換成用例和實體使用的內部結構。
框架與驅動
最外層主要組合了資料庫,網路框架這樣的框架和工具。在這層你除了寫一些與內層環通訊的膠水程式碼,基本不會有其他程式碼。
這層是所有細節存在的地方。網路是細節。資料庫是細節。 我們將這些東西放在外部保證它們不會影響其他部分。
只有四個圈?
不是的,圓圈是個示意。你可能發現你需要不止4個。沒有規則說你一定要有四個。 實際上, 依賴規則 一直存在。原始碼依賴一直指向內部。當你向內部移動時抽象的層次在增加。最外部的圓是很低層的具體細節。當你內移時軟體變得更抽象,並封裝了高一級的策略規則。最內部的圓是最普遍的抽象層級。
跨越邊界
在圖的右下方是我們穿越圓圈邊界的示例。它展示了Controller和Presenter與下一層的用例進行通訊。注意控制流。它從controller出發,穿過用例,然後在presenter裡執行。也注意下原始碼依賴。它們每個都指向內部的用例。
我們通常使用 依賴反轉原則 解決這個明顯的問題。在java這樣的語言中,我們會整理原始碼依賴與控制流相反的介面和繼承關係,讓它們從邊界正確的穿過。
例如,用例需要呼叫presenter。但是,這個呼叫不能直接進行因為會違反 依賴規則 。外圈的名字不能被內圈提到。所以我們的用例呼叫內圈的一個介面(在這個例子裡是Use Case Output Port),並讓外圈的presenter實現它。
架構裡所有的邊界穿越都用這個技巧。我們使用動態多型來建立與控制流相反的原始碼依賴,以便於無論在控制流的任何方向都不會違反 依賴規則 。
什麼樣的資料會穿越邊界
正常來說穿過邊界的資料是簡單資料結構。你可以使用基本結構或簡單的Data Transfer 物件。或者可以方便的進行函式賦值的資料。或者你可以打包進一個hashmap,或者將它組裝成一個物件。重要的是穿過邊界的是隔離,簡單的資料結構。我們不想搞變通傳遞 實體 或資料庫行資料。我們不想資料結構有任何違反 依賴規則 的依賴。
例如,很多資料庫框架在查詢後返回一個方便的資料格式。我們可以叫它RowStructure(行結構)。我們不想將這個行機構通過邊界傳遞給內部的圈。這會導致內部圈需要知道外部圈的內容進而違反 依賴規則 。
所以當我們在邊界傳遞資料是,要注意其應該是內部圈的格式。
結論
遵從這些簡單規則並不難,並且能幫你減少以後的問題。通過將軟體隔離分層,並遵從 依賴規則 ,你可以建立一個真正可測試的系統,包含了以上所有好處。當任何系統額外部部分過時了,比如資料庫或web框架,你可以容易的替換這些過時的元素。
—
本文來自微信公眾號「麥芽麵包,id「darkjune_think」轉載請註明。
交流Email: [email protected]