.NET 6中Consul配置字符串数组因转义引号无法绑定求助

方案1：修正Consul的配置输入格式 #

Consul的KV存储中，若配置值为JSON格式，直接输入标准JSON即可，无需手动添加转义引号。将Consul里的ORGIDS值改为：

"ORGIDS": ["1","2","3"]

如果通过Consul CLI添加配置，执行以下命令（用单引号包裹JSON内容避免Shell解析双引号）：

consul kv put config/YourApp/ORGIDS '["1","2","3"]'

方案2：自定义配置转换器（无法修改Consul配置时） #

如果无法修正Consul中的转义格式，可通过自定义类型转换器让.NET正确解析带转义的数组：

1. 创建自定义转换器类：

using System.ComponentModel;
using System.Text.Json;

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

    public override object ConvertFrom(ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value)
    {
        if (value is string jsonStr)
        {
            // 替换转义引号为正常引号
            var cleanedJson = jsonStr.Replace(@"\""", @"""");
            return JsonSerializer.Deserialize<List<string>>(cleanedJson);
        }
        return base.ConvertFrom(context, culture, value);
    }
}

2. 在Settings类的字段上标记转换器：

using System.ComponentModel;

public class Settings
{
    [TypeConverter(typeof(EscapedStringListConverter))]
    public List<string> ORGIDS { get; set; }
}

3. 正常执行配置绑定：

var settings = configuration.GetSection(nameof(Settings)).Get<Settings>();

方案3：手动解析配置值 #

若不想使用转换器，也可在读取配置时手动处理转义并解析：

var rawValue = configuration.GetValue<string>("ORGIDS");
if (!string.IsNullOrEmpty(rawValue))
{
    var cleanedValue = rawValue.Replace(@"\""", @"""");
    var orgIds = JsonSerializer.Deserialize<List<string>>(cleanedValue);
    // 将解析结果赋值给Settings对象
    settings.ORGIDS = orgIds;
}

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