如何用Spring Data Elasticsearch @Query注解实现带高亮的查询？

一、使用@Query注解编写原生查询 #

如果你的Elasticsearch查询逻辑固定，可以直接通过@Query注解传入包含bool查询和highlight配置的原生JSON语句，核心是确保返回值能接收高亮结果。

步骤示例： #

1. 定义实体类：

@Document(indexName = "your_index_name")
public class YourEntity {
    @Id
    private String id;
    @Field(type = FieldType.Text)
    private String targetField; // 需要高亮的字段
    // 其他字段、getter和setter
}

2. 编写Repository接口：
   假设你的原生ES查询JSON如下（示例）：

{
  "bool": {
    "must": [{"match": {"targetField": "?0"}}]
  },
  "highlight": {
    "fields": {
      "targetField": {"preTags": "<em>", "postTags": "</em>"}
    }
  }
}

对应的Repository方法：

@Repository
public interface YourEntityRepository extends ElasticsearchRepository<YourEntity, String> {

    @Query("{\"bool\": {\"must\": [{\"match\": {\"targetField\": \"?0\"}}]}, \"highlight\": {\"fields\": {\"targetField\": {\"preTags\": \"<em>\", \"postTags\": \"</em>\"}}}}")
    SearchHits<YourEntity> searchWithHighlight(String keyword);
}

• 注意：JSON中的参数用?0、?1等占位符对应方法的参数顺序；双引号需要转义。

3. 获取高亮结果：
   调用方法后，通过SearchHit的getHighlightFields()提取高亮内容：

SearchHits<YourEntity> hits = yourEntityRepository.searchWithHighlight("keyword");
for (SearchHit<YourEntity> hit : hits) {
    YourEntity entity = hit.getContent();
    Map<String, List<String>> highlightMap = hit.getHighlightFields();
    // 替换原字段为高亮内容
    if (highlightMap.containsKey("targetField")) {
        entity.setTargetField(highlightMap.get("targetField").get(0));
    }
}

二、使用ElasticsearchOperations构建查询（更灵活） #

如果查询逻辑复杂、需要动态调整高亮配置，推荐用ElasticsearchOperations（替代旧版ElasticsearchRestTemplate）的NativeSearchQueryBuilder来构建查询，代码可读性和扩展性更强。

示例代码： #

@Autowired
private ElasticsearchOperations elasticsearchOperations;

public List<YourEntity> searchWithDynamicHighlight(String keyword) {
    // 配置高亮字段，可自定义前缀、后缀、片段长度等
    HighlightBuilder.Field highlightField = new HighlightBuilder.Field("targetField")
            .preTags("<strong>")
            .postTags("</strong>")
            .fragmentSize(200); // 高亮片段长度

    // 构建bool查询
    NativeSearchQuery query = new NativeSearchQueryBuilder()
            .withQuery(QueryBuilders.boolQuery()
                    .must(QueryBuilders.matchQuery("targetField", keyword)))
            .withHighlightFields(highlightField)
            .build();

    // 执行查询并处理高亮结果
    SearchHits<YourEntity> hits = elasticsearchOperations.search(query, YourEntity.class);
    List<YourEntity> resultList = new ArrayList<>();
    for (SearchHit<YourEntity> hit : hits) {
        YourEntity entity = hit.getContent();
        Map<String, List<String>> highlights = hit.getHighlightFields();
        if (highlights.containsKey("targetField")) {
            entity.setTargetField(highlights.get("targetField").get(0));
        }
        resultList.add(entity);
    }
    return resultList;
}

方案对比 #

• @Query注解：适合逻辑固定的简单查询，直接复用原生ES JSON，快速实现。
• ElasticsearchOperations：支持动态调整查询条件和高亮配置，代码更易维护，适合复杂场景。

内容的提问来源于stack exchange，提问作者Énio Henrique