Spring Data ElasticSearch总结

Spring Data ElasticSearch

1. 什么是Spring Data ElasticSearch

         Spring Data ElasticSearch 基于 spring data API 简化 elasticSearch操作，将原始操作elasticSearch的客户端API进行封装 。Spring Data为Elasticsearch项目提供集成搜索引擎。Spring Data Elasticsearch POJO的关键功能区域为中心的模型与Elastichsearch交互文档和轻松地编写一个存储库数据访问层。

2. Spring Data ElasticSearch入门

(1) maven坐标

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch</groupId>
            <artifactId>elasticsearch</artifactId>
            <version>5.6.8</version>
        </dependency>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>transport</artifactId>
            <version>5.6.8</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j‐to‐slf4j</artifactId>
            <version>2.9.1</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j‐api</artifactId>
            <version>1.7.24</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j‐simple</artifactId>
            <version>1.7.21</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.12</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
2）创建applicationContext.xml配置文件，引入elasticsearch命名空间
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson‐core</artifactId>
            <version>2.8.1</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson‐databind</artifactId>
            <version>2.8.1</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson‐annotations</artifactId>
            <version>2.8.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring‐data‐elasticsearch</artifactId>
            <version>3.0.5.RELEASE</version>
            <exclusions>
                <exclusion>
                    <groupId>org.elasticsearch.plugin</groupId>
                    <artifactId>transport‐netty4‐client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring‐test</artifactId>
            <version>5.0.4.RELEASE</version>
        </dependency>
    </dependencies>

(2) 配置文件

<?xml version="1.0" encoding="UTF‐8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema‐instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
       xsi:schemaLocation="
http://www.springframework.org/schema/beans        
http://www.springframework.org/schema/beans/spring‐beans.xsd        
http://www.springframework.org/schema/context        
http://www.springframework.org/schema/context/spring‐context.xsd        
http://www.springframework.org/schema/data/elasticsearch        
http://www.springframework.org/schema/data/elasticsearch/spring‐elasticsearch‐1.0.xsd        
">        
   
    <!‐‐ 扫描Dao包，自动创建实例 ‐‐>
    <elasticsearch:repositories base‐package="com.itheima.dao"/>
    <!‐‐ 配置elasticSearch的连接 ‐‐>
        <!‐‐ 配置elasticSearch的连接 ‐‐>
    <elasticsearch:transport‐client id="client" cluster‐nodes="127.0.0.1:9300,127.0.0.1:9301,127.0.0.1:9302" cluster‐name="my‐
elasticsearch"/>
    <!‐‐ ElasticSearch模版对象 ‐‐>
    <bean id="elasticsearchTemplate"
          class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
        <constructor‐arg name="client" ref="client"></constructor‐arg>
    </bean>
</beans>

(3) Document类

/**
*@Document(indexName="blob3",type="article")：
    indexName：索引的名称（必填项）
    type：索引的类型
@Id：主键的唯一标识
@Field(index=true,analyzer="ik_smart",store=true,searchAnalyzer="ik_smart",type =
FieldType.text)
    index：是否设置分词
    analyzer：存储时使用的分词器
    searchAnalyze：搜索时使用的分词器
    store：是否存储
    type: 数据类型
*/
//@Document 文档对象 （索引信息、文档类型 ）
@Document(indexName="blog3",type="article")
public class Article {
    //@Id 文档主键 唯一标识
    @Id
    //@Field 每个文档的字段配置（类型、是否分词、是否存储、分词器 ）
    @Field(store=true, index = false,type = FieldType.Integer)
    private Integer id;
    
    @Field(index=true,analyzer="ik_smart",store=true,searchAnalyzer="ik_smart",type =
FieldType.text)
    private String title;
    
    @Field(index=true,analyzer="ik_smart",store=true,searchAnalyzer="ik_smart",type =
FieldType.text)
    private String content;
    //省get，set
    }

(4 ) 编写Dao

//在继承的ElasticsearchRepository，里面动态代理许多查询方法  
/*
关键字       命名规则                   解释                          示例
and      findByField1AndField2   根据Field1和Field2获得数据    findByTitleAndContent
or       findByField1OrField2    根据Field1或Field2获得数据    findByTitleOrContent
is       findByField             根据Field获得数据             findByTitle
not      findByFieldNot          根据Field获得补集数据         findByTitleNot
between  findByFieldBetween      获得指定范围的数据            findByPriceBetween
lessThan findByFieldLessThan     获得小于等于指定值的数据      findByPriceLessThan
*/
@Repository
public interface ArticleRepository extends ElasticsearchRepository<Article, Long> {
    //如果想要自定方法，需要符合规范
    //根据标题查询
    List<Article> findByTitle(String condition);
    //根据标题查询(含分页)
    Page<Article> findByTitle(String condition, Pageable pageable);
}

(5) 测试

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations="classpath:applicationContext.xml")
public class SpringDataESTest {
    @Autowired
    private ArticleRepository articleRepository;
    @Autowired
    private TransportClient client;
    @Autowired
    private ElasticsearchTemplate elasticsearchTemplate;
    /**创建索引和映射*/
    @Test
    public void createIndex(){
        //1.创建索引配置映射关系
        elasticsearchTemplate.createIndex(Article.class);
        
        //配置映射关系,用索引没映射时使用
        //elasticsearchTemplate.putMapping(Article.class);
    }
    /**测试保存文档*/
    @Test
    public void text1(){
        //创建Article对象
        Article article=new Article();
        article.setId(2);
        article.setTitle("Maven项目");
        article.setContent("Maven项目");
        articleRepository.save(article);
    }
    @Test
    public void text2(){
        //删除Article对象
        articleRepository.deleteById(2l);
    }
    @Test
    public void text3(){
        //查询Article对象
        Iterable<Article> all = articleRepository.findAll();
        all.forEach(a-> System.out.println(a));
    }
    @Test
    public void text4(){
       //根据id查找
       Optional<Article> optional = articleRepository.findById(1l);
       Article article = optional.get();
       System.out.println(article);
    }
    @Test
    public void findByNativeQuery() {
        //创建一个SearchQuery对象
        SearchQuery searchQuery = new NativeSearchQueryBuilder()
                //设置查询条件，此处可以使用QueryBuilders创建多种查询
                .withQuery(QueryBuilders.queryStringQuery("备份节点上没有数
据").defaultField("title"))
                //还可以设置分页信息
                .withPageable(PageRequest.of(1, 5))
                //创建SearchQuery对象
                .build();
        //使用模板对象执行查询
        elasticsearchTemplate.queryForList(searchQuery, Article.class)
                .forEach(a‐> System.out.println(a));
    }
    /**条件查询*/
    @Test
    public void findByTitle(){
        String condition = "版本";
        List<Article> articleList = articleRepository.findByTitle(condition);
        for(Article article:articleList){
            System.out.println(article);
        }
    }
    /**条件分页查询*/
    @Test
    public void findByTitlePage(){
        String condition = "版本";
        Pageable pageable = PageRequest.of(2,10);
        Page<Article> page = articleRepository.findByTitle(condition,pageable);
        for(Article article:page.getContent()){
            System.out.println(article);
        }
    }
}