springboot — es使用crud

本文介绍了如何在Spring Boot应用中使用Elasticsearch的RestHighLevelClient进行数据的增删改查操作,并展示了分页查询和多种查询方法的实例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

  • 第一步:引入es相关包
<dependency>    
    <groupId>org.elasticsearch.client</groupId>
    <artifactId>elasticsearch-rest-high-level-client</artifactId>
    <version>7.16.2</version>
</dependency>

<dependency>
    <groupId>org.elasticsearch</groupId>
    <artifactId>elasticsearch</artifactId>
    <version>7.16.2</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
    <version>2.3.12.RELEASE</version>
</dependency>
  • 配置链接服务器信息
@Configuration
public class EsConfig {

    /**
     * 配置RestHighLevelClient对象,将该对象交给Spring容器去管理
     * 配置es服务器的ip、port
     *
     * @return RestHighLevelClient对象
     */
    @Bean("restHighLevelClient")
    public RestHighLevelClient restHighLevelClient() {
        return new RestHighLevelClient(
                RestClient.builder(
                        new HttpHost("这里是ip", "这里是端口port", "http")));
    }

}
  • 业务实现类里引入RestHighLevelClient对象,就可以开始使用啦
@Qualifier("restHighLevelClient")
@Autowired
RestHighLevelClient client;
  • api request类型
新增IndexRequest
更新UpdateRequest
删除DeleteRequest
根据ID获取GetRequest
(关键字)检索查询SearchRequest
  • 案例1 - 按条件分页查询
public static final String FILE_INDEX = "file";

public ResponsePage<FilePageDTO, FilePageVO> listPageByEs(ResponsePage<FilePageDTO, FilePageVO> param) {
        FilePageDTO condition = param.getParams();
        // 构建一个index为FILE_INDEX的请求
        SearchRequest request = new SearchRequest(FILE_INDEX);
        // 构建查询source内容构造器
        SearchSourceBuilder srb = new SearchSourceBuilder();
        // 设置分页查询信息: 从哪页page开始查
        srb.from(Long.valueOf(param.getCurrent()).intValue());
        // 设置分页查询信息: 查询页大小
        srb.size(Long.valueOf(param.getSize()).intValue());
        // 构造参数查询构造器
        BoolQueryBuilder boolQueryBuilder = new BoolQueryBuilder();
        if (condition.getType() != null) {
            // 等值、精准查询 fileType为XX的信息
            boolQueryBuilder.must(QueryBuilders.termQuery("fileType", condition.getType()));
        }
        if (StringUtils.isNotEmpty(condition.getName())) {
            // 等值、模糊查询 fileName包含XX的信息
            boolQueryBuilder.must(QueryBuilders.matchQuery("fileName", condition.getName()));
        }
        // 设置查询参数信息
        srb.query(boolQueryBuilder);
        request.source(srb);

        SearchResponse response = null;
        ArrayList<FilePageVO> resultList = Lists.newArrayList();
        try {
            // 调用es查询
            response = client.search(request, RequestOptions.DEFAULT);
        } catch (IOException e) {
            log.error("查es出错");
        }

        // 获取返回信息
        SearchHit[] hits = response.getHits().getHits();
        log.info("hits: {}", JSON.toJSONString(hits));
        if (Objects.isNull(hits)) {
            return param;
        }
        Arrays.asList(hits).forEach(x -> {
            FilePageVO filePageVO = JSON.parseObject(JSON.toJSONString(x.getSourceAsMap()), FilePageVO.class);
            resultList.add(filePageVO);
        });
        param.setTotal(response.getHits().getTotalHits().value);
        param.setRecords(resultList);
        return param;
    }
  • 案例2 - 存储信息到es
public Response saveForEs(FileCreateDTO param) {
    ResourceFile file = new ResourceFile();
    file.setFileName(param.getFileName());
    file.setFileType(param.getFileType());
    file.setFileUrl(param.getFileUrl());
    file.setFileSize(param.getFileSize());
    // 存库
    this.save(file);
    param.setId(file.getId());

    // 构建新增请求
    IndexRequest request = new IndexRequest();
    // 设置_index、手动设置 _id
    request.index(FILE_INDEX).id(file.getId().toString());
    // 将信息存放到source中
    request.source(JSON.toJSONString(param), XContentType.JSON);

    IndexResponse response = null;
    try {
        // 调用api创建
        response = client.index(request, RequestOptions.DEFAULT);
    } catch (IOException e) {
        log.error("保存es出错");
    }
    RestStatus status = response.status();
    return Response.success(JSON.toJSONString(status));
}
  • 案例3 - 通过ID编辑信息
public Response editForEs(FileCreateDTO param) {
    ResourceFile file = getById(param.getId());
    BeanUtils.copyProperties(param, file);
    // 更新表
    updateById(file);

    // 构建更新请求
    UpdateRequest request = new UpdateRequest();
    // 指定index以及要更新的ID
    request.index(FILE_INDEX).id(param.getId().toString());
    // 指定更新字段、值
    request.doc(XContentType.JSON, "id", file.getId());
    UpdateResponse update = null;
    try {
        // 调用更新api更新
        update = client.update(request, RequestOptions.DEFAULT);
    } catch (IOException e) {
        log.error("更新es出错");
    }
    RestStatus status = response.status();
    return Response.success(JSON.toJSONString(status));
}
  • 案例4 - 从通过ID从es删除
public Response removeForEs(Long id) {
    // 库里删除
    removeById(id);

    // 构建删除请求
    DeleteRequest request = new DeleteRequest();
    // 指定index以及id
    request.index(FILE_INDEX).id(id.toString());
    DeleteResponse response = null;
    try {
        // 调用api删除
        response = client.delete(request, RequestOptions.DEFAULT);
    } catch (IOException e) {
        log.error("删除es出错");
    }
    RestStatus status = response.status();
    return Response.OK(JSON.toJSONString(status));
}
  • 案例5 - 查询全部
public ArrayList<FileVO> listAllByEs() {
    ArrayList<FileVO> resultList = Lists.newArrayList();

    // 构造指定index的查询请求
    SearchRequest request = new SearchRequest(FILE_INDEX);
    // 创建查询source构造器
    SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
    // 设置查询类型: 全部
    searchSourceBuilder.query(QueryBuilders.matchAllQuery());
    request.source(searchSourceBuilder);

    SearchResponse response = null;
    try {
        // 调用api查询
        response = client.search(request, RequestOptions.DEFAULT);
    } catch (IOException e) {
        log.error("查询es出错");
    }
    
    // 遍历结果 返回list
    SearchHit[] hits = response.getHits().getHits();
    Arrays.asList(hits).forEach(x -> {
        FileVO fileVO = JSON.parseObject(JSON.toJSONString(x.getSourceAsMap()), FileVO.class);
        resultList.add(fileVO);
    });
    return resultList;
}
  • 案例6 - 通过ID获取详情
public Response getDetailForEs(Long id) {
    // 构建查询单个get请求
    GetRequest request = new GetRequest();
    // 设置查询索引index以及id
    request.index(FILE_INDEX).id(id.toString());

    GetResponse response = null;
    try {
        // 调用api查询
        response = client.get(request, RequestOptions.DEFAULT);
    } catch (IOException e) {
        log.info("获取详情 es出错");
    }

    // 封装返回对象信息
    FileVO fileVO = JSON.parseObject(JSON.toJSONString(response.getSourceAsMap()), FileVO.class);
    return Response.OK(fileVO);
}

### 集成使用Elasticsearch实现文档检索功能 #### 启动Elasticsearch 在开始集成之前,需要先启动Elasticsearch服务。可以通过下载Elasticsearch的安装包并解压后,在其`bin`目录下运行`elasticsearch`命令来启动服务。确保Elasticsearch服务正常运行,并且监听端口9200[^1]。 #### 修改application.properties 在Spring Boot项目中,需要配置Elasticsearch的相关信息。可以在`application.properties`文件中添加以下配置: ```properties spring.data.elasticsearch.repositories.enabled=true spring.data.elasticsearch.client.reactive.initial-cluster-nodes=localhost:9200 ``` 这些配置启用了Elasticsearch仓库,并指定了Elasticsearch集群节点地址。 #### 创建文档类 为了能够存储和检索数据,需要创建一个Java类来表示Elasticsearch中的文档。例如,可以创建一个名为`Document`的类: ```java import org.springframework.data.annotation.Id; import org.springframework.data.elasticsearch.annotations.Document; @Document(indexName = "documents") public class Document { @Id private String id; private String title; private String content; // Getters and Setters } ``` 此类使用了Spring Data Elasticsearch注解来定义索引名称,并标识了主键字段。 #### 创建资源库 接下来,需要创建一个接口来操作Elasticsearch中的数据。这个接口继承自`ElasticsearchRepository`: ```java import org.springframework.data.elasticsearch.repository.ElasticsearchRepository; public interface DocumentRepository extends ElasticsearchRepository<Document, String> { // 自定义查询方法 } ``` 通过此接口,可以方便地进行CRUD操作以及自定义查询方法[^1]。 #### 创建测试用例 为了验证集成是否成功,可以编写一个简单的测试用例来插入和检索数据: ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import java.util.Optional; @SpringBootTest public class DocumentTest { @Autowired private DocumentRepository documentRepository; @Test public void testSaveAndRetrieve() { Document doc = new Document(); doc.setId("1"); doc.setTitle("Test Title"); doc.setContent("Test Content"); documentRepository.save(doc); Optional<Document> retrievedDoc = documentRepository.findById("1"); assert retrievedDoc.isPresent(); } } ``` 此测试用例验证了保存和检索文档的功能[^1]。 #### 实现全文搜索 为了实现全文搜索功能,可以在`DocumentRepository`中定义一个自定义查询方法: ```java import org.springframework.data.elasticsearch.core.query.NativeSearchQuery; import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder; import org.springframework.data.elasticsearch.core.query.QueryBuilders; public interface DocumentRepository extends ElasticsearchRepository<Document, String> { default Iterable<Document> searchByContent(String text) { NativeSearchQuery searchQuery = new NativeSearchQueryBuilder() .withQuery(QueryBuilders.matchQuery("content", text)) .build(); return documentRepository.search(searchQuery); } } ``` 此方法使用Elasticsearch的`matchQuery`来进行全文搜索[^2]。 #### 分页查询 为了支持分页查询,可以在`DocumentRepository`中定义一个带有分页参数的方法: ```java import org.springframework.data.domain.Pageable; import org.springframework.data.elasticsearch.core.query.NativeSearchQuery; import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder; import org.springframework.data.elasticsearch.core.query.QueryBuilders; public interface DocumentRepository extends ElasticsearchRepository<Document, String> { default Iterable<Document> searchByContentWithPagination(String text, Pageable pageable) { NativeSearchQuery searchQuery = new NativeSearchQueryBuilder() .withQuery(QueryBuilders.matchQuery("content", text)) .withPageable(pageable) .build(); return documentRepository.search(searchQuery); } } ``` 此方法允许用户指定分页参数,以便处理大量数据时能够分批次获取结果[^2]。 #### 排序与聚合查询 对于排序和聚合查询,可以在`DocumentRepository`中定义相应的方法: ```java import org.springframework.data.elasticsearch.core.query.NativeSearchQuery; import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder; import org.springframework.data.elasticsearch.core.query.QueryBuilders; import org.springframework.data.elasticsearch.core.query.SortBuilders; import org.springframework.data.elasticsearch.core.query.AggregationBuilders; public interface DocumentRepository extends ElasticsearchRepository<Document, String> { default Iterable<Document> searchByContentWithSorting(String text) { NativeSearchQuery searchQuery = new NativeSearchQueryBuilder() .withQuery(QueryBuilders.matchQuery("content", text)) .withSort(SortBuilders.fieldSort("title").order(SortOrder.ASC)) .build(); return documentRepository.search(searchQuery); } default void performAggregation() { NativeSearchQuery searchQuery = new NativeSearchQueryBuilder() .withQuery(QueryBuilders.matchAllQuery()) .addAggregation(AggregationBuilders.terms("titles").field("title.keyword")) .build(); // 处理聚合结果 } } ``` 这些方法分别实现了按标题排序和按标题进行聚合查询的功能[^2]。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值