使用C#9中records作为强类型ID的实例教程

231 阅读 0 评论 153 点赞

我是靠谱客的博主细心毛衣，最近开发中收集的这篇文章主要介绍使用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还引入了另一个功能，使用起来更方便。