從整潔架構談自定義 NuGet 套件規劃與使用

從整潔架構談自定義 NuGet 套件規劃與使用



前言

我們在規劃框架與底層元件時，免不了會將框架的底層元件、像是你 UI 的 BasePage、或者是 MVC 中你自定義的 ViewPage 的 BaseViewPage 又或者是你自定義框架 Framework/Platform 的底層運作包裝成 NuGet 套件供使用該功能的各系統負責人使用，將特定功能包裝成 NuGet 套件再重複使用某些功能時非常的方便，它可能方便到有種魔力，甚至會讓你想將許多功能都包裝成 NuGet 套件以達到重複使用的目的。

問題的發生

現在問題來了，這也是我在客戶端發現到的一個現象。

客戶：Entity Framework 的資料存取功能適合包成一個 NuGet 套件嗎？

這裡問題來了... 我說：請問這個是指這個套件內容會包含 OR-Mapping 的 Entites/Repository 等內容嗎？😯

如果是，那這個可能不適合包成一個 NuGet 套件。（蝦～什麼？)

客戶接著會說：但是 Entity Framework 本身也是個套件。

我說：Entity Framework 本身由套件來提供這個當然沒有問題，但是你的 Repositories/Entities 以上那已經跟商業有關了？

客戶更疑惑了：我們在開發框架時，比如說我們的 Business Object 的 Base 不是就是由 NuGet 套件提供的嗎？

我說：你說的沒有錯！但是你現在是把 DataAccess Layer 包成了 NuGet 套件了，當然～沒錯你會認為 DataAccess 算是 Infrastructure 這的確是沒錯！但是這裡的 Infrastructure 應該算是（與你的 Domain/Business 無關的部分）也就是應該不包括你的 Entities 都可以包進 NuGet，那是不正確的。

這時客戶會說，這好難界定阿？老師你說 DataAccess 就是 Infrastructure，但是又不能包進 NuGet，那到底該怎麼做啊？🙁

當時，我我很即興的繪製一個【簡圖】來說明（而現在我將這簡圖用 PowerPoint 來畫更專業點的，若想查看原本的簡圖可看我在臉書的 PO 文：https://www.facebook.com/groups/361804473860062/permalink/7962208900486210/）、我引用 Clean Architecture 的概念（對！連套件規畫概念也是一樣的、學好整潔架構 Clean Architecture 你可以想通很多問題）像是現在的套件依賴問題。

從整潔架構解釋 NuGet 套件規劃方式

(1). 以領域核心來看，你的 DB 與 Common Utility 都算是最外層

(2). ORM 功能底層由 NuGet 提供沒有問題，但是你有發現『越上層』就不適合了，從 Repository 開始就不太適合了，甚至 Repository 應該由 Code Generate 來自動產生即可，因為那是會跟著你的『商業』變動的部分，這部分是不適合包成 NuGet 套件的。

(3). 而我們的商業都是由套件底層來提供，這也是沒有問題的，我們目前就是如此做的！

結論

你頂多可以將你 ADO.NET 的資料存取 / 與商業無關的 SQL Generator/Parameters 包裝成 NuGet 套件來共用，越往上層就應該會變動的商業部份了，這部分可能用精靈來產生可能比較適合。我記得我有一個擴充套件就是拿來產生 Repositories 的。

最後

所謂的套件依賴，指的是【套件】通常包裝的是【細節】(這是整潔架構中的定義)，因為 NuGet Packages 套件提供的通常是 Framework/Pltatform 也就是框架或平台等細節部分，通常是相依性的順序是框架相依 Application/Use Case 層，所以在 Application/Use Case 要使用外層的細節時應該要透過依賴反轉 DIP 來取用到外部的細節所提供的功能，那部份其實也是實作中最複雜的，在實務上有可能部分違反整潔架構的相依性原則的，那麼就看你決定哪一些套件綁定你的應用層，也就是未來的修改都會被這個套件所影響、包括測試、包括維護性等等。

留言

張貼留言

這個網誌中的熱門文章

軟體工程師 - 成長的 10 個階段

圖片
軟體工程師 - 成長的 10 個階段 前言 先前，我在 Study4 小聚 #6 分享的一場關於軟體工程師 & 架構設計的養成之路，在該議程中，我分享了軟體工程師的 10 個階段（你的階段如有雷同、應該是...純屬巧合。XDDD） 哪 10 個階段？ 我將軟體工程師的成長依序分為 10 個成長階段，因為隨著技能的提升，你該擴充的 不會只是只有軟體開發技術，溝通與協作能力尤其重要 ，也像是『康威定律』中所提到的， 你的軟件的設計 & 或系統設計本質上反映了企業的組織機構。系統各個模塊間的介面的設計，也反映了企業各個部門之間的信息流動和合作方式，這些技能再進行軟體架構設計時也息息相關 ，團隊在進行模組設計時需要頻繁的溝通，這些、都是是否能將軟體做好的關鍵因素。 如 Logo 圖片，我依序說明每個階段的成長歷程。 1). 初始開發階段、熟悉 Programming/Developer 階段（PM/PO/SD 給規格後加以實作出來），並能夠藉由 模仿 來學習。這是剛進入軟體產業的學習階段。 2). 此階段代表已懂得透過重構來讓程式碼有基本的可維護性 、已能熟用 DRY (Don't Repeat Yourself)，進入這個階段代表已經有基本的程式語言的基礎， 應付 Programming/Developer 日常 工作 上的需求基本上沒什麼太大的問題。 3). 這裡的專案收尾代表對於專案開發已經有某些程度的認知、掌握度。我所提的掌握度在於了解『技術債』的產生緣由 與 危害，在 Programming/Devloper 層面懂得透過 S.O.L.I.D./Design Patterns 解決問題 並 開始能夠 自我學習 + 自我成長 。 4). 我這裡用『紀錄』 代表能運用所學 + 將使用者需求運用 〔邏輯思考〕 與 〔抽象化〕 轉化為程式碼 + 並能 自我成長 將經驗保存下來。我認為這是跨越只是（寫程式／實作）進入另一個門檻的重要經驗與歷練。 這個階段花費的時間會較長一點，時間長短取決於個人歷練、經歷、學習的環境與工作內容。 5). 此階段含括上面所有技能，並能夠與〔團隊〕和〔客戶〕 溝通 與 協作 、並產生出〔產品〕。而所謂的協作代表，不只自身技術所長能應付本身開發工作工作所需，亦能帶領團隊解決軟體專案的大小事務、也能夠替...
閱讀完整內容

常見的程式碼壞味道（Code Smell or Bad Smell）

圖片
常見的程式碼壞味道（Code Smell or Bad Smell） 圖片取自：https://www.slideshare.net/ElMahdiBenzekri/art-of-refactoring-code-smells-and-microservices-antipatterns 前言 究竟重複的程式碼要不要共用它？傳統的軟體開發上，重複的程式碼幾乎被視為罪惡的來源，但是它真的有多可怕？ 常見的 Code Smells The Dispensable （一些可有可無的） Lazy Class (冗員類別） 如果一個類很少使用它會增加代碼庫的複雜性，從而阻礙開發。這樣的類可能是不必要的，它的功能可以成為另一個類的一部分。 Data Class (只有資料的類別） 一個類別只有包含『資料』未包含Methods，也就是說並未包含行為，不具行為模式的類別代表該『實例』容易被【其他類別所操控】。 Duplicate Code (重複的程式碼) 如描述，這也是上次有分享在我的 FB 社團 軟體開發之路［德國資深架構師給新手的建議］ 中有產生非常熱烈討論，這在社團朋友提醒下想起 Refactor 重構一書裡曾提過 rule of three 法則， 這個法則的定義是這樣的，有時部分程式碼重複其實是允許的（不是說重複一定是是被允許的）而是在某些 Context 情境下，該程式碼有一段時間不會衍伸別的功能 或 需求一段時間不會異動、且如要將它 DRY 會產生的『複雜度』或『花費時間』遠高於預估的時間 或 不值得在目前這個專案的節骨眼上花費這個時間來做這件事，加上它 DRY 產生的複雜度偶後產生的維護成本【遠高於】不 DRY 的情況下的維護本，那麼，在這個時候，這個異動頻率【極低】的程式碼就不需要花費這個時間來 DRY 了！！ 因為重點在於，重構是需要『成本』的。(迷之音：DRY 是種抽象化阿~😎) 這讓我想起之前，大約在 2016 年左右，在 101 的樓上某金融業客戶，曾經做過一個專案，這個專案就是因為客戶 DMZ 環境的因素，我讓內網的 Webside 與 DMZ 的網站保留了部分重複的程式碼，因為這段程式碼終年不需要異動，我也懶得花這個時間，而我居然也忘了這記件事情了.. 哈哈 Orz 不過原歸正傳，我個人還是認為，其實適當...
閱讀完整內容

什麼是 gRPC ？

圖片
圖片取自： https://grpc.io/docs/guides/ gRPC 是什麼？能吃嗎？ 在安裝了 .NET Core 3.0 之後，眼尖的朋友應該會發現，在新增 ASP.NET Core 網頁類型專案裡，會看見一個 gRPC Service 類型的專案，其實它也不是什麼很新的東西，早在十多年前 Google 就使用這樣的 RPC 協定進行一些大量的可靠性微服務的存取，聽到這，難道現有的 Web API 不可靠嗎？其實不是的，它主要用在移動設備等提供高效簡單且跨平台的通訊與熱插拔的驗證機制。 gRPC 的運作原理 gRPC 顧名思義，是種基於 RPC 的通訊協定，不同於 Web API 走的傳統 HTTP 基礎協定，它有點像是 Socket ，但應該說是基於 Socket， 或精確地來說它是基於 HTTP/2 的協定 ，gRPC 是種協議緩衝協定，它必須事先定義 IDL (Interface Definition Language) 描述檔，看到 IDL 對於一些熟悉 COM／DCOM 的朋友一定非常的熟悉，對！沒錯！就是類似的東西！但，這邊的 IDL 是用一種副檔名為 .proto 檔案來是先定義在分散式環境中，要傳輸的序列化結構資訊，當然它也可以跟 JSON 一起使用。 也就是說，要使用 gRPC 您必須先定義 .proto 協議，然後透過 Compile 的支援，編譯成特定語言框架。而很高興的是，C# 也支援了，然而其實根據官方的資料顯示，C# 應該在 .NET Core 2.1 開始就支援了，只是到了 .NET Core 3.0 才有樣版的支援。 而使用 gRPC 的協議緩衝區的服務可以做到 Stub 的機制，也就是說，它就像是許多 RPC 一樣，Client 在呼叫 Server 端時，其實是對 Stub 進行叫用，Stub 在這就像個緩衝區一般，但更細部的說，應該是一個遠程服務的替身，這應該又讓許多熟悉 COM／RPC 通訊的朋友覺得熟悉了起來，是的！沒有錯。 在 .NET Core 3.0 裡使用 gRPC 目前支援 .proto 擴展為 gRPC 協議緩衝區的編譯器只有 .NET Core 了 ， 根據 Github 上的說明 .NET Framework 4.5+ 以上或 Mono 4+ 以上也可支援，而 gRPC 也完全的跨平台。要在 ....
閱讀完整內容