如何在Elasticsearch NEST中序列化JToken或JObject类型属性？

我之前在项目里刚好处理过类似的需求——复用带JObject属性的现有模型作为Elasticsearch文档，这里给你分享几个靠谱的解决方案：

方案1：自定义JsonConverter适配NEST序列化 #

NEST默认使用自己的序列化框架，但可以通过注册Json.NET的转换器来正确处理JObject类型。

步骤1：编写自定义转换器 #

创建一个继承自JsonConverter的类，专门处理JToken/JObject的序列化和反序列化：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;

public class JObjectElasticConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        // 匹配JObject和JToken类型
        return typeof(JObject).IsAssignableFrom(objectType) || typeof(JToken).IsAssignableFrom(objectType);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        // 直接用Json.NET的逻辑写入JToken
        var jToken = value as JToken;
        jToken?.WriteTo(writer);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // 从Reader加载JToken
        return JToken.Load(reader);
    }
}

步骤2：在NEST连接设置中注册转换器 #

初始化ElasticClient时，把自定义转换器添加到序列化配置里：

var settings = new ConnectionSettings(new Uri("http://your-es-host:9200"))
    .DefaultIndex("products")
    .DisableDirectStreaming() // 开启后可以调试序列化前后的JSON内容，方便排查问题
    .JsonSerializerSettings(config => config.Converters.Add(new JObjectElasticConverter()));

var elasticClient = new ElasticClient(settings);

步骤3：配置Elasticsearch映射（可选但推荐） #

为了确保Elasticsearch正确识别ExtraProps字段的类型，创建索引时可以显式指定为object类型：

var createIndexResponse = elasticClient.Indices.Create("products", c => c
    .Map<Product>(m => m
        .Properties(p => p
            .Number(n => n.Name(f => f.Id))
            .Text(t => t.Name(f => f.Name))
            .Object<JObject>(o => o.Name(f => f.ExtraProps).Dynamic()) // 开启动态映射，自动识别ExtraProps里的字段类型
        )
    )
);

这样处理后，当你索引Product对象时，ExtraProps里的内容会被正确序列化为嵌套的JSON对象存储在Elasticsearch中。

方案2：使用Json.NET的[JsonExtensionData]平摊字段（如果需要） #

如果你希望把ExtraProps里的字段直接作为文档的顶级字段（而不是嵌套在ExtraProps下），可以给ExtraProps属性添加[JsonExtensionData]特性：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

public class Product { 
    public int Id { get; set; } 
    public string Name { get; set; } 
    [JsonExtensionData] // 这个特性会让JObject的字段序列化时平摊到父对象
    public JObject ExtraProps { get; set; } 
}

配合方案1中的序列化设置，此时索引的文档会变成这样：

{
  "Id": 123,
  "Name": "Thing",
  "Color": "red",
  "Size": "XL"
}

这个方案适合需要把自定义数据直接融入文档结构的场景。

测试验证 #

你可以用以下代码测试序列化效果：

var testProduct = new Product
{
    Id = 123,
    Name = "Thing",
    ExtraProps = JObject.Parse("{ \"Color\": \"red\", \"Size\": \"XL\" }")
};

var indexResponse = elasticClient.IndexDocument(testProduct);

// 调试时可以查看序列化后的JSON
if (settings.DisableDirectStreaming)
{
    var requestJson = Encoding.UTF8.GetString(indexResponse.ApiCall.RequestBodyInBytes);
    Console.WriteLine(requestJson);
}

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