Spring Boot中OpenSearch-Java复合聚合排序报错的解决方法

在Spring Boot应用中使用opensearch-java库执行复合聚合并按某聚合字段降序排序时，出现解析错误：

[x_content_parse_exception] [1:125] [composite] failed to parse field [sources]

移除排序代码后可正常获取结果，但无法实现排序。直接调用OpenSearch API时，嵌套对象格式的order参数会失败：

"terms": {
  "field": "fieldA.keyword",
  "order": {
    "_key": "asc"
  }
}

而直接使用字符串形式的排序方向则正常运行：

"terms": {
  "field": "fieldA.keyword",
  "order": "desc"
}

但opensearch-java客户端的terms聚合order参数仅接受Map<String, SortOrder>类型，需要解决这一矛盾。

原错误代码如下：

private SearchRequest buildSearchRequest(SelectedFilters filters) {
  BoolQuery.Builder boolQueryBuilder = QueryBuilders.bool();
 
 Aggregation aggregation1 = new Aggregation.Builder()
          .terms(aggField -> aggField
                  .field("fieldA.keyword")
                  .order(Map.of("_key", SortOrder.Desc))            // Sorting here      
          )
          .build();
  Aggregation aggregation2 = new Aggregation.Builder()
          .terms(aggField -> aggField
                  .field("fieldB"))
          .build();

  CompositeAggregationSource compositeAggregationSource1 = new CompositeAggregationSource.Builder()
          .terms(aggregation1.terms())
          .build();

  CompositeAggregationSource compositeAggregationSource2 = new CompositeAggregationSource.Builder()
          .terms(aggregation2.terms())
          .build();

  Map<String, CompositeAggregationSource> compositeAggregation1 = new HashMap<>();
  compositeAggregation1.put("fieldA_agg", compositeAggregationSource1);

  Map<String, CompositeAggregationSource> compositeAggregation2 = new HashMap<>();
  compositeAggregation2.put("fieldB_agg", compositeAggregationSource2);

  List<Map<String, CompositeAggregationSource>> list = new ArrayList<>();
  list.add(compositeAggregation1);
  list.add(compositeAggregation2);

  Aggregation compositeAggregation = new CompositeAggregation.Builder()
          .sources(list)
          .size(1000)
          .build()
          ._toAggregation();

  return new SearchRequest.Builder()
          .index("my-index")
          .query(boolQueryBuilder.build().toQuery())
          .aggregations("my_bucket", compositeAggregation)
          .size(0)
          .build();
}

问题根源 #

1. 复合聚合sources格式错误：原代码将每个聚合source包装在单独的Map中再放入List，不符合OpenSearch复合聚合sources字段的格式要求，这是导致解析报错的核心原因。
2. 排序参数格式不匹配：opensearch-java客户端默认生成嵌套对象格式的order参数，但复合聚合的terms source仅支持字符串形式的排序方向。

修改后的代码 #

private SearchRequest buildSearchRequest(SelectedFilters filters) {
    BoolQuery.Builder boolQueryBuilder = QueryBuilders.bool();

    // 直接构建复合聚合的terms source，使用JsonData传入字符串格式的排序方向
    CompositeAggregationSource compositeAggregationSource1 = new CompositeAggregationSource.Builder()
            .terms(t -> t
                    .field("fieldA.keyword")
                    .order(JsonData.of("desc")) // 生成API兼容的字符串排序格式
            )
            .build();

    CompositeAggregationSource compositeAggregationSource2 = new CompositeAggregationSource.Builder()
            .terms(t -> t
                    .field("fieldB")
            )
            .build();

    // 构建正确的sources映射：key为聚合名称，value为对应的source实例
    Map<String, CompositeAggregationSource> sources = new HashMap<>();
    sources.put("fieldA_agg", compositeAggregationSource1);
    sources.put("fieldB_agg", compositeAggregationSource2);

    // 构建复合聚合
    CompositeAggregation compositeAggregation = new CompositeAggregation.Builder()
            .sources(sources) // 传入正确格式的sources
            .size(1000)
            .build();

    return new SearchRequest.Builder()
            .index("my-index")
            .query(boolQueryBuilder.build().toQuery())
            .aggregations("my_bucket", compositeAggregation._toAggregation())
            .size(0)
            .build();
}

关键修改点 #

• 修正sources结构：将多个聚合source放入同一个Map中，直接传递给CompositeAggregation.Builder.sources()，符合OpenSearch API的格式要求。
• 调整排序参数：使用JsonData.of("desc")直接生成字符串形式的排序方向，匹配API接受的格式，避免客户端生成嵌套对象格式的order参数。

内容的提问来源于stack exchange，提问作者Umang Kamdar