C# 中的动态类型-技术圈

翻译自 Camilo Reyes 2018年10月15日的文章《Working with the Dynamic Type in C#》 ^[1]

.NET 4 中引入了动态类型。动态对象使您可以处理诸如 JSON 文档之类的结构，这些结构的组成可能要到运行时才能知道。在本文中，Camilo Reyes 解释了如何使用动态类型。

.NET 4.0 中引入的 dynamic 关键字为 C# 编程带来了一个范式转变。对于 C# 程序员来说，强类型系统之上的动态行为可能会让人感到不适 —— 当您在编译过程中失去类型安全性时，这似乎是一种倒退。

动态编程可能使您面临运行时错误。声明一个在执行过程中会发生变化的动态变量是可怕的，当开发人员对数据做出错误的假设时，代码质量就会受到影响。

对 C# 程序员来说，避免代码中的动态行为是合乎逻辑的，具有强类型的经典方法有很多好处。通过类型检查得到的数据类型的良好反馈对于正常运行的程序是至关重要的，一个好的类型系统可以更好地表达意图并减少代码中的歧义。

随着动态语言运行时（Dynamic Language Runtime，DLR）的引入，这对 C# 意味着什么呢？.NET 提供了丰富的类型系统，可用于编写企业级软件。让我们来仔细看看 dynamic 关键字，并探索一下它的功能。

类型层次结构

公共语言运行时（Common Language Runtime，CLR）中的每种类型都继承自 System.Object，现在，请重复阅读这句话，直到将其铭记于心。这意味着 object 类型是整个类型系统的公共父类。当我们研究更神奇的动态行为时，这一事实本身就能为我们提供帮助。这里的想法是开发这种“代码感”，以便于您了解如何驾驭 C# 中的动态类型。

为了演示这一点，您可以编写以下程序：

Console.WriteLine("long inherits from ValueType: " + typeof(long).IsSubclassOf(typeof(ValueType)));

我将忽略 using 语句直到本文结束，以保持对代码示例的专注。然后，我再介绍每个命名空间及其作用。这样我就不必重复说过的话，并提供了一个回顾所有类型的机会。

上面的代码在控制台中的运算结果为 True。.NET 中的 long 类型是值类型，因此它更像是枚举或结构体。ValueType 重写来自 object 类的默认行为。ValueType 的子类在栈（stack）上运行，它们的生命周期较短，效率更高。

要验证 ValueType 是继承自 System.Object 的，请执行以下代码：

Console.WriteLine("ValueType inherits from System.Object: " + typeof(ValueType).IsSubclassOf(typeof(Object)));

它的运算结果为 True。这是一条可以追溯到 System.Object 的继承链。对于值类型，链中至少有两个父级。

再看一下从 System.Object 派生的另一个 C# 类型，例如：

Console.WriteLine("string inherits from System.Object: " + typeof(string).IsSubclassOf(typeof(Object)));

此代码在控制台中显示为 True。另一种从 object 继承的类型是引用类型，引用类型在堆（heap）上分配并进行垃圾回收，CLR 管理着引用类型，并在必要时从堆中释放它们。

查看下图，您可以直观地看到 CLR 的类型系统：

值类型和引用类型都是 CLR 的基本构建块，这种优雅的类型系统在 .NET 4.0 和动态类型之前就有了。我建议您在使用 C# 中的类型时，在脑海中记住这张图。那么，DLR 是如何适应这张图的呢?

动态语言运行时（DLR）

动态语言运行时（Dynamic Language Runtime, DLR）是处理动态对象的一种便捷方法。比如，假设您有 XML 或 JSON 格式的数据，其中的成员事先并不知道。DLR 允许您使用自然代码来处理对象和访问成员。

对于 C#，这使您可以处理在编译时不知道其类型的库。动态类型消除了自然 API 代码中的万能字符串。这就开启了像 IronPython 一样位于 CLR 之上的动态语言。

可以将 DLR 视为支持三项主要服务：

表达式树，来自 System.Linq.Expressions 命名空间。编译器在运行时生成具有动态语言互操作性的表达式树。动态语言超出了本文的讨论范围，这里就不作介绍了。
调用站点缓存，即缓存动态操作的结果。DLR 缓存像 a + b 之类的操作，并存储 a 和 b 的特征。当执行动态操作时，DLR 将检索先前操作中可用的信息。
动态对象互操作性是可用于访问 DLR 的 C# 类型。这些类型包括 DynamicObject 和 ExpandoObject。可用的类型还有很多，但是在处理动态类型时请注意这两种类型。

要了解 DLR 和 CLR 是如何结合在一起的，请看下图：

DLR 位于 CLR 之上。回想一下，我说过的每种类型都是从 System.Object 派生而来的。嗯，这句话对于 CLR 是适用的，但是对于 DLR 呢？我们使用下面的程序来测试一下这个理论：

Console.WriteLine("ExpandoObject inherits from System.Object: " + typeof(ExpandoObject).IsSubclassOf(typeof(Object)));

Console.WriteLine("DynamicObject inherits from System.Object: " + typeof(DynamicObject).IsSubclassOf(typeof(Object)));

ExpandoObject 和 DynamicObject 在命令行中输出的值都是 True。可以将这两个类视为使用动态类型的基本构建块，它们清楚地描绘了两个运行时是如何结合在一起的。

一个 JSON 序列化程序

动态类型解决的一个问题是，当您有一个不知道其成员的 JSON HTTP 请求时，假设要在 C# 中使用此任意的 JSON。要解决这个问题，请将此 JSON 序列化为 C# 动态类型。

我将使用 Newtonsoft 序列化库，您可以通过 NuGet 添加此依赖项，例如：

dotnet add package Newtonsoft.Json –-version 11.0.2

您可以使用这个序列化程序来处理 ExpandoObject 和 DynamicObject。探索每种动态类型给动态编程带来了什么。

ExpandoObject 动态类型

ExpandoObject 是一种方便的类型，允许设置和检索动态成员。它实现了 IDynamicMetaObjectProvider，该接口允许在 DLR 中的语言之间共享实例。因为它实现了 IDictionary 和 IEnumerable，所以它也可以处理 CLR 中的类型。举例来说，它允许将 ExpandoObject 的实例转换为 IDictionary，然后像其它任意的 IDictionary 类型一样枚举成员。

要用 ExpandoObject 处理任意 JSON，您可以编写以下程序：

var exObj = JsonConvert.DeserializeObject("{\"a\":1}") as dynamic;

Console.WriteLine($"exObj.a = {exObj?.a}, type of {exObj?.a.GetType()}");
//exObj.a = 1, type of System.Int64

它将会在控制台打印 1 和 long。请注意，尽管它是一个动态 JSON，但它会绑定到 CLR 中的 C# 类型。由于数字的类型未知，因此序列化程序默认会选择最大的 long 类型。注意，我成功地将序列化结果转换成了具有 null 检查的 dynamic 类型，其原因是序列化程序返回来自 CLR 的 object 类型。因为 ExpandoObject 继承自 System.Object，所以可以被拆箱成 DLR 类型。

更奇妙的是，可以用 IDictionary 枚举 exObj：

foreach (var exObjProp in exObj as IDictionary<string, object> ?? new Dictionary<string, object>())
{
    Console.WriteLine($"IDictionary = {exObjProp.Key}: {exObjProp.Value}");
}

它在控制台中输出 IDictionary = a: 1。请确保使用 string 和 object 作为键和值的类型。否则，将在转换的过程中抛出 RuntimeBinderException 异常。

DynamicObject 动态类型

DynamicObject 提供对动态类型的精确控制。您可以继承该类型并重写动态行为。例如，您可以定义如何设置和获取类型中的动态成员。DynamicObject 允许您通过重写选择实现哪些动态操作。这比实现 IDynamicMetaObjectProvider 的语言实现方式更易访问。它是一个抽象类，需要继承它而不是实例化它。该类有 14 个虚方法，它们定义了类型的动态操作，每个虚方法都允许重写以指定动态行为。

假设您想要精确控制动态 JSON 中的内容。尽管事先不知道其属性，您却可以使用 DynamicObject 来控制类型。

让我们来重写三个方法，TryGetMember、TrySetMember 和 GetDynamicMemberNames：

public class TypedDynamicJson<T> : DynamicObject
{
    private readonly IDictionary<string, T> _typedProperty;

    public TypedDynamicJson()
    {
        _typedProperty = new Dictionary<string, T>();
    }

    public override bool TryGetMember(GetMemberBinder binder, out object result)
    {
        T typedObj;

        if (_typedProperty.TryGetValue(binder.Name, out typedObj))
        {
            result = typedObj;

            return true;
        }

        result = null;

        return false;
    }

    public override bool TrySetMember(SetMemberBinder binder, object value)
    {
        if (value.GetType() != typeof(T))
        {
            return false;
        }

        _typedProperty[binder.Name] = (T)value;

        return true;
    }

    public override IEnumerable<string> GetDynamicMemberNames()
    {
        return _typedProperty.Keys;
    }
}

C# 泛型强类型 _typedProperty 以泛型的方式驱动成员类型。这意味着其属性类型来自泛型类型 T。动态 JSON 成员位于字典中，并且仅存储泛型类型。此动态类型允许同一类型的同类成员集合。尽管它允许动态成员集，但您可以强类型其行为。假设您只关心任意 JSON 中的 long 类型：

var dynObj = JsonConvert.DeserializeObjectlong>>("{\"a\":1,\"b\":\"1\"}") as dynamic;
Console.WriteLine($"dynObj.a = {dynObj?.a}, type of {dynObj?.a.GetType()}");

var members = string.Join(",", dynObj?.GetDynamicMemberNames());
Console.WriteLine($"dynObj member names: {members}");

结果是，您将看到一个值为 1 的属性，因为第二个属性是 string 类型。如果将泛型类型更改为 string，将会获得第二个属性。

类型结果

到目前为止，已经涉及了相当多的领域; 以下是一些亮点：

CLR 和 DLR 中的所有类型都继承自 System.Object
DLR 是所有动态操作发生的地方
ExpandoObject 实现了 CLR 中诸如 IDictionary 的可枚举类型
DynamicObject 通过虚方法对动态类型进行精确控制

看一下在控制台的结果截图：

单元测试

对于单元测试，我将使用 xUnit 测试框架。在 .NET Core 中，您可以使用 dotnet new xunit 命令添加一个测试项目。一个显而易见的问题是模拟和验证动态参数，例如，假设您想验证一个方法调用是否具有动态属性。

要使用 Moq 模拟库，您可以通过 NuGet 添加此依赖项，例如：

dotnet add package Moq –-version 4.10.0

假设您有一个接口，其想法是验证它是否被正确的动态对象调用。

public interface IMessageBus
{
  void Send(dynamic message);
}

忽略该接口的实现。这些实现细节对于编写单元测试不是必需的。下面是被测试的系统：

public class MessageService
{
    private readonly IMessageBus _messageBus;

    public MessageService(IMessageBus messageBus)
    {
        _messageBus = messageBus;
    }

    public void SendRawJson<T>(string json)
    {
        var message = JsonConvert.DeserializeObject(json) as dynamic;

        _messageBus.Send(message);
    }
}

您可以使用泛型，这样就可以为序列化程序传入动态类型。然后调用 IMessageBus 并发送动态消息。被测试的方法接受一个 string 参数，并使用 dynamic 类型进行调用。

对于单元测试，请将其封装在 MessageServiceTests 类中。首先初始化 Mock 和被测试的服务：

public class MessageServiceTests
{
    private readonly Mock _messageBus;
    private readonly MessageService _service;

    public MessageServiceTests()
    {
        _messageBus = new Mock();

        _service = new MessageService(_messageBus.Object);
    }
}

使用 Moq 库中的 C# 泛型来模拟 IMessageBus，然后使用 Object 属性创建一个模拟实例。在所有的单元测试中私有实例变量都很有用，高可重用性的私有实例增加了类的内聚性。

使用 Moq 验证调用，一种直观的方式是尝试这么做：

_messageBus.Verify(m => m.Send(It.Is(o => o != null && (o as dynamic).a == 1)));

但是，遗憾的是，您将看到这样的错误消息：“表达式树不能包含动态操作。” 这是因为 C# lambda 表达式无法访问 DLR，它期望一个来自 CLR 的类型，这使得此动态参数难以验证。记得您的训练，利用您的“代码感”来解决这个问题。

要处理诸如类型之间不一致的问题，请使用 Callback 方法：

dynamic message = null;

_messageBus.Setup(m => m.Send(It.IsAny())).Callback<object>(o => message = o);

请注意，Callback 方法将类型转换为 System.Object。因为所有类型都继承自 object 类型，所以可以将其赋值为 dynamic 类型。C# 可以把此 lambda 表达式中的 object 拆箱成 dynamic message。

是时候为 ExpandoObject 类型编写一个漂亮的单元测试了。使用 xUnit 作为测试框架，您将看到带有 Fact 属性的方法。

[Fact]
public void SendsWithExpandoObject()
{
    // arrange
    const string json = "{\"a\":1}";
    dynamic message = null;

    _messageBus.Setup(m => m.Send(It.IsAny())).Callback<object>(o => message = o);

    // act
    _service.SendRawJson(json);

    // assert
    Assert.NotNull(message);
    Assert.Equal(1, message.a);
}

使用 DynamicObject 类型进行测试，重用您之前看到的 TypedDynamicJson：

[Fact]
public void SendsWithDynamicObject()
{
    // arrange
    const string json = "{\"a\":1,\"b\":\"1\"}";
    dynamic message = null;

    _messageBus.Setup(m => m.Send(It.IsAnylong>>())).Callback<object>(o => message = o);

    // act
    _service.SendRawJsonlong>>(json);

    // assert
    Assert.NotNull(message);
    Assert.Equal(1, message.a);
    Assert.Equal("a", string.Join(",", message.GetDynamicMemberNames()));
}