.NET Core中如何通过配置将字符串数组映射为SslProtocols枚举？

默认配置绑定器不支持将字符串数组直接映射为Flags类型的SslProtocols枚举，Kestrel内部通过自定义逻辑实现了这个映射，我们可以通过以下两种方式手动实现相同的绑定效果：

方法一：手动编写配置绑定逻辑 #

直接在配置服务时手动解析配置节的字符串数组，组合成SslProtocols枚举值：

1. 定义配置类：

public class HttpsEndpointOptions
{
    public SslProtocols SslProtocols { get; set; } = SslProtocols.Tls12; // 设置默认值
}

2. 在Program.cs中完成绑定：

builder.Services.Configure<HttpsEndpointOptions>(options =>
{
    var sslProtocolsConfig = builder.Configuration.GetSection("HttpsEndpoint:SslProtocols");
    if (!sslProtocolsConfig.Exists()) return;

    var protocolNames = sslProtocolsConfig.Get<string[]>();
    var enabledProtocols = SslProtocols.None;

    foreach (var name in protocolNames)
    {
        if (Enum.TryParse<SslProtocols>(name, ignoreCase: true, out var protocol))
        {
            enabledProtocols |= protocol;
        }
        // 可选：添加日志记录无效的枚举值
        // else logger.LogWarning("无效的SslProtocol值: {Protocol}", name);
    }

    options.SslProtocols = enabledProtocols;
});

方法二：自定义类型转换器（自动绑定） #

通过自定义TypeConverter，让配置绑定器自动识别并转换字符串数组为SslProtocols：

1. 创建类型转换器：

public class SslProtocolsArrayConverter : 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 not string[] protocolStrings)
            return base.ConvertFrom(context, culture, value);

        var result = SslProtocols.None;
        foreach (var protocol in protocolStrings)
        {
            if (Enum.TryParse<SslProtocols>(protocol, ignoreCase: true, out var parsed))
            {
                result |= parsed;
            }
        }
        return result;
    }
}

2. 在配置类的属性上应用转换器：

public class HttpsEndpointOptions
{
    [TypeConverter(typeof(SslProtocolsArrayConverter))]
    public SslProtocols SslProtocols { get; set; } = SslProtocols.Tls12;
}

3. 正常使用IOptions绑定：

builder.Services.Configure<HttpsEndpointOptions>(builder.Configuration.GetSection("HttpsEndpoint"));

注意事项 #

• SslProtocols是Flags枚举，多个值会通过按位或组合，这和Kestrel的处理逻辑一致。
• 配置文件中的字符串需与枚举成员名称匹配（如"Tls12"、"Tls13"），大小写不敏感。
• 建议添加错误处理逻辑，比如记录无法解析的无效枚举值，避免配置错误导致的静默失败。

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