SpringBoot整合ElasticSearch的示例代码

时间:2022-05-20 02:16:43

ElasticSearch作为基于Lucene的搜索服务器,既可以作为一个独立的服务部署,也可以签入Web应用中。SpringBoot作为Spring家族的全新框架,使得使用SpringBoot开发Spring应用变得非常简单。本文要介绍如何整合ElasticSearch与SpringBoot。

实体设计:

每一本书(Book)都属于一个分类(Classify),都有一个作者(Author)。

生成这个三个实体类,并实现其get和set方法。

SpringBoot配置修改:

1.修改pom.xml文件,引入相应依赖

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<parent>
    <groupId> org.springframework.boot </groupId>
    <artifactId> spring-boot-starter-parent </artifactId>
    <version> 1.3.0.RELEASE </version>
</parent>
 
<dependencies>
      <!-- 添加 web 应用的依赖 -->
    <dependency>
      <groupId> org.springframework.boot </groupId>
      <artifactId> spring-boot-starter-web</artifactId>
    </dependency>
    <!-- 添加 spring-data-elasticsearch的依赖 -->
    <dependency>
      <groupId> org.springframework.boot </groupId>
      <artifactId> spring-boot-starter-data-elasticsearch </artifactId>
    </dependency>
    <dependency>
      <groupId> org.springframework.boot</groupId>
      <artifactId> spring-boot-starter-test </artifactId>
    </dependency>
  </dependencies>

2.修改配置文件application.yml。

这些配置的属性,最终会设置到ElasticsearchProperties这个实体中。

?
1
2
3
4
5
6
7
8
9
spring:
  data:
    elasticsearch:
      cluster-name: #默认为elasticsearch
      cluster-nodes: #配置es节点信息,逗号分隔,如果没有指定,则启动ClientNode
      properties:
        path:
         logs: ./elasticsearch/log #elasticsearch日志存储目录
         data: ./elasticsearch/data #elasticsearch数据存储目录

3.为实体添加ElascticSearch注解

Spring-data-elasticSearch提供了一些注解来帮助我们快速针对实体建立索引。

因为我们希望Article作为我们文章的搜索入口,所以我们在Article类上添加@Document注解。

?
1
2
3
4
@Document(indexName="projectname",type="article",indexStoreType="fs",shards=5,replicas=1,refreshInterval="-1")
public class Book implements Serializable{
....
}

默认情况下,添加@Document注解会对实体中的所有属性建立索引,由于本教程是讲解如何整合,并不是专门讲解ElasticSearch,故对于其他注解不再讲解。

4.建立搜索类

我们只要编写一个接口ArticleSearchRepository,来继承Spring-data-elasticSearch提供的ElasticsearchRepository即可。

?
1
2
3
4
5
6
7
import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
 
import com.tianshouzhi.springbootstudy.domain.Article;
//泛型的参数分别是实体类型和主键类型
public interface BookSearchRepository extends ElasticsearchRepository<Article, Long>{
 
}

5.创建索引及搜索测试

创建索引

?
1
2
3
4
5
6
7
8
9
10
11
12
13
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class ElasticSearchTest {
 
  @Autowired
  private BookSearchRepository articleSearchRepository;
  @Test
  public void testSaveArticleIndex(){
    //初始化实体类,建立索引
    ......
  }
 
}

运行单元测试,项目根目录下出现:

说明我们索引已经创建成功。

搜索测试

?
1
2
3
4
5
6
7
8
9
10
@Test
  public void testSearch(){
    String queryString="springboot";//搜索关键字
    QueryStringQueryBuilder builder=new QueryStringQueryBuilder(queryString);
    Iterable<Book> searchResult = articleSearchRepository.search(builder);
    Iterator<Book> iterator = searchResult.iterator();
    while(iterator.hasNext()){
      System.out.println(iterator.next());
    }
  }

运行单元测试,控制台输出

  1. Article [id=1, title=springboot integreate elasticsearch, abstracts=springboot integreate elasticsearch is very easy, content=elasticsearch based on lucene,spring-data-elastichsearch based on elaticsearch,this tutorial tell you how to integrete springboot with spring-data-elasticsearch, postTime=Sun Feb 21 16:01:37 CST 2016, clickCount=1,  
  2. 搜索结果 

说明搜索成功。读者可以尝试其他的搜索关键字进行搜索。

说明:

以上方式是SpringBoot与ElasticSearch进行本地整合,即将ElasticSearch内嵌在应用,如果我们搭建了ElasticSearch集群,只需要将配置改为如下配置即可:

 
1
2
3
4
spring:
  data:
    elasticsearch:
      cluster-nodes:115.28.65.149:9300 #配置es节点信息,逗号分隔,如果没有指定,则启动ClientNode

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。

原文链接:http://blog.csdn.net/wangshuang1631/article/details/72627489