Azure Cognitive Search中Dictionary类型序列化适配问题及解决方案咨询

我之前也踩过这个坑，Azure Cognitive Search对Collection(Edm.ComplexType)的格式要求确实和Dictionary默认序列化结果不兼容，给你几个可行的解决方案：

方案1：自定义Json转换器（推荐） #

不管你用的是旧版Microsoft.Azure.Search（依赖Newtonsoft.Json）还是新版Azure.Search.Documents（默认用System.Text.Json），都可以通过自定义转换器强制把Dictionary序列化成数组格式。

针对Newtonsoft.Json的实现 #

创建一个通用转换器：

public class DictionaryToArrayConverter<TKey, TValue> : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return typeof(IDictionary<TKey, TValue>).IsAssignableFrom(objectType);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var dictionary = (IDictionary<TKey, TValue>)value;
        serializer.Serialize(writer, dictionary.Select(kv => new { Key = kv.Key, Value = kv.Value }));
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // 上传场景如果不需要反序列化，可简化返回空字典；如需支持读取，按以下逻辑实现
        var items = serializer.Deserialize<List<KeyValuePair<TKey, TValue>>>(reader);
        var dictionary = (IDictionary<TKey, TValue>)Activator.CreateInstance(objectType);
        foreach (var item in items)
        {
            dictionary.Add(item.Key, item.Value);
        }
        return dictionary;
    }
}

然后在你的实体类属性上标记转换器：

[JsonConverter(typeof(DictionaryToArrayConverter<string, double?>))]
public Dictionary<string, double?> Resultat { get; set; }

针对System.Text.Json的实现 #

如果用的是新版SDK，写对应的转换器：

public class DictionaryToArrayConverter<TKey, TValue> : JsonConverter<IDictionary<TKey, TValue>>
{
    public override IDictionary<TKey, TValue> Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        var items = JsonSerializer.Deserialize<List<KeyValuePair<TKey, TValue>>>(ref reader, options);
        var dictionary = new Dictionary<TKey, TValue>();
        foreach (var item in items)
        {
            dictionary.Add(item.Key, item.Value);
        }
        return dictionary;
    }

    public override void Write(Utf8JsonWriter writer, IDictionary<TKey, TValue> value, JsonSerializerOptions options)
    {
        writer.WriteStartArray();
        foreach (var kvp in value)
        {
            writer.WriteStartObject();
            writer.WritePropertyName("Key");
            JsonSerializer.Serialize(writer, kvp.Key, options);
            writer.WritePropertyName("Value");
            JsonSerializer.Serialize(writer, kvp.Value, options);
            writer.WriteEndObject();
        }
        writer.WriteEndArray();
    }
}

然后在属性上注册转换器：

[JsonConverter(typeof(DictionaryToArrayConverter<string, double?>))]
public Dictionary<string, double?> Resultat { get; set; }

方案2：上传前转换数据结构 #

如果不想修改实体类的序列化逻辑，可以在上传文档前，把Dictionary转换成符合要求的数组结构。比如用匿名类型快速转换：

// 假设你的原实体类是MyDocument
var originalDoc = new MyDocument { Resultat = new Dictionary<string, double?> { { "key1", 1.2 }, { "key2", 3.4 } } };

// 转换为Search期望的数组格式
var searchDoc = new
{
    // 保留原实体的其他字段...
    Resultat = originalDoc.Resultat.Select(kv => new { Key = kv.Key, Value = kv.Value }).ToList()
};

// 上传转换后的searchDoc到Azure Cognitive Search

如果需要复用，可以创建专门的DTO类：

public class SearchDocumentDto
{
    // 其他字段和原实体一致...
    public List<KeyValuePair<string, double?>> Resultat { get; set; }
}

上传前做映射转换即可。

补充说明 #

之所以报错，核心原因是：Azure Cognitive Search的Collection(Edm.ComplexType)要求数据是JSON数组，每个元素是包含Key和Value的复杂对象；而C# Dictionary默认会被序列化为JSON对象（键作为属性名），两者格式完全不匹配。因为你的键是动态的，没法提前把每个键定义为索引字段，所以必须用数组形式的复杂集合来适配。

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