如何解决Newtonsoft Json自定义枚举转换器的日志注入问题

问题根源 #

你遇到的问题核心在于：如果在属性上标注[JsonConverter(typeof(SizesStringEnumConverter))]，Json.NET会强制使用无参构造函数创建转换器实例，导致手动传入的Logger无法生效；但如果仅在反序列化时手动传入带参构造的转换器，其实不需要无参构造，之前的报错大概率是特性标注和手动传转换器的冲突导致。

解决方案1：移除特性标注，手动传入转换器（推荐） #

如果不需要在类属性上固定转换器，直接在反序列化时传入带Logger的转换器实例即可，无需添加无参构造函数。

1. 确保Shirt类无特性标注：

public class Shirt
{
    public Size Size { get; set; }
}

2. 转换器代码保持不变：

public class SizesStringEnumConverter : StringEnumConverter
{
    private readonly ILogger _logger;

    public SizesStringEnumConverter(ILogger logger)
    {
        _logger = logger;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        try
        {
            return base.ReadJson(reader, objectType, existingValue, serializer);
        }
        catch (JsonSerializationException) // 捕获具体异常，避免误吞其他错误
        {
            _logger.Warning($"无法将JSON中的值: {reader.Value} 转换为Size枚举");
            return Size.UnknownSize;
        }
    }
}

3. 反序列化代码正常使用：

var logger = new LocalLogger();
var converter = new SizesStringEnumConverter(logger);

string testJson = @"{
    ""Size"": ""XXXXXXL""
}";

var shirt = JsonConvert.DeserializeObject<Shirt>(testJson, converter);

解决方案2：必须使用特性标注时，通过自定义ContractResolver注入Logger #

如果一定要在属性上用[JsonConverter]特性，可以通过自定义ContractResolver为转换器注入Logger，规避无参构造导致的Logger为null问题。

1. 创建自定义ContractResolver：

public class InjectableContractResolver : DefaultContractResolver
{
    private readonly ILogger _logger;

    public InjectableContractResolver(ILogger logger)
    {
        _logger = logger;
    }

    protected override JsonConverter ResolveContractConverter(Type objectType)
    {
        // 针对Size类型返回带Logger的转换器实例
        if (objectType == typeof(Size))
        {
            return new SizesStringEnumConverter(_logger);
        }
        return base.ResolveContractConverter(objectType);
    }
}

2. 在Shirt类上标注特性：

public class Shirt
{
    [JsonConverter(typeof(SizesStringEnumConverter))]
    public Size Size { get; set; }
}

3. 反序列化时使用自定义ContractResolver：

var logger = new LocalLogger();
var settings = new JsonSerializerSettings
{
    ContractResolver = new InjectableContractResolver(logger)
};

string testJson = @"{
    ""Size"": ""XXXXXXL""
}";

var shirt = JsonConvert.DeserializeObject<Shirt>(testJson, settings);

补充说明 #

• 尽量避免捕获所有异常，明确捕获JsonSerializationException能防止掩盖其他未知错误。
• 若项目使用依赖注入框架（如ASP.NET Core），可将ILogger和自定义ContractResolver注册到容器中，进一步简化代码调用。

内容的提问来源于stack exchange，提问作者Itay Barber