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

时间:2018-04-30 20:07:26

标签: c# elasticsearch json.net nest elasticsearch-net

我将Elasticsearch引入C#API项目。我想利用现有的API模型作为搜索文档,其中许多模型允许添加自定义数据点。这些是使用Json.NET中的JObject类型实现的。例如:

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public JObject ExtraProps { get; set; }
}

这允许用户发送像这样的JSON请求体,效果很好:

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

但是,如果我在NEST中使用它作为文档类型,那些额外的属性会以某种方式丢失它们的值,序列化为:

{
   "Id": 123,
   "Name": "Thing",
   "ExtraProps": {
      "Color": [],
      "Size": []
   }
}

[Nest.Object]添加ExtraProps属性并未改变行为。据我了解,NEST在内部使用Json.NET,所以我不希望它有Json.NET类型的问题。对此有一个相对简单的解决方法吗?

以下是我正在权衡的一些选项:

  1. 使用custom serialization。我开始沿着这条路走下去,感觉比现在更复杂,我从来没有让它发挥作用。

  2. JObject映射到Dictionary<string, object> s。我已经验证了这个工作,但是如果有嵌套对象(可能存在),我需要通过递归来增强它。理想情况下,我希望这可以使用更通用的JToken类型。这是我倾向于的选择,但同样,感觉比它应该更复杂。

  3. 使用"Low Level" client甚至原始HTTP调用。诚然,我没有探究过这个,但如果它比替代品更简单/更清洁,我愿意接受它。

  4. 将此报告为错误。无论如何,我可能会这样做。我只是预感应该JObject或任何JToken开箱即用,除非有某种原因这是预期的行为。

1 个答案:

答案 0 :(得分:8)

这是NEST 6.x的预期行为。

NEST使用Json.NET进行序列化。然而,在NEST 6.x中,这种依赖性在NEST程序集中由

内化
  • IL合并所有Json.NET类型到NEST程序集
  • 将Newtonsoft.Json中的类型重命名为Nest.Json
  • 标记所有类型internal

There's a blog post with further details解释了这种变化背后的动机。

当涉及到处理诸如Newtonsoft.Json.Linq.JObject的Json.NET类型时,Json.NET对这些类型进行了特殊处理以进行序列化/反序列化。使用NEST 6.x,内化的Json.NET不知道如何专门处理Newtonsoft.Json.Linq.JObject,因为内部化的Json.NET中的所有类型都已重命名为Nest.Json命名空间。

为了支持Json.NET类型,需要连接使用Json.NET来序列化文档的序列化程序。创建NEST.JsonNetSerializer nuget package是为了帮助解决这个问题。只需在项目中添加对NEST.JsonNetSerializer的引用,然后按如下方式连接序列化程序

// choose the appropriate IConnectionPool for your use case
var pool = new SingleNodeConnectionPool(new Uri("http://localhost:9200"));
var connectionSettings =
    new ConnectionSettings(pool, JsonNetSerializer.Default);
var client = new ElasticClient(connectionSettings);

有了这个位置,具有JObject属性的文档将按预期序列化。