FluentAssertions 格式化异常问题分析与解决方案

问题背景

FluentAssertions 是一个流行的 .NET 断言库，在 6.12.0 版本中引入了一个格式化相关的 bug。当使用 UseLineBreaks 选项格式化特定类型的对象时，会抛出 ArgumentOutOfRangeException 异常，而不是预期的断言失败信息。

问题现象

该问题主要出现在以下两种场景：

1. 格式化包含数组的数组结构时：

var sigmets = new Point[][]
{
    [new Point()],
    [new Point()],
};

2. 格式化包含数组属性的对象数组时：

var sigmets = new[]
{
    new { Points = new Point[] { new() } },
    new { Points = new Point[] { new() } }
};

当对这些结构使用 Formatter.ToString 并启用 UseLineBreaks 选项时，会抛出异常。

根本原因

经过深入分析，发现问题源于 FormattedObjectGraph 类的实现细节：

1. 当第一个子数组只有一个元素时，会触发 ArgumentOutOfRangeException
2. 缩进处理逻辑存在缺陷，lineBuilderWhitespace 在添加第一个片段后才被设置
3. 多行格式化时，首行缩进处理不正确

技术细节

问题的核心在于 FormattedObjectGraph 类的以下行为：

1. WithIndentation 方法被过早调用（由 EnumerableValueFormatter 间接触发）
2. DefaultValueFormatter 随后调用 AddFragmentToLine
3. 此时 FormattedObjectGraph 尚未正确初始化缩进空格

这导致了格式化输出的缩进层级混乱，最终在某些边界条件下抛出异常。

解决方案

开发团队提供了两种解决方案：

1. 临时方案：移除 ReferenceTypeAssertions 中 BeSameAs 和 NotBeSameAs 对 UseLineBreaks 的默认使用
2. 根本解决方案：修复 FormattedObjectGraph 的缩进处理逻辑

影响范围

该问题虽然触发条件较为特定，但在以下场景可能遇到：

1. 断言 EF Core 实体及其导航属性
2. 处理多层嵌套的集合结构
3. 使用 BeEquivalentTo 进行深度比较时

最佳实践

为避免此类问题，建议：

1. 对于复杂对象断言，暂时避免使用 UseLineBreaks 选项
2. 保持 FluentAssertions 版本更新
3. 对于关键断言，添加额外的验证逻辑

总结

FluentAssertions 6.12.0 引入的格式化问题展示了在复杂对象处理中的边界条件挑战。通过理解问题的根本原因，开发者可以更好地规避类似问题，同时期待官方提供的完整修复方案。