使用C#9中records作為強類型ID的實例教程

強類型ID

實體通常是整數,GUID或者string類型,因為數據庫直接支持這些類型,但是,如果實體的ID的類型是一樣的,比如都是整數的ID,這有可能會出現ID值傳錯的問題,看下邊的示例。

public void AddProductToOrder(int orderId, int productId, int count)
{
 ...
}

...

// 這個地方,參數傳錯瞭
AddProductToOrder(productId, orderId, int count);

上面的代碼可以很好地通過檢查並編譯,但是在運行的時候就出問題瞭,這是邏輯bug。

幸運的是,可以定義強類型id來解決這個問題,這個想法很簡單,為每個實體的ID聲明一個特定的類型,現在需要這樣寫:

// 使用強類型ID代替整數ID
public void AddProductToOrder(OrderId orderId, ProductId productId, int count)
{
 ...
}

...

// 這個地方,參數傳錯瞭
AddProductToOrder(productId, orderId, int count);

在上面的代碼中,我們犯瞭與第一個示例相同的錯誤(交換productId和orderId),但是在這種情況下,類型不同,因此編譯器會捕獲該錯誤並報告錯誤,我們仍然需要對其進行修復,但是至少在生產中並沒有爆炸。

編寫一個強類型的id

public readonly struct ProductId : IEquatable<ProductId>
{
 public ProductId(int value)
 {
  Value = value;
 }
 
 public int Value { get; }

 public bool Equals(ProductId other) => other.Value == Value;
 public override bool Equals(object obj) => obj is ProductId other && Equals(other);
 public override int GetHashCode() => Value.GetHashCode();
 public override string ToString() => $"ProductId {Value}";
 public static bool operator ==(ProductId a, ProductId b) => a.Equals(b);
 public static bool operator !=(ProductId a, ProductId b) => !a.Equals(b);
}

上面的代碼沒什麼難的,但是如果每個實體都需要的話,那確實有點麻煩,在C# 9 可以使用source generators來完成這些,但是C# 9還引入瞭另一個功能,使用起來更方便。

Record類型

Record 類型是具有內置不變性和值語義的引用類型,它和上面我們寫的強類型是一樣的(手動寫的成員實現Equals,GetHashCode等等),在代碼中使用也非常簡潔, 如果我們ProductId使用record重寫類型,就是下邊這樣:

public record ProductId(int Value);

是的,您沒看錯,這是一行,而上面的代碼是一大段,它完成瞭我們手動執行的所有操作(實際上,還多瞭很多!)。

主要區別在於:我們的手動實現是struct,即值類型,但是記錄是引用類型,這意味著它們可以為null,這可能不是主要問題,尤其是在使用可為空的引用類型的情況下,但是要知道這一點。

現在為模型中的每個實體編寫一個強類型的id是不是很簡單,使用Record 非常方便,當然,還有其他問題需要考慮,例如JSON序列化,與Entity Framework Core一起使用等,但這是另一篇文章的故事!

總結

到此這篇關於使用C#9中records作為強類型ID的文章就介紹到這瞭,更多相關C#9 records作強類型ID內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

原文作者: thomas levesque

原文鏈接:https://thomaslevesque.com/2020/10/30/using-csharp-9-records-as-strongly-typed-ids/

推薦閱讀: