Audit.NET中JsonDocument序列化问题的解决方案

问题背景

在使用Audit.NET进行审计日志记录时，开发人员可能会遇到JsonDocument对象序列化不正确的问题。具体表现为当升级Audit.NET版本后，原本能够正常序列化的JsonDocument对象突然只能输出类似{"RootElement":{"ValueKind":1}}这样的简化信息，而不再包含完整的JSON数据内容。

问题根源分析

这个问题的根本原因在于Audit.NET内部使用了不同的JSON序列化器。从版本25.0.4升级到27.5.0后，Audit.NET默认使用System.Text.Json作为序列化器，而如果开发人员配置了Newtonsoft.Json适配器，就会导致两种JSON处理方式不兼容。

JsonDocument是System.Text.Json命名空间下的类型，当它被Newtonsoft.Json序列化时，无法正确识别其内部结构，只能输出简化信息。这种不匹配在审计日志记录中会导致关键参数信息丢失，严重影响日志的可读性和可用性。

解决方案

方案一：统一使用System.Text.Json

如果项目中没有特殊需求，最简单的解决方案是保持Audit.NET的默认配置，即使用System.Text.Json进行序列化：

Audit.Core.Configuration.Setup()
    .UseFileLogProvider(f => f.Directory(@"C:\Logs"));

var jsonDocument = System.Text.Json.JsonDocument.Parse(jsonBody);
var auditScope = AuditScope.Create("Test", null);
auditScope.SetCustomField("Parameters", jsonDocument);
auditScope.Save();

这种方式能够正确处理JsonDocument对象，输出完整的JSON内容。

方案二：统一使用Newtonsoft.Json

如果项目中已经大量使用Newtonsoft.Json，或者有特殊需求必须使用Newtonsoft.Json，则应该使用JObject代替JsonDocument：

Audit.Core.Configuration.Setup()
    .JsonNewtonsoftAdapter()
    .UseFileLogProvider(f => f.Directory(@"C:\Logs"));

var jsonBody = "{\"Id\":1, \"Name\":\"Test\"}";
var jsonDocument = Newtonsoft.Json.Linq.JObject.Parse(jsonBody);
var auditScope = AuditScope.Create("Test", null);
auditScope.SetCustomField("Parameters", jsonDocument);
auditScope.Save();

这种方式确保了JSON处理方式的一致性，避免了序列化问题。

最佳实践建议

1. 一致性原则：在整个项目中保持JSON处理方式的一致性，要么全部使用System.Text.Json，要么全部使用Newtonsoft.Json。

2. 明确配置：在使用Audit.NET时，明确配置所需的JSON适配器，避免依赖默认行为。

3. 版本升级检查：在升级Audit.NET版本时，特别注意JSON处理相关的变更，必要时进行适配性测试。

4. 日志验证：实现自动化测试来验证审计日志的输出格式是否符合预期。

总结

Audit.NET作为强大的审计日志框架，提供了灵活的配置选项。开发人员在使用时需要注意JSON序列化器的选择，确保与项目中其他组件的JSON处理方式保持一致。通过正确配置JSON适配器，可以避免JsonDocument序列化问题，保证审计日志的完整性和可用性。