在本文中，我们将学习如何将Spring Boot与Elasticsearch（ES）客户端整合，以便能够方便地进行文档的索引、搜索和查询操作。Elasticsearch是一个开源的分布式搜索和分析引擎，它提供了快速、可扩展且具有强大查询功能的全文搜索功能。
准备工作
在开始之前，确保已经完成了以下准备工作：
- 安装并运行Elasticsearch服务器
- 创建一个Spring Boot项目，并添加所需的依赖项
添加依赖项
为了使用ES客户端，我们需要在项目的pom.xml文件中添加以下依赖项：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency>
这将使我们能够使用Spring Boot提供的ES客户端自动配置功能。
配置ES客户端
在application.properties文件中，添加以下ES客户端的配置：
spring.data.elasticsearch.cluster-nodes=localhost:9200
这里的localhost:9200是ES服务器的地址和端口号。
创建实体类
在开始索引和查询文档之前，我们需要创建一个与ES文档结构对应的实体类。例如，我们创建一个名为Book的实体类：
@Document(indexName = "library", type = "book")
public class Book {
@Id
private String id;
@Field(type = FieldType.Text)
private String title;
@Field(type = FieldType.Integer)
private int year;
// getters and setters
}
这里的@Document注解指定了文档的索引名称和类型，@Id注解标识了文档的唯一标识字段，@Field注解指定了文档的各个字段。
创建ES仓库
接下来，我们需要创建一个ES仓库接口，用于操作ES文档。创建一个名为BookRepository的接口，并继承ElasticsearchRepository，如下所示：
@Repository
public interface BookRepository extends ElasticsearchRepository<Book, String> {
List<Book> findByTitle(String title);
List<Book> findByYearBetween(int startYear, int endYear);
}
这里，BookRepository继承了ElasticsearchRepository接口，它包含了许多用于操作ES文档的方法。我们还可以定义自己的自定义查询方法。
索引文档
在索引（保存）文档之前，我们首先需要创建一个Book对象，并将其保存到ES中。可以在任何Spring组件（Controller、Service等）中使用BookRepository来进行操作。以下是一个示例：
@RestController
public class BookController {
@Autowired
private BookRepository bookRepository;
@PostMapping("/book")
public ResponseEntity<String> indexBook(@RequestBody Book book) {
bookRepository.save(book);
return ResponseEntity.ok("Book indexed successfully");
}
}
在这个示例中，我们使用了@Autowired注解将BookRepository注入到了BookController中。通过调用bookRepository.save(book)方法，我们可以将book对象保存到ES中。
查询文档
通过BookRepository，我们可以轻松地进行各种查询操作。以下是一些常见的查询示例：
@RestController
public class BookController {
@Autowired
private BookRepository bookRepository;
@GetMapping("/book/{id}")
public ResponseEntity<Book> getBookById(@PathVariable String id) {
Optional<Book> book = bookRepository.findById(id);
return book.map(ResponseEntity::ok).orElse(ResponseEntity.notFound().build());
}
@GetMapping("/book/search")
public List<Book> searchBooks(@RequestParam String keyword) {
return bookRepository.findByTitle(keyword);
}
@GetMapping("/book/searchByYear")
public List<Book> searchBooksByYearRange(@RequestParam int startYear, @RequestParam int endYear) {
return bookRepository.findByYearBetween(startYear, endYear);
}
}
上述示例中，getBookById()方法通过调用bookRepository.findById(id)来获取指定id的文档数据。searchBooks()方法通过调用bookRepository.findByTitle(keyword)来获取包含指定关键字的书籍列表。searchBooksByYearRange()方法通过调用bookRepository.findByYearBetween(startYear, endYear)来获取指定年份范围内的书籍列表。
结束语
在本教程中，我们学习了如何使用Spring Boot整合ES客户端，并进行文档的索引和查询操作。ES作为一款强大的全文搜索引擎，提供了丰富的查询功能，能够满足各种搜索需求。通过使用Spring Boot的自动配置和ES客户端，我们能够更加方便地与ES集成，快速构建功能强大的搜索功能。
希望本文能够帮助你在Spring Boot项目中使用ES客户端进行文档的索引和查询操作。如有任何疑问，欢迎留言交流！
本文来自极简博客，作者：绮梦之旅，转载请注明原文链接：Spring Boot整合ES客户端及查询文档
