FluentAssertions中记录结构体作为字典键时引发的格式化异常问题分析

问题背景

在使用FluentAssertions进行单元测试断言时，当开发者将record struct类型用作字典的键类型时，可能会遇到一个隐藏的格式化异常问题。这个问题源于FluentAssertions内部对记录结构体的字符串表示处理方式与.NET字符串格式化机制的冲突。

问题现象

当使用记录结构体作为字典键时，如果断言失败，FluentAssertions会尝试调用记录结构体的ToString()方法来生成错误信息。记录结构体的默认ToString()实现会生成类似MyStruct{ MyProperty = "Value" }的字符串，其中包含大括号{}。这些大括号恰好与.NET的字符串格式化语法冲突，导致后续的string.Format调用失败。

技术细节分析

记录结构体(record struct)是C# 10引入的新特性，它自动实现了值类型的记录功能。默认情况下，记录结构体的ToString()方法会生成包含所有属性的格式化字符串，并使用大括号包裹。例如：

public readonly record struct MyRecordStruct
{
    public string MyProperty { get; init; }
}

var instance = new MyRecordStruct { MyProperty = "Test" };
Console.WriteLine(instance.ToString()); 
// 输出: MyRecordStruct { MyProperty = Test }

当这样的字符串被传递到FluentAssertions的错误信息生成管道时，问题就出现了。FluentAssertions内部使用string.Format来构建最终的断言失败消息，而大括号在string.Format中具有特殊含义，用于参数替换。

解决方案

FluentAssertions团队通过使用AddNonReportable方法来安全地传递包含大括号的字符串，从而避免了直接使用string.Format时的解析问题。具体实现方式是将可能包含特殊字符的字符串作为非报告值添加到断言上下文中，然后在错误消息模板中引用这些值。

例如，原始的问题代码：

AssertionScope.Current.FailWith(
    "Expected {context} to be {0}{reason}, but found {1}.", expected, subject);

被修改为：

AssertionScope.Current.AddNonReportable("ValidateAgainstNulls", currentNode.Description);
AssertionScope.Current.FailWith(
    "Expected {ValidateAgainstNulls} to be {0}{reason}, but found {1}.", expected, subject);

这种修改确保了即使描述字符串中包含大括号，也不会被错误地解释为格式字符串的参数占位符。

影响范围

这个问题不仅影响记录结构体作为字典键的情况，还可能出现在以下场景：

1. 任何包含大括号的字符串作为字典键时
2. 记录结构体或类作为被断言对象时
3. 自定义类型实现了包含大括号的ToString()方法时

最佳实践建议

为了避免类似问题，开发者可以：

1. 对于用作字典键的记录结构体，考虑重写ToString()方法，避免输出大括号
2. 在自定义类型的字符串表示中，谨慎使用可能被解释为格式字符串特殊字符的符号
3. 保持FluentAssertions库的及时更新，以获取最新的修复和改进

总结

这个问题展示了在复杂字符串处理场景中可能遇到的微妙问题。FluentAssertions团队通过巧妙地使用上下文变量和安全的字符串传递机制，解决了记录结构体与字符串格式化的冲突问题。这提醒我们在处理用户提供的字符串时，需要特别注意潜在的格式字符串注入风险。