歡迎光臨
每天分享高質量文章

EF Core中避免貧血模型的三種行之有效的方法(翻譯)

[Paul Hiles: 3 ways to avoid an anemic domain model in EF Core :https://www.devtrends.co.uk/blog/3-ways-to-avoid-an-anemic-domain-model-in-ef-core]

1.引言

在使用ORM中(比如Entity Framework)貧血領域模型十分常見 。本篇文章將先探討貧血模型的問題,再去探究在EF Core中使用Code First時如何使用簡單的方法來避免貧血模型。

2.什麼是貧血模型

在對領域建模後,輸出一系列類中僅包含一些簡單屬性宣告而不包含業務邏輯的模型,就屬於貧血模型。當使用Entity Framework時,它們不僅僅是簡單的資料持有者而且包含有一堆public getter和public setters:

  1. public class BlogPost
  2. {
  3.     public int Id { get; set; }
  4.     [Required]
  5.     [StringLength(250)]
  6.     public string Title { get; set; }
  7.     [Required]
  8.     [StringLength(500)]
  9.     public string Summary { get; set; }
  10.     [Required]
  11.     public string Body { get; set; }
  12.     public DateTime DateAdded { get; set; }
  13.     public DateTime? DatePublished { get; set; }
  14.     public BlogPostStatus Status { get; set; }
  15.     ...
  16. }

由於其完全缺乏面向物件編程的原則,因此貧血模型通常被描述為反樣式。他們需要呼叫者來完善驗證和其他業務邏輯。由於缺乏相應的抽象,就會導致代碼重覆、較差的資料完整性,以及增加高層模塊的複雜性。
貧血模型是十分常見的。從我的經驗來看,EF中超過80%的領域模型都是貧血模型。這並不奇怪。幾乎所有的文件和其他博客文章都以最簡單的方式展示了EF。他們專註於盡可能快地開始工作,而不是主張最佳實踐。

3.改造為更豐富的領域模型(充血模型)

下麵我們將討論三種簡單的方式去豐富你的貧血模型。這幾種方法都非常簡單,僅需要最小的改動。

3.1.移除無參公共建構式

除非你指定一個建構式,否則你的類將有一個預設的無引數建構式。這意味著你可以用下麵的方式實體化你的類:

  1. var blogPost = new BlogPost();

在大多數情況下,這是沒有意義的。領域物件通常至少需要一些資料才能使其有效。創建沒有任何資料(如標題或URL)的BlogPost實體是沒有意義的,因為其僅僅是一個實體化物件,但物件卻不包含狀態和行為,不滿足資料有效性。有些人不同意,但是DDD社區普遍認為確保領域物件始終有效是有意義的。為瞭解決這個問題,我們可以像處理其他OO類一樣對待我們的域類,並引入一個引數化的建構式:

  1. public BlogPost(string title, string summary, string body)
  2. {
  3.    if (string.IsNullOrWhiteSpace(title))
  4.    {
  5.        throw new ArgumentException("Title is required");
  6.    }
  7.    ...
  8.    Title = title;
  9.    Summary = summary;
  10.    Body = body;
  11.    DateAdded = DateTime.UtcNow;
  12. }

現在在呼叫代碼必須提供最少的資料來滿足約束(建構式)。這一變化提供了兩個積極成果:

  1. 任何新實體化的BlogPost物件現在都保證有效。作用於BlogPost的任何代碼都無需檢查其有效性。領域物件在實體化時自動校驗自身的有效性。
  2. 任何呼叫代碼都知道實體化物件所需的內容。使用無引數的建構式,很容易構造物件,但卻不知道必須要構建的資料才能保證資料有效性。

但不幸的是,在進行此更改後,您將發現在從資料庫中檢索物體時,您的EF代碼不再有效:

InvalidOperationException:在物體型別’BlogPost’上找不到無引數的建構式。為了創建’BlogPost’的實體,EF需要宣告一個無引數的建構式。

EF需要一個無引數的建構式來查詢該做什麼?幸運的是,儘管EF確實需要無引數建構式,但它並不要求建構式必須為public,所以我們可以為EF增加一個無參private建構式,同時強制呼叫代碼使用引數化建構式。擁有額外的建構式顯然並不理想,但這些妥協通常可以時ORM與OO代碼更好地配合。

  1. private BlogPost()
  2. {
  3.    // just for EF
  4. }
  5. public BlogPost(string title, string summary, string body)
  6. {
  7.    ...
  8. }

3.2. 刪除公共屬性中的set方法

上面介紹的引數化建構式確保在實體化時物件處於有效狀態。儘管如此,這並沒有阻止您將屬性值更改為無效值。要解決這個問題,我們有兩個選擇:

  1. 將驗證邏輯添加到屬性設置器
  2. 防止直接修改屬性,改為使用與用戶操作相對應的方法

向屬性設置器添加驗證是完全可以接受的,但意味著我們不能再使用自動屬性並且必須引入一個後臺欄位。顯然這不是什麼大問題:

  1. private string title;
  2. public string Title
  3. {
  4.    get { return title; }
  5.    set
  6.    {
  7.        if (string.IsNullOrWhiteSpace(value))
  8.        {
  9.            throw new ArgumentException("Title must contain a value");
  10.        }
  11.        title = value;
  12.    }
  13. }

第二種方式更受歡迎的主要原因在於它更接近地模擬了現實世界中發生的事情。用戶不是孤立地更新單個屬性,而是傾向於執行一組已知操作(由UI或API接口確定)。這些操作可能會導致一個或多個屬性被更新,但通常情況下更多。業務邏輯依賴於背景關係的場景是非常普遍的,這將會導致對屬性進行賦值的set中的驗證邏輯變得複雜而難以理解。作為基本示例,請考慮以下博客文章發佈流程:

  1. public void Publish()
  2. {
  3.    if (Status == BlogPostStatus.Draft || Status == BlogPostStatus.Archived)
  4.    {
  5.        if (Status == BlogPostStatus.Draft)
  6.        {
  7.            DatePublished = DateTime.UtcNow;
  8.        }
  9.        Status = BlogPostStatus.Published;
  10.    }
  11. }

在這個例子中,我們有一個Publish()方法,它有一些簡單的邏輯和兩個可以更新的屬性。我們也可以將其作為一個屬性的setter來實現,但它不太清晰,尤其是從另一個類中呼叫它時:

  1. blogPost.Status = BlogPostStatus.Published;

VS

  1. blogPost.Publish();

第一種方式的副作用是不能清晰的表達業務用例。

當然,你在大多數代碼庫中看到的是根本不在領域物件中進行驗證。相反,這種型別的邏輯可以在下一層找到。這可能導致:

  1. 更長的方法將領域特定的邏輯與編排、持久性和其他關註點混合在一起。
  2. 不同動作之間重覆的驗證邏輯。
  3. 由於外部依賴性(需要使用Mock)而難以測試純領域邏輯。

正如我們現在所期望的那樣,如果我們從每個屬性中徹底移除setter,EF將無法正常運行,但將訪問級別更改為private就可以很好地解決問題:

  1. public class BlogPost
  2. {
  3.    public int Id { get; private set; }
  4.    ...
  5. }

這樣,所有屬性在類之外都是只讀的。為了允許更新我們的領域類,我們引入了相應型別動作的方法,如上面所示的Publish方法。

通過刪除無引數建構式和公共屬性設置器並添加動作型別的方法,我們現在擁有了始終有效的領域物件,並包含了與所討論的物體直接相關的所有業務邏輯,這是一個很大的改進。我們已經使我們的代碼同時更加健壯和簡單。

雖然我們可以討論其他DDD概念,例如領域事件以及通過雙派遣樣式([double-dispatch pattern:http://idior.cnblogs.com/articles/325036.html])使用領域服務,但它們的優勢,特別是簡單性方面的優勢遠不是那麼明顯。
通常DDD概念中可以簡化代碼的是我們將在下麵討論的值物件的使用。

3.3.引入值物件

[值物件:https://martinfowler.com/bliki/ValueObject.html]是不可變的(實體化後不允許更改)沒有身份標識的物件。值物件通常可以用來代替領域物件中的一個或多個屬性。

值物件的經典示例包括貨幣,地址和坐標,但也可以使用值型別替換單個屬性,而不是使用字串或整型。例如,不是將電話號碼儲存為字串,而是可以創建一個帶有內置驗證的PhoneNumber值型別以及提取撥號代碼的方法等。

下麵的代碼顯示了一個實現為EF類使用的貨幣值物件:

  1. public class Money
  2. {
  3.    [StringLength(3)]
  4.    public string Currency { get; private set; }
  5.    public int Amount { get; private set; }
  6.    private Money()
  7.    {
  8.        // just for EF
  9.    }
  10.    public Money(string currency, int amount)
  11.    {
  12.        // todo validation
  13.        Currency = currency;
  14.        Amount = amount;
  15.    }
  16. }

貨幣和金額是內在聯繫的。為了使資料有效,這兩條信息都是必需的。因此,對它們進行建模是有道理的。請註意,引數化的建構式和私有屬性設置器的使用方式與我們在建模領域物件時所使用的完全相同。物體框架也需要一個私有無引數建構式。

在(RDBMS)資料持久性的背景關係中,值型別不存在於單獨的資料庫表中。為了讓我們在物體框架中使用值物件,需要一個小的改動。這取決於您使用的EF版本。

在EF6中,我們只需用[ComplexType]屬性修飾值物件:

  1. [ComplexType]
  2. public class Money
  3. {
  4.    ...
  5. }

在EF Core中,從版本2開始,我們可以使用Fluent API中不常用的OwnsOne方法:

  1. public class BlogContext : DbContext
  2. {
  3.    ...
  4.    public DbSet<BlogPost> BlogPosts { get; set; }
  5.    protected override void OnModelCreating(ModelBuilder modelBuilder)
  6.    {
  7.        modelBuilder.Entity<BlogPost>().OwnsOne(x => x.AdvertisingFee);
  8.    }
  9. }

這裡假定在我們的BlogPost物體上使用Money值物件,如下所示:

  1. public class BlogPost
  2. {
  3.    ...
  4.    public Money AdvertisingFee { get; private set; }
  5.    ...
  6. }

創建並運行遷移後,我們會發現我們的資料庫表現在包含兩個額外的列:

  1. AdvertisingFee_Currency
  2. AdvertisingFee_Amount

使用值物件的好處與向富領域模型的轉變非常相似。豐富的領域模型不需要呼叫代碼來驗證領域模型,並提供了一個定義良好的抽象來進行編程。一個值物件進行自我驗證,因此包含值物件屬性的領域模型本身不需要知道如何驗證值型別。所有非常清晰和簡單。

4. 溫馨提示

當您打算從貧血域模型轉移到更豐富的領域模型時,您將立即體會到將領域級的業務邏輯封裝在領域物件中的好處。請註意,儘管如此,嘗試並不是件容易的事。在您的領域物件上創建一個方法來執行驗證,然後更新多個屬性無疑是件好事。但從領域物件發送電子郵件或儲存到資料庫並不是您可能想要做的事情。重要的是要意識到,擁有豐富的領域模型並不否定另一層的需求來安排這些更高層次的關註。這是應用服務或命令處理程式的工作,具體取決於您的體系結構。

5.關於單元測試的說明

一個豐富的、自我驗證的領域模型的一個負面影響是它可以使測試變得更加困難。通過public setter,您可以簡單地將各個值分配給任何領域物件的屬性。這使您可以直接指定您需要的確切值,以便將物件置於特定狀態以進行測試。如果你鎖定你的屬性和建構式,那麼這種方法是不可能的。但這也不是一件壞事,它使單元測試變得稍微困難一點,但你所做的是確保你的測試是有效的。

另一方面,它也使得測試領域物件本身的邏輯非常簡單。儘管你的應用服務/命令處理程式的單元測試幾乎肯定會需要一定程度的模擬,但你應該發現大部分領域物件測試的構建要簡單得多,並且通常不需要依賴模擬。

6. 總結

本文介紹了三種非常簡單的技術,您可以使用Entity Framework和EF Core從貧血域模型轉換為更為豐富的領域模型。使用引數化的建構式可以確保我們的領域模型在實體化時有效。清除公共屬性setter確保我們的模型在其整個生命周期內保持有效狀態。在領域模型上內部執行驗證和引入更改狀態的方法使我們能夠集中業務邏輯並簡化呼叫代碼。最後,我們考察了值物件的使用,並解釋了他們如何進一步推進了這種簡化和邏輯封裝。

 

    赞(0)

    分享創造快樂