Spring Boot 揭秘与实战（二） 数据存储篇 - ElasticSearch

时间：2023-11-12 19:13:20

本文讲解Spring Boot基础下，如何使用 ElasticSearch，实现全文搜索。

版本须知

spring data elasticSearch 的版本与Spring boot、Elasticsearch版本需要匹配。

Spring Boot Version (x) Spring Data Elasticsearch Version (y) Elasticsearch Version (z)
x <= 1.3.5 y <= 1.3.4 z <= 1.7.2
x >= 1.4.x 2.0.0 <=y <5.0.0 2.0.0 <= z < 5.0.0

环境依赖

修改 POM 文件，添加 spring-boot-starter-data-elasticsearch 依赖。

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
  4. </dependency>

数据源

方案一 使用 Spring Boot 默认配置

在 src/main/resources/application.properties 中配置数据源信息。

  1. spring.data.elasticsearch.properties.host = 127.0.0.1
  2. spring.data.elasticsearch.properties.port = 9300

通过 Java Config 创建ElasticSearchConfig。

  1. @Configuration
  2. @EnableElasticsearchRepositories("com.lianggzone.springboot.action.data.elasticsearch")
  3. public class ElasticSearchConfig {}

方案二 手动创建

通过 Java Config 创建ElasticSearchConfig。

  1. @Configuration
  2. @EnableElasticsearchRepositories("com.lianggzone.springboot.action.data.elasticsearch")
  3. public class ElasticsearchConfig2 {
  4. private String hostname = "127.0.0.1";
  5. private int port = 9300;
  6. @Bean
  7. public ElasticsearchOperations elasticsearchTemplate() {
  8. return new ElasticsearchTemplate(client());
  9. }
  10. @Bean
  11. public Client client() {
  12. TransportClient client = new TransportClient();
  13. TransportAddress address = new InetSocketTransportAddress(hostname, port);
  14. client.addTransportAddress(address);
  15. return client;
  16. }
  17. }

业务操作

实体对象

  1. @Document(indexName = "springbootdb", type = "news")
  2. public class News {
  3. @Id
  4. private String id;
  5. private String title;
  6. private String content;
  7. @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyyMMdd'T'HHmmss.SSS'Z'")
  8. @Field(type = FieldType.Date, format = DateFormat.basic_date_time, index = FieldIndex.not_analyzed)
  9. @CreatedDate
  10. private Date createdDateTime;
  11. // GET和SET方法
  12. }

DAO相关

  1. public interface NewsRepository extends ElasticsearchRepository<News, String> {
  2. public List<News> findByTitle(String title);
  3. }

Service相关

我们来定义实现类，Service层调用Dao层的方法，这个是典型的套路。

  1. @Service
  2. public class NewsService {
  3. @Autowired
  4. private NewsRepository newsRepository;
  5. public Iterable<News> findAll(){
  6. return newsRepository.findAll();
  7. }
  8. public Iterable<News> search(QueryBuilder query){
  9. return newsRepository.search(query);
  10. }
  11. public List <News> findByTitle(String title) {
  12. return this.newsRepository.findByTitle(title);
  13. }
  14. public void deleteAll(String id){
  15. this.newsRepository.delete(id);
  16. }
  17. public void init(){
  18. for (int i = 0; i < 100; i++) {
  19. News news = new News();
  20. news.setId(i+"");
  21. news.setTitle(i + ".梁桂钊单元测试用例");
  22. news.setContent("梁桂钊单元测试用例"+i+"xxxxx");
  23. news.setCreatedDateTime(new Date());
  24. this.newsRepository.save(news);
  25. }
  26. }
  27. }

Controller相关

为了展现效果，我们先定义一组简单的　RESTful API 接口进行测试。

  1. @RestController
  2. @RequestMapping(value="/data/elasticsearch/news")
  3. public class NewsController {
  4. @Autowired
  5. private NewsService newsService;
  6. /**
  7. * 初始化
  8. * @param request
  9. */
  10. @RequestMapping(value = "/init", method = RequestMethod.POST)
  11. public void init(HttpServletRequest request) {
  12. this.newsService.init();
  13. }
  14. /**
  15. * findAll
  16. * @param request
  17. * @return
  18. */
  19. @RequestMapping(value = "/", method = RequestMethod.GET)
  20. public Map<String, Object> findList(HttpServletRequest request) {
  21. Map<String, Object> params = new HashMap<String, Object>();
  22. params.put("items", this.newsService.findAll());
  23. return params;
  24. }
  25. /**
  26. * find
  27. * @param request
  28. * @return
  29. */
  30. @RequestMapping(value = "/{title}", method = RequestMethod.GET)
  31. public Map<String, Object> search(@PathVariable String title) {
  32. // 构建查询条件
  33. QueryBuilder queryBuilder = QueryBuilders.queryString(title);
  34. Map<String, Object> params = new HashMap<String, Object>();
  35. params.put("items", this.newsService.search(queryBuilder));
  36. return params;
  37. }
  38. }

总结

上面这个简单的案例，让我们看到了 Spring Boot 整合 ElasticSearch 流程如此简单。

源代码

相关示例完整代码： springboot-action

(完)

如果觉得我的文章对你有帮助，请随意打赏。

Spring Boot 揭秘与实战（二） 数据存储篇 - ElasticSearch

相关文章