強型別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一起使用等,但這是另一篇文章的故事!
原文作者: thomas levesque
原文連結:https://thomaslevesque.com/2020/10/30/using-csharp-9-records-as-strongly-typed-ids/
最後
歡迎掃碼關注我們的公眾號 【全球技術精選】,專注國外優秀部落格的翻譯和開源專案分享,也可以新增QQ群 897216102