FluentAssertions中接口类型字段的默认等价性比较行为解析

背景介绍

在使用FluentAssertions进行单元测试断言时，开发人员可能会遇到一个不太直观的行为：当比较两个包含接口类型字段的记录或类时，默认情况下BeEquivalentTo和NotBeEquivalentTo方法只会比较接口中定义的成员，而忽略实现类中的其他属性。

问题现象

考虑以下测试场景：我们有一个接口ISomething和一个实现该接口的TestClass类，后者包含一个MyField属性。当比较两个包含不同MyField值的TestParent记录实例时，使用NotBeEquivalentTo断言会意外通过，尽管它们的属性值明显不同。

public class TestClass : ISomething
{
    public required string MyField { get; init; }
}

public record TestParent(ISomething Something);

[Test]
public void TestEquivalency()
{
    var first = new TestParent(new TestClass { MyField = "biscuits" });
    var second = new TestParent(new TestClass { MyField = "donkeys" });
    
    first.Should().NotBeEquivalentTo(second); // 这个断言会意外通过
}

设计原理

FluentAssertions的这种行为是经过深思熟虑的设计决策。默认情况下，它基于编译时类型（即接口类型）进行比较，而不是运行时类型（即实际实现类）。这种设计有以下考虑：

1. 封装性原则：从接口使用者的角度看，它只关心接口契约定义的行为，不关心具体实现的内部细节。

2. 稳定性：如果具体实现类添加了新属性，不会意外导致现有测试失败。

3. 一致性：与C#语言本身的类型系统行为保持一致，编译时类型决定了可访问的成员。

解决方案

虽然默认行为可能不符合某些场景的需求，但FluentAssertions提供了灵活的配置选项：

1. 临时解决方案：在特定断言中启用运行时类型比较

first.Should().NotBeEquivalentTo(second, o => o.RespectingRuntimeTypes());

2. 全局配置：修改默认的等价性比较行为

AssertionOptions.AssertEquivalencyUsing(o => o.RespectingRuntimeTypes());

最佳实践建议

1. 在测试涉及接口和实现类的场景时，明确考虑你真正想要比较的是什么。

2. 如果测试的是接口契约，保持默认行为是合理的。

3. 如果测试需要验证具体实现类的完整状态，应该显式地使用RespectingRuntimeTypes选项。

4. 对于重要的测试场景，考虑添加注释说明为什么选择特定的比较策略，以提高代码可维护性。

总结

FluentAssertions的这一设计虽然初次接触时可能令人困惑，但它体现了良好的软件工程原则。理解这一行为背后的设计理念，能帮助开发人员更有效地使用这个强大的测试工具。在需要比较实现类完整状态时，记住使用RespectingRuntimeTypes选项即可获得期望的行为。