.NET6中IOptions<>的JsonConverterAttribute被忽略如何解决？

问题原因 #

.NET的配置系统（Microsoft.Extensions.Configuration）不依赖System.Text.Json的序列化逻辑，它的绑定流程是先将配置文件（如JSON）解析为键值对集合，再通过自身的类型转换体系将值映射到对象属性。默认的TimeSpan转换器仅识别标准格式（如"00:00:00.700"），而你配置中的"0.700"不符合该格式，且配置系统不会识别[JsonConverter]特性，因此抛出转换异常。

解决方案 #

方案1：使用配置系统原生的IConfigurationConverter（推荐） #

实现配置系统专属的转换器，注册到绑定选项中：

1. 自定义转换器：

public class CustomTimeSpanConverter : IConfigurationConverter<TimeSpan>
{
    public TimeSpan Convert(object input)
    {
        if (input is string str)
        {
            // 处理"0.700"格式（代表0.7秒，即700毫秒）
            if (double.TryParse(str, out var seconds))
            {
                return TimeSpan.FromSeconds(seconds);
            }
            // 兼容标准TimeSpan格式
            if (TimeSpan.TryParse(str, out var ts))
            {
                return ts;
            }
        }
        throw new InvalidOperationException($"无法将值 {input} 转换为TimeSpan类型");
    }
}

2. 修改服务配置代码，注册转换器：

services.Configure<GpsAndTelemetryOptions>(
    configuration.GetSection(GpsAndTelemetryOptions.Section),
    bindOptions => bindOptions.Converters.Add(new CustomTimeSpanConverter())
);

方案2：使用TypeConverter #

通过System.ComponentModel.TypeConverter扩展配置系统的类型转换能力：

1. 自定义TypeConverter：

public class CustomTimeSpanTypeConverter : TypeConverter
{
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
    {
        return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        if (value is string str)
        {
            if (double.TryParse(str, out var seconds))
            {
                return TimeSpan.FromSeconds(seconds);
            }
            if (TimeSpan.TryParse(str, out var ts))
            {
                return ts;
            }
        }
        return base.ConvertFrom(context, culture, value);
    }
}

2. 给属性添加特性：

// 替换原来的[JsonConverter]特性
[TypeConverter(typeof(CustomTimeSpanTypeConverter))]
public TimeSpan RealtimeOffset { get; set; } = 200.Milliseconds();

或者全局注册TypeConverter（作用于所有TimeSpan属性）：

TypeDescriptor.AddAttributes(typeof(TimeSpan), new TypeConverterAttribute(typeof(CustomTimeSpanTypeConverter)));

方案3：手动使用System.Text.Json解析 #

如果一定要复用现有的TimespanConverter，可以绕开配置系统的绑定逻辑，直接用JsonSerializer解析配置节：

// 获取配置节的原始JSON内容
var sectionJson = configuration.GetSection(GpsAndTelemetryOptions.Section).GetRawJson();
// 用System.Text.Json反序列化，指定自定义转换器
var options = JsonSerializer.Deserialize<GpsAndTelemetryOptions>(sectionJson, new JsonSerializerOptions
{
    Converters = { new TimespanConverter() }
});
// 将解析后的对象包装为IOptions注入服务
services.AddSingleton(Options.Create(options));

System.Text.Json的支持情况 #

默认的IOptions绑定流程不会使用System.Text.Json的[JsonConverter]特性，因为配置系统的绑定逻辑是基于键值对的映射，而非直接反序列化整个JSON对象。只有当你手动调用JsonSerializer解析配置内容时，才能触发[JsonConverter]特性的生效。

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