Serilog中JsonFormatter自定义序列化问题的深度解析

背景与问题场景

在使用Serilog进行结构化日志记录时，开发者经常会遇到需要自定义对象序列化格式的需求。特别是在使用JsonFormatter输出到Console等接收器时，期望某些特定类型能够按照业务需求进行特殊格式化。然而实际使用中发现，JsonFormatter似乎"忽略"了System.Text.Json的序列化标记和多种自定义扩展点。

核心问题分析

通过典型示例可以看到，当开发者定义一个带有JsonConverter特性的记录类型时：

[JsonConverter(typeof(ExampleJsonConverter))]
public class Example(int X, int Y)
{
    public override string ToString() => $"Example({X},{Y})";
}

并期望在日志中以特定格式输出时，JsonFormatter并未按预期工作。这主要是因为：

1. 设计原则差异：Serilog的JsonFormatter是独立实现的格式化器，刻意避免依赖任何特定的JSON库（如System.Text.Json或Newtonsoft.Json）

2. 结构化标记缺失：在日志模板中使用{e}而非{@e}时，Serilog会默认调用ToString()而非结构化序列化

解决方案详解

正确使用结构化标记

最直接的解决方式是使用@符号标记需要结构化的属性：

logger.LogInformation("Example {@e}", new Example(7, 11));

自定义序列化策略

Serilog提供了多种扩展点来实现自定义序列化：

1. 转换器模式（推荐）

configuration.Destructure.ByTransforming<Example>(e => new { e.X, e.Y });

2. 策略模式 实现IDestructuringPolicy接口：

public class ExamplePolicy : IDestructuringPolicy
{
    public bool TryDestructure(object value, ILogEventPropertyValueFactory factory, 
        out LogEventPropertyValue result)
    {
        if (value is Example e)
        {
            result = new StructureValue(new[] {
                new LogEventProperty("X", new ScalarValue(e.X)),
                new LogEventProperty("Y", new ScalarValue(e.Y))
            });
            return true;
        }
        result = null;
        return false;
    }
}
// 注册策略
configuration.Destructure.With<ExamplePolicy>();

3. 集成System.Text.Json 可以通过自定义JsonConverter与中间适配层实现集成，但需要额外处理层。

架构设计思考

Serilog的这种设计体现了几个重要原则：

1. 依赖最小化：核心库不强制绑定特定JSON实现
2. 扩展性优先：通过策略模式提供充分的扩展能力
3. 显式优于隐式：要求开发者明确标记需要结构化的属性

最佳实践建议

1. 始终对需要结构化的对象使用@前缀
2. 对于简单转换优先使用ByTransforming
3. 复杂场景考虑实现IDestructuringPolicy
4. 需要与现有JSON库集成时，建议在策略层做适配

通过理解这些设计原则和正确使用扩展点，开发者可以充分发挥Serilog结构化日志记录的优势，实现灵活的对象序列化控制。