以領域為核心重新設計的線上房貸申請系統 use DDD （2）

以領域為核心重新設計的線上房貸申請系統 use DDD （2）

直播的 Log 圖

前言

在前一篇文章：以領域為中心的：線上房貸申請系統設計 use DDD 中，筆者簡單的介紹一下以房貸線上申請為例子的的領域模型如何繪製、以及用一點時間將領域模型撰寫成基本的程式碼骨架，現在，本篇文章將接續直播的內容持續的調整程式碼。

Visual Studio 2019 的 .NET 5 的整潔架構骨架

這裡也同步的調整一開始的設計，也就是 Repositories 的擺放位置，一開始我是放在 Domain Service 也就是領域層，有網友發現表示以依賴反向來說，應是由 Application Service/Use Case Layer 來存取 Repositories，雖然 Entity 可以透過 Factory 來產生實例，但是 Entity 必須透過 Aggregate 來無持資料的完整性，但調用 Entities/Value Objects 本來就是 Application Services/Layer 的責任，所以 ICustomerDetailRepository 放置在 Application Seervice 是比較合理的，因為本來就是 Application 來操作 Aggregate Root 並維持資料的完整性。

圖（一）、透過常見的依賴反轉來解決問題 依賴反向 

圖片取自：Clean Architecture 無暇的程式碼 - 整潔的軟體架構設計篇

因為 Entity 本來就在 Domain Layer，為了領域邏輯的獨立性，並不應該直接相依 Repository，外部調用 Domain 需要領域邏輯來操作得依靠 DIP 即可解決該問題。

另外，補充說明，就是其實以『依賴反向』來說，Clean Architecture 的 Aggregate Root 要封裝 Domain Layer 的多個的 Entities/Value Objects 的操作來講，將 ICustomerDetailRepository 放置在 Application Layer 這是正確的。

怎麼說呢？以 Clean Architecture 整潔架構一書中這張圖來說明，HL1 依賴 <I> 介面，早期我們大多用 OO 中的多型來達到這個效果，就是 HL1 要呼叫 +Ｆ() 函式，但是透過一些特殊技巧比如多型、或是現在大家耳熟能詳的 DI ，就能讓執行時期，這個 <I> 其實是不存在的，也就是說，執行時期，其實 HL1 呼叫到的是下面 +F() 方法，這就是所謂的依賴向，以及控制反轉 IoC 的核心概念。

調整領域模型 - 增加需求

圖（二）、調整領域模型 

增加檢核特殊身分領域邏輯

如上圖，因應需求的異動，假設，客戶需要再新增帳號的申請裡增加檢查（帳號／身分證號）是否為特殊身分時，這時我們就真的有一個 Domain 領域邏輯了，因為各位有注意到嗎？我們一開始建立的 Domain Service 其實只是空有一層，但是並未包含任何領域邏輯，Entity 內也未實作或包含與申請相關的領域邏輯，現在我們可以在 Domain 專案裡新增一個 CustomerService.cs 來撰寫抽離出來的領域邏輯。

在開始之前，我得先做幾件事情：

（一）、將介面 ICustomerDetailRepository 搬至 Application 

（二）、將 DetailData.cs 的 Value Object 搬至 Domain （這是第二個放置錯誤的物件，Value Object 應該置於 Domain 層） 

（三）、在 ICustomerDetailRepository 增加取得 Customer 這個 Entity 實例的方法

ICustomerDetailRepository 介面的程式碼：

// Application
public interface ICustomerDetailRepository
{
    IEnumerable<CustomerDomain.Customer> GetCustomers();
    int Save(CustomerDomain.Customer customer);
    /// <summary>
    /// 取得 Entity 的實例
    /// </summary>
    /// <returns></returns>
    CustomerDomain.Customer Get(string guid);
}

Infrastructure Service 的 CustomerDetailRepository 的實作：

// Infrastructure
public class CustomerDetailRepository : ICustomerDetailRepository
{
    private static List<global::Domain.Customer.Customer> _customers = new List<global::Domain.Customer.Customer>();
    public int Save(global::Domain.Customer.Customer customer)
    {
        _customers.Add(customer);
        return 1;
    }

    public global::Domain.Customer.Customer Get(string guid)
    {
        return _customers.Where(c => c.GetCustomerId().Value.ToString() == guid)
            .FirstOrDefault();
    }

    public IEnumerable<global::Domain.Customer.Customer> GetCustomers()
    {
        return _customers;
    }
}

（四）、增加 CustomerId 的 GUID 的 TypedIdValueBase 型態 與 TypedIdValueBase 類別

public class CustomerId : TypedIdValueBase
{
    public CustomerId(Guid value) : base(value)
    {
    }
}

// TypedIdValueBase 的 Guid 類型的 == operator 比較運算子類別
public abstract class TypedIdValueBase : IEquatable<TypedIdValueBase>
{
    public Guid Value { get; }

    protected TypedIdValueBase(Guid value)
    {
        Value = value;
    }

    public override bool Equals(object obj)
    {
        if (ReferenceEquals(null, obj)) return false;
        return obj is TypedIdValueBase other && Equals(other);
    }

    public override int GetHashCode()
    {
        return Value.GetHashCode();
    }

    public bool Equals(TypedIdValueBase other)
    {
        return this.Value == other.Value;
    }

    public static bool operator ==(TypedIdValueBase obj1, TypedIdValueBase obj2)
    {
        if (object.Equals(obj1, null))
        {
            if (object.Equals(obj2, null))
            {
                return true;
            }
            return false;
        }
        return obj1.Equals(obj2);
    }
    public static bool operator !=(TypedIdValueBase x, TypedIdValueBase y)
    {
        return !(x == y);
    }
}

（五）、Customer 的 Entity 增加 Location 屬性 與 增加 檢查（帳號／身分證號）是否為特殊身分的領域邏輯方法 CheckSpecialUser()

因此，現在 Entity (Customer.cs) 的長相：

// Domain Layer
public class Customer: Entity, IAggegateRoot
{
    public Customer(string accountId, string chtName, string location)
    {
        _accountId = accountId;
        _chtName = chtName;
        _location = new DetailData(location);
        _customerid = new CustomerId(Guid.NewGuid());
    }
    
    private CustomerId _customerid;

    public CustomerId GetCustomerId()
    {
        return _customerid;
    }
    
    private string accountId;

    public string GetAccountId()
    {
        return accountId;
    }

    private string chtName;

    public string GetChtName()
    {
        return chtName;
    }

    private DetailData location;

    public DetailData GetLocation()
    {
        return location;
    }

    /// <summary>
    /// 檢查（帳號／身分證號）是否為特殊身分
    /// </summary>
    /// <param name="accountId"></param>
    /// <returns></returns>
    public bool CheckSpecialUser(string accountId)
    {
        return false;
    }

    public void ShowSpecialFlag()
    {
        // 針對如果是特殊身分進行相關的處裡
    }
}

目前只是先撰寫初骨架、先 return false，所以實際的邏輯其實還未撰寫實際的程式碼，不過這麼一來就容易的撰寫 Unit Test 來測試領域邏輯了。

（六）、增加 Domain Service 處裡特殊身分邏輯

這裡會需要呼叫行政機關的 Web API，所以目前並不在 Customer 實例化的時候處裡，直接抽離出一個領域邏輯，由 Application 需要時統籌並看時機呼叫使用。

public class CustomerService
{
    public CustomerService()
    {
    }

    /// <summary>
    /// 檢查是否為特出身分使用者
    /// 可能呼叫機關提供之服務以檢查是否為特殊身分國民
    /// </summary>
    /// <param name="customer">客戶物件實體</param>
    /// <param name="accountId">可能是身份證字號</param>
    /// <returns></returns>
    public void CheckIsSpecialAccount(Customer customer, string accountId)
    {
        bool isSpecial = customer.CheckSpecialUser(accountId);

        if (isSpecial)
        {
            customer.ShowSpecialFlag();
        }
    }
}

（七）、外部注入 Domain Service 並調整程式碼 現在，我們的 Application 的 CustomerBasicDetailRegisterHandler 可由外部注入 CustomerService，並將取得的 Entity 實例傳入進行特殊身分的判別與處裡了。

修改過後的 CustomerBasicDetailRegisterHandler.cs 程式碼如下：

// Application Layer
public class CustomerBasicDetailRegisterHandler
{
    public CustomerBasicDetailRegisterHandler(
        ICustomerDetailRepository customerDetailRepository, 
        CustomerService customerService)
    {
        _customerDetailRepository = customerDetailRepository;
        _customerService = customerService;
    }

    private ICustomerDetailRepository _customerDetailRepository;
    private CustomerService _customerService;

    public int AddCustomerDetailData(CustomerDetailDTO customerDeatil)
    {
        CustomerDetail.Customer customer 
            = new CustomerDetail.Customer(customerDeatil.UserId, customerDeatil.ChtName, customerDeatil.Location);

        // 檢查（帳號／身分證號）是否為特殊身分
        _customerService.CheckIsSpecialAccount(customer, customerDeatil.UserId);

        // Process and others..
        return _customerDetailRepository.Save(customer);
    }
}

最後，執行的結果當然與原先的相同，只是現在增加了領域邏輯。

詳細的範例原始檔案可參考 Github： 

https://github.com/wugelis/DDD-In-Depth-Net5Lab

若想了解 Guthub 上的 Visual Sutdio 2019 方案如何建立的可以參考下方影片。

直播網址 FB： 

https://www.facebook.com/will.fans/videos/1679528425584187

直播課程中的 Slide： 

https://www.slideshare.net/GelisWu/net-5/GelisWu/net-5

本篇文章會持續更新。

待續....... 

留言

張貼留言

這個網誌中的熱門文章

什麼是 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 也完全的跨平台。要在 .
閱讀完整內容

什麼是 gRPC（二）- 來撰寫第一個 Hello World 吧！

圖片
前言 上一篇 什麼是 gRPC ，筆者大致介紹了 gRPC Service 的基本概念，這一次，我們就來小試一下身手，撰寫一個 Hello World （迷之音：嘗試新技術時，總是得先來一個 Hello World ～我不想違背這良好傳統阿阿阿阿） 使用環境 Visual Studio 2019 .NET Core 3.0.100-preview3-010431 開始進行 撰寫 gRPC 除了先準備好基礎環境、選定一種 作業系統／ 程式語言 Language 外、（Framework／SDK／Runtime）等環境備妥後，就可以開始撰寫， (1). 開始撰寫 gRPC 第一步就是先定義 .proto 協議了 上一篇筆者提到，gRPC 的 Server 與 Client 必須使用相同的協議才可進行溝通，一般來說，你應該使用 protoc.exe 編譯器先行編譯過 greet.proto 協議檔，並產出 C# 程式碼檔案後才可繼續，而在 Visual Studio 2019 裡，拜 MSBuild 之賜，已經有人預先寫好 .Target 檔案了 （什麼是 MSBuild ？什麼是附檔名 .Target 檔案可參考： MSBuild .targets 檔案 ） 筆者先撰寫一個 SayHelloWorld 方法如下： 在協議裡，除了在 service Class 撰寫要公開存取的方法外， 必須在提供『傳入訊息型態』、『回傳訊息型態』 ，這邊我先定義兩個 message，一個是『 HelloMyFirstgRPC 』、另一個是『 HelloMyReply 』 在撰寫 proto 協議檔時，建議先決定 message 回傳型態與傳入的型態，那麼 Visual Studio 2019 會有 InteillSense 的完整支援。不得不說 Visual Studio 2019 在 .proto 協議編輯上的支援已經算不錯了。 注意： 一般來說，Visual Studio 2019 會在背景裡自動編譯 .proto 協議檔案，但始有可能不會有任何提示，所以您也可以自行使用命令列工具進行手動編譯，如下圖，若編譯失敗會出現錯誤訊息，如下圖顯示 return 關鍵字錯誤： protoc.exe 編譯器 & 相關 MSBuild Tools 會隨著 NuGet 套件在 Vis
閱讀完整內容

常見的程式碼壞味道（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 不過原歸正傳，我個人還是認為，其實適當
閱讀完整內容