AWSSDK.Core 中 JsonPolicyWriter.WritePolicyToString 方法的格式化问题解析

在 AWSSDK.Core 4.0.0.3 版本中，JsonPolicyWriter.WritePolicyToString 方法存在一个格式化输出的问题。该方法用于将 AWS IAM 策略对象序列化为 JSON 字符串，但无论传入的 prettyPrint 参数是 true 还是 false，输出结果总是带有缩进格式。

这个问题最初由用户 Petr-Kovalev 在 .NET Framework 4.8 环境下发现并报告。该问题在 AWSSDK 3.7.* 版本中表现正常，但在升级到 4.0.0.3 版本后出现了功能异常。

问题分析

JsonPolicyWriter.WritePolicyToString 方法的预期行为是根据 prettyPrint 参数决定输出 JSON 是否进行格式化缩进。然而在实现中，代码固定使用了缩进选项：

JsonWriterOptions options = new JsonWriterOptions
{
    Indented = true,  // 这里固定为 true，忽略了 prettyPrint 参数
};

这种实现方式导致了方法行为与参数预期不符，无论用户传入 true 还是 false，输出结果都会进行缩进格式化。

影响范围

这个问题主要影响以下场景：

1. 需要紧凑 JSON 输出的场景（prettyPrint=false）
2. 自动化处理 JSON 字符串的场景，额外的空格和缩进可能导致处理异常
3. 日志记录或网络传输场景，额外的格式化字符会增加数据量

解决方案

正确的实现应该将 prettyPrint 参数传递给 JsonWriterOptions 的 Indented 属性：

JsonWriterOptions options = new JsonWriterOptions
{
    Indented = prettyPrint  // 根据参数决定是否缩进
};

这个修复方案已在 AWSSDK.Core 4.0.0.6 版本中发布。开发人员可以通过升级到该版本或更高版本来解决此问题。

最佳实践

在使用 JsonPolicyWriter 类时，建议开发者：

1. 明确指定 prettyPrint 参数以满足具体场景需求
2. 在性能敏感场景下使用 prettyPrint=false 以减少序列化开销
3. 在需要人类可读的场景下使用 prettyPrint=true 以提高可读性
4. 对于关键业务逻辑，考虑添加单元测试验证输出格式是否符合预期

这个问题提醒我们在进行依赖库升级时，需要对关键功能进行回归测试，特别是当底层实现发生重大变化时（如本例中从 LitJson 迁移到 System.Text.Json）。