快捷導(dǎo)航

使用C#9中records作為強(qiáng)類型ID的實(shí)例教程

更新時(shí)間：2021年01月17日 10:55:39 作者：SpringLeee

這篇文章主要給大家介紹了關(guān)于使用C#9中records作為強(qiáng)類型ID的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

強(qiáng)類型ID

實(shí)體通常是整數(shù)，GUID或者string類型，因?yàn)閿?shù)據(jù)庫(kù)直接支持這些類型，但是，如果實(shí)體的ID的類型是一樣的，比如都是整數(shù)的ID，這有可能會(huì)出現(xiàn)ID值傳錯(cuò)的問(wèn)題，看下邊的示例。

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

...

// 這個(gè)地方，參數(shù)傳錯(cuò)了
AddProductToOrder(productId, orderId, int count);

上面的代碼可以很好地通過(guò)檢查并編譯，但是在運(yùn)行的時(shí)候就出問(wèn)題了，這是邏輯bug。

幸運(yùn)的是，可以定義強(qiáng)類型id來(lái)解決這個(gè)問(wèn)題，這個(gè)想法很簡(jiǎn)單，為每個(gè)實(shí)體的ID聲明一個(gè)特定的類型，現(xiàn)在需要這樣寫(xiě)：

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

...

// 這個(gè)地方，參數(shù)傳錯(cuò)了
AddProductToOrder(productId, orderId, int count);

在上面的代碼中，我們犯了與第一個(gè)示例相同的錯(cuò)誤（交換productId和orderId），但是在這種情況下，類型不同，因此編譯器會(huì)捕獲該錯(cuò)誤并報(bào)告錯(cuò)誤,我們?nèi)匀恍枰獙?duì)其進(jìn)行修復(fù)，但是至少在生產(chǎn)中并沒(méi)有爆炸。

編寫(xiě)一個(gè)強(qiáng)類型的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);
}

上面的代碼沒(méi)什么難的，但是如果每個(gè)實(shí)體都需要的話，那確實(shí)有點(diǎn)麻煩，在C# 9 可以使用source generators來(lái)完成這些，但是C# 9還引入了另一個(gè)功能，使用起來(lái)更方便。

Record類型

Record 類型是具有內(nèi)置不變性和值語(yǔ)義的引用類型，它和上面我們寫(xiě)的強(qiáng)類型是一樣的（手動(dòng)寫(xiě)的成員實(shí)現(xiàn)Equals，GetHashCode等等），在代碼中使用也非常簡(jiǎn)潔，如果我們ProductId使用record重寫(xiě)類型，就是下邊這樣：

public record ProductId(int Value);

是的，您沒(méi)看錯(cuò)，這是一行，而上面的代碼是一大段，它完成了我們手動(dòng)執(zhí)行的所有操作（實(shí)際上，還多了很多?。?。

主要區(qū)別在于：我們的手動(dòng)實(shí)現(xiàn)是struct，即值類型，但是記錄是引用類型，這意味著它們可以為null，這可能不是主要問(wèn)題，尤其是在使用可為空的引用類型的情況下，但是要知道這一點(diǎn)。

現(xiàn)在為模型中的每個(gè)實(shí)體編寫(xiě)一個(gè)強(qiáng)類型的id是不是很簡(jiǎn)單，使用Record 非常方便，當(dāng)然，還有其他問(wèn)題需要考慮，例如JSON序列化，與Entity Framework Core一起使用等，但這是另一篇文章的故事！