当前位置：首页 > article >正文

重学SpringBoot3-整合 Elasticsearch 8.x (三)使用Repository

article 2024/11/12 11:38:16

更多SpringBoot3内容请关注我的专栏：《SpringBoot3》
期待您的点赞👍收藏⭐评论✍

在使用Spring Data Elasticsearch进行复杂查询时，Repository的接口方法以及定制查询能力可以帮助我们更灵活地构建高级用例。以下是几个具体示例：

1. 自定义查询方法

在Repository中，可以通过命名方法来自定义查询。Spring Data会根据方法名称自动生成查询语句。例如：

public interface ProductRepository extends ElasticsearchRepository<Product, String> {
    // 查找价格在特定范围内的商品
    List<Product> findByPriceBetween(double min, double max);

    // 查找包含指定关键词的商品名称
    List<Product> findByNameContaining(String keyword);
}

Spring Data Elasticsearch可以解析方法名并生成对应的Elasticsearch查询，不需要手动编写复杂的查询语句。

2. 使用@Query注解进行定制查询

对于更复杂的查询，@Query注解提供了自定义DSL（Domain Specific Language）查询的能力。例如，我们可以在Repository方法上使用Elasticsearch的查询语句：

public interface ProductRepository extends ElasticsearchRepository<Product, String> {

    @Query("{\"bool\": {\"must\": [{\"match\": {\"name\": \"?0\"}}]}}")
    List<Product> findByNameUsingCustomQuery(String name);
}

这样可以使查询语句更灵活，也可以与特定业务需求进行更贴合的查询逻辑设置。

3. 批量操作

在实际应用中，批量操作是常见的需求。ElasticsearchRepository 提供了批量保存和删除的接口方法：

@Autowired
private ProductRepository productRepository;

public void saveAllProducts(List<Product> products) {
    productRepository.saveAll(products);
}

public void deleteAllProducts(List<String> productIds) {
    productRepository.deleteAllById(productIds);
}

这对于处理大规模数据操作时能显著提升效率。

4. 高亮显示搜索结果

在很多搜索场景中，用户希望看到关键字在结果中的高亮显示，以便于理解上下文。Spring Data Elasticsearch通过HighlightBuilder实现高亮功能：

public SearchHits<Product> searchWithHighlight(String keyword) {
    NativeSearchQuery searchQuery = new NativeSearchQueryBuilder()
            .withQuery(QueryBuilders.matchQuery("description", keyword))
            .withHighlightBuilder(new HighlightBuilder().field("description"))
            .build();

    return elasticsearchRestTemplate.search(searchQuery, Product.class);
}

此方法会在查询结果中返回带有高亮效果的匹配内容，方便展示在用户界面中。

5. 聚合查询

聚合查询可以帮助分析数据分布、统计信息等。Spring Data Elasticsearch 支持多种类型的聚合查询，如Terms Aggregation、Range Aggregation等。以下示例展示了一个简单的分组统计：

public Map<String, Long> aggregateByCategory() {
    NativeSearchQuery searchQuery = new NativeSearchQueryBuilder()
            .addAggregation(AggregationBuilders.terms("categoryAgg").field("category"))
            .build();

    SearchHits<Product> searchHits = elasticsearchRestTemplate.search(searchQuery, Product.class);
    Terms terms = (Terms) searchHits.getAggregations().get("categoryAgg");

    Map<String, Long> result = new HashMap<>();
    terms.getBuckets().forEach(bucket -> result.put(bucket.getKeyAsString(), bucket.getDocCount()));
    return result;
}

此代码使用 elasticsearchRestTemplate 执行聚合查询，可以统计每种category类型的文档数量，方便用于数据分析和展示。

6. 使用分页和排序

在实际应用中，查询结果往往需要分页或排序展示。Spring Data Elasticsearch提供了Pageable参数来支持分页，Sort参数来支持排序：

public Page<Product> findByCategory(String category, Pageable pageable) {
    return productRepository.findByCategory(category, pageable);
}

Pageable 可以指定页码和每页大小等参数，非常适合在数据量大的情况下分页查询。

7. 异步查询（使用 @Async）

在数据量较大的查询场景中，为了避免阻塞主线程，可以使用异步查询。通过添加 @Async 注解，方法会返回 CompletableFuture 类型，Spring 会自动异步执行该查询：

@Async
public CompletableFuture<List<Product>> findByCategoryAsync(String category) {
    return CompletableFuture.completedFuture(productRepository.findByCategory(category));
}