一文读懂SpringBoot整合Elasticsearch（一）

缺乏、安全感 2024-03-26 13:04 40阅读 0赞

（本篇文章主要介绍Spring Boot如何整合Elasticsearch，包括基本配置、数据操作、搜索功能等方面。）

## 一、前言 ##

Elasticsearch是一款全文搜索引擎，可用于快速、准确地存储、搜索和分析大量数据。而Spring Boot是一款快速开发框架，它提供了简单易用的方式来构建Web应用程序。本文将介绍如何使用Spring Boot整合Elasticsearch，实现快速、高效地存储和搜索数据的功能。

## 二、环境准备 ##

在开始整合Elasticsearch之前，需要确保已经安装了Java开发环境和Elasticsearch服务。可以从官方网站下载最新版本的Java和Elasticsearch。

## 三、引入依赖 ##

Spring Boot整合Elasticsearch需要引入以下依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
    </dependency>

## 四、基本配置 ##

在application.properties文件中添加以下配置信息：

kotlinCopy codespring.data.elasticsearch.cluster-name=my-application
    spring.data.elasticsearch.cluster-nodes=localhost:9300

其中，cluster-name是Elasticsearch集群的名称，cluster-nodes是Elasticsearch服务的地址和端口号。

## 数据操作 ##

1.  **创建实体类**

首先需要创建一个实体类，用来表示要存储在Elasticsearch中的数据。例如，创建一个名为Book的实体类，包含id、title、author、content等属性。

public class Book {
        private Long id;
        private String title;
        private String author;
        private String content;
        //省略getter和setter方法
    }

**2 创建ElasticsearchRepository**

在Spring Boot中，可以使用ElasticsearchRepository来操作Elasticsearch。创建一个名为BookRepository的接口，继承ElasticsearchRepository，指定实体类和主键类型。例如：

public interface BookRepository extends ElasticsearchRepository<Book, Long> {
    }

**3 数据操作**

现在可以使用BookRepository来对Elasticsearch中的数据进行操作。例如，可以使用save方法将一个Book对象保存到Elasticsearch中。

@Autowired
    private BookRepository bookRepository;
    
    Book book = new Book();
    book.setId(1L);
    book.setTitle("Java编程思想");
    book.setAuthor("Bruce Eckel");
    book.setContent("Java编程思想是一本Java经典著作。");
    bookRepository.save(book);

## 四、搜索功能 ##

1.  **创建查询接口**

首先需要创建一个查询接口，用来定义查询方法。例如，创建一个名为BookService的接口，包含一个名为search的方法，用来根据关键词查询数据。

public interface BookService {
        List<Book> search(String keyword);
    }

**2 创建查询实现类**

接着需要创建一个查询实现类，实现BookService接口中的search方法。在实现类中注入BookRepository，使用它来查询Elasticsearch中的数据。

@Service
    public class BookServiceImpl implements BookService {
        @Autowired
        private BookRepository bookRepository
      Override
    public List<Book> search(String keyword) {
        SearchQuery searchQuery = new NativeSearchQueryBuilder()
                .withQuery(QueryBuilders.queryStringQuery(keyword))
                .build();
        return bookRepository.search(searchQuery).getContent();
    }

在上面的代码中，首先创建了一个SearchQuery对象，它表示查询条件。使用NativeSearchQueryBuilder来构建查询条件，其中withQuery方法接受一个QueryBuilder对象作为参数，用来指定查询语句。这里使用了queryStringQuery方法来构建一个基于关键词的查询语句。 然后，使用bookRepository.search方法来执行查询，返回一个Page对象。调用getContent方法可以获取查询结果。

**3. 测试搜索功能**

现在可以测试搜索功能了。例如，执行以下代码：

@Autowired
    private BookService bookService;
    
    List<Book> books = bookService.search("Java");
    for (Book book : books) {
    System.out.println(book.getTitle());
    }

这段代码会查询所有标题包含“Java”的图书，并将它们的标题打印出来。

## 五、总结 ##

本文介绍了Spring Boot如何整合Elasticsearch，包括基本配置、数据操作、搜索功能等方面。通过Spring Boot整合Elasticsearch，可以方便快捷地实现数据存储和搜索功能。

## 六、常见问题解决 ##

在整合Elasticsearch的过程中，可能会遇到一些常见的问题。下面是一些解决方法：

1.  **Elasticsearch服务无法连接**

如果在运行Spring Boot应用程序时遇到“Elasticsearch服务无法连接”的错误，请确保已经启动Elasticsearch服务，并检查application.properties文件中的cluster-nodes配置是否正确。

**2 无法创建索引**

如果在使用ElasticsearchRepository保存数据时遇到“无法创建索引”的错误，请检查实体类的注解是否正确，例如是否添加了@Document注解，并指定了indexName和type。

**3 搜索结果为空**

如果在执行搜索时返回空结果，请检查查询条件是否正确。可以使用Kibana工具来查看Elasticsearch中的数据，并尝试使用Kibana来执行查询语句，以确定查询语句是否正确。

**4 分页查询问题**

如果想要实现分页查询功能，可以使用Spring Data提供的Pageable接口来实现。例如：

Pageable pageable = PageRequest.of(pageNumber, pageSize);
    SearchQuery searchQuery = new NativeSearchQueryBuilder()
            .withQuery(QueryBuilders.queryStringQuery(keyword))
            .withPageable(pageable)
            .build();
    return bookRepository.search(searchQuery).getContent();

这里使用了PageRequest.of方法来创建一个Pageable对象，并将它传递给NativeSearchQueryBuilder的withPageable方法。

## 七、总结 ##

本文介绍了Spring Boot如何整合Elasticsearch，包括基本配置、数据操作、搜索功能等方面。通过Spring Boot整合Elasticsearch，可以方便快捷地实现数据存储和搜索功能。在实践中可能会遇到一些常见问题，需要注意解决。

## 八、参考资料 ##

1.  Spring Data Elasticsearch官方文档：https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/
2.  Elasticsearch官方文档：https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
3.  Spring Boot官方文档：https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/
4.  Spring官方文档：https://docs.spring.io/spring/docs/current/spring-framework-reference/index.html
5.  Kibana官方文档：https://www.elastic.co/guide/en/kibana/current/index.html

## 九、结语 ##

本文通过实例演示了Spring Boot如何整合Elasticsearch，并介绍了基本配置、数据操作、搜索功能等方面的知识。通过这些内容，读者可以快速上手使用Spring Boot和Elasticsearch来构建数据存储和搜索应用程序。

当然，本文只是一个入门级别的介绍，读者可以深入学习Spring Boot和Elasticsearch的更多知识，来构建更为复杂的应用程序。希望读者在学习过程中能够积极思考，不断提高自己的技能和能力。

![9715e7c3083b42009e73a8ccc31ce201.png][]

[9715e7c3083b42009e73a8ccc31ce201.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/5042dedfc9cd4a63887a4108b20aa132.png