加载中

从 JSON 数据创建 API 对象

在使用 Elasticsearch 进行应用程序开发期间，一个常见的工作流程是使用 Kibana Developer Console 交互式地准备和测试查询、聚合、索引映射及其他复杂的 API 调用。这会生成您可能想在应用程序中使用的可工作的 JSON 片段。

由于将这些 JSON 片段转换为 Java 代码可能既耗时又容易出错，因此 Java API Client 中的大多数数据类都可以从 JSON 文本加载：对象构建器具有 withJson() 方法，可从原始 JSON 填充构建器。这还允许您将动态加载的 JSON 与对象的程序化构造相结合。

在底层，withJson() 方法调用对象的反序列化器。因此，JSON 文本的结构和值类型必须与目标数据结构正确匹配。使用 withJson() 可以保持 Java API Client 的强类型保证。

示例

从资源文件加载索引定义

考虑一个包含索引定义的资源文件 some-index.json

{
  "mappings": {
    "properties": {
      "field1": { "type": "text" }
    }
  }
}

您可以按如下方式根据该定义创建索引

InputStream input = this.getClass()
    .getResourceAsStream("some-index.json");

CreateIndexRequest req = CreateIndexRequest.of(b -> b
    .index("some-index")
    .withJson(input)
);

boolean created = esClient.indices().create(req).acknowledged();
  1. 为 JSON 资源文件打开输入流。
  2. 使用资源文件内容填充索引创建请求。

从 JSON 文件摄取文档

类似地，您可以从数据文件中读取要存储在 Elasticsearch 中的文档

FileReader file = new FileReader(new File(dataDir, "document-1.json"));

IndexRequest<JsonData> req;

req = IndexRequest.of(b -> b
    .index("some-index")
    .withJson(file)
);

esClient.index(req);
  1. 在具有泛型类型参数的数据结构上调用 withJson() 时，这些泛型类型将被视为 JsonData。

创建结合 JSON 和程序化构造的搜索请求

您可以将 withJson() 与对 setter 方法的常规调用相结合。下面的示例从 String 加载搜索请求的查询部分，并以程序方式添加一个聚合。

Reader queryJson = new StringReader(
    "{" +
    "  \"query\": {" +
    "    \"range\": {" +
    "      \"@timestamp\": {" +
    "        \"gt\": \"now-1w\"" +
    "      }" +
    "    }" +
    "  }" +
    "}");

SearchRequest aggRequest = SearchRequest.of(b -> b
    .withJson(queryJson)
    .aggregations("max-cpu", a1 -> a1
        .dateHistogram(h -> h
            .field("@timestamp")
            .calendarInterval(CalendarInterval.Hour)
        )
        .aggregations("max", a2 -> a2
            .max(m -> m.field("host.cpu.usage"))
        )
    )
    .size(0)
);

Map<String, Aggregate> aggs = esClient
    .search(aggRequest, Void.class)
    .aggregations();
  1. 从 JSON 字符串加载查询。
  2. 添加聚合。
  3. 由于这是一个聚合，我们不关心结果文档，并将其目标类设置为 Void，这意味着它们将被忽略。请注意，将 size 设置为零实际上会阻止返回任何文档。

从多个 JSON 片段创建搜索请求

withJson() 方法是部分反序列化器：从 JSON 加载的属性将设置属性值或替换现有值，但不会重置 JSON 输入中不存在的其他属性。您可以使用此方法组合多个 JSON 片段来构建复杂的搜索请求。在下面的示例中，我们组合了选择某些文档的查询和对此查询结果运行的聚合的独立定义。

Reader queryJson = new StringReader(
    "{" +
    "  \"query\": {" +
    "    \"range\": {" +
    "      \"@timestamp\": {" +
    "        \"gt\": \"now-1w\"" +
    "      }" +
    "    }" +
    "  }," +
    "  \"size\": 100" +
    "}");

Reader aggregationJson = new StringReader(
    "{" +
    "  \"size\": 0, " +
    "  \"aggregations\": {" +
    "    \"hours\": {" +
    "      \"date_histogram\": {" +
    "        \"field\": \"@timestamp\"," +
    "        \"interval\": \"hour\"" +
    "      }," +
    "      \"aggregations\": {" +
    "        \"max-cpu\": {" +
    "          \"max\": {" +
    "            \"field\": \"host.cpu.usage\"" +
    "          }" +
    "        }" +
    "      }" +
    "    }" +
    "  }" +
    "}");

SearchRequest aggRequest = SearchRequest.of(b -> b
    .withJson(queryJson)
    .withJson(aggregationJson)
    .ignoreUnavailable(true)
);

Map<String, Aggregate> aggs = esClient
    .search(aggRequest, Void.class)
    .aggregations();
  1. 对于查询，将返回的最大文档数设置为 100。
  2. 我们不希望聚合中包含任何匹配的文档。
  3. 加载请求的查询部分。
  4. 加载请求的聚合部分（覆盖查询中的 size）。
  5. 通过程序设置的其他请求属性。

请注意，当 JSON 片段具有一些公共属性时，顺序很重要：就像通过程序设置属性值一样，为属性设置的最后一个值会覆盖之前的值。

上述示例的源代码可在 Java API Client 测试中找到。

© . All rights reserved.