【Elasticsearch】整合Spring Data Elasticsearch

1. 整合Spring Data Elasticsearch

1. 如何查看官方文档（了解）

官方文档：​​Java High Level REST Client | Java REST Client [6.8] | Elastic​​

下面是获得文档的方式（可以不用看）：

1. 步骤一：查询“文档”

1. 步骤二：查看“客户端Client”文档

1. 步骤三：查看基于REST的api

1. 步骤四：确定使用的版本

1. 步骤五：选择使用的API基本

1. Low Level Rest Client是低级别封装，提供一些基础功能，但更灵活
2. High Level Rest Client，是在Low  Level Rest Client基础上进行的高级别封装，功能更丰富和完善

1. 简介

Spring Data Elasticsearch是Spring Data项目下的一个子模块。

简化了原生的Elasticsearch的开发。

1. 什么是spring data

查看 Spring Data的官网：http://projects.spring.io/spring-data/

Spring Data 是的使命是给各种数据访问提供统一的编程接口，不管是关系型数据库（如MySQL），还是非关系数据库（如Redis），或者类似Elasticsearch这样的索引数据库。从而简化开发人员的代码，提高开发效率。

包含很多不同数据操作的模块：

1. 什么是spring data elasticsearch

Spring Data Elasticsearch的页面：https://projects.spring.io/spring-data-elasticsearch/

特征：

• 支持Spring的基于@Configuration的java配置方式
• 提供了用于操作ES的便捷工具类ElasticsearchTemplate。包括实现文档到POJO之间的自动智能映射。
• 利用Spring的数据转换服务实现的功能丰富的对象映射
• 基于注解的元数据映射方式，而且可扩展以支持更多不同的数据格式
• 根据持久层接口自动生成对应实现方法，无需人工编写基本操作代码（类似mybatis，根据接口自动得到实现）。当然，也支持人工定制查询

1. 版本限定

​​​​https://docs.spring.io/spring-data/elasticsearch/docs/4.2.1/reference/html/#preface.versions​​​​

1. 创建Demo工程

我们新建一个test-elasticsearch，学习Elasticsearch

1. pom依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>changgou4-parent-ali</artifactId>
<groupId>com.czxy.changgou</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>test-elasticsearch</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<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>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>

1. 配置工具类

​​Initialization | Java REST Client [6.8] | Elastic​​

package com.czxy.changgou4.config;

import org.elasticsearch.client.RestHighLevelClient;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.data.elasticsearch.client.ClientConfiguration;

import org.springframework.data.elasticsearch.client.RestClients;

import org.springframework.data.elasticsearch.config.AbstractElasticsearchConfiguration;

import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;

/**

 * @author 桐叔

 * @email [email protected]

 */

@Configuration

@EnableElasticsearchRepositories

public class RestClientConfig extends AbstractElasticsearchConfiguration {

@Override

    @Bean

    public RestHighLevelClient elasticsearchClient() {

        final ClientConfiguration clientConfiguration = ClientConfiguration.builder()

                .connectedTo("localhost:9200")

                .build();

        return RestClients.create(clientConfiguration).rest();

    }

}

1. 启动类

package com.czxy.changgou4;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

/**

 * @author 桐叔

 * @email [email protected]

 */

@SpringBootApplication

public class TestESApplication {

    public static void main(String[] args) {

        SpringApplication.run(TestESApplication.class,args);

    }

}

1. 测试类

package com.czxy.changgou4;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.test.context.junit4.SpringRunner;

/**

 * @author 桐叔

 * @email [email protected]

 */

@RunWith(SpringRunner.class)

@SpringBootTest(classes = TestESApplication.class)

public class TestES {

@Test

    public void testDemo() {

        System.out.println("....");

    }

}

1. 索引操作

1. 创建索引和映射

1. 实体类：首先我们准备好实体类：

public class Item {

     private Long id;

     private String title; //标题

     private String category; //分类

     private String brand; //品牌

     private Double price; //价格

    private String images; //图片地址

}

1. 映射

Spring Data通过注解来声明字段的映射属性，有下面的三个注解：

• @Document 作用在类，标记实体类为文档对象，一般有两个属性

• indexName：对应索引库名称
• type：对应在索引库中的类型
• shards：分片数量，默认5
• replicas：副本数量，默认1

• @Id 作用在成员变量，标记一个字段作为id主键
• @Field 作用在成员变量，标记为文档的字段，并指定字段映射属性：

• type：字段类型，是是枚举：FieldType
• index：是否索引，布尔类型，默认是true
• store：是否存储，布尔类型，默认是false
• analyzer：分词器名称

• 示例：

@Document(indexName = "item",type = "docs", shards = 1, replicas = 0)

public class Item {

@Id

    private Long id;

@Field(type = FieldType.Text, analyzer = "ik_max_word")

    private String title; //标题

@Field(type = FieldType.Keyword) //不分词

    private String category;// 分类

@Field(type = FieldType.Keyword)

    private String brand; // 品牌

@Field(type = FieldType.Double)

    private Double price; // 价格

@Field(index = false, type = FieldType.Keyword)

    private String images; // 图片地址

}

• 创建索引

package com.czxy;

import com.czxy.changgou4.TestESApplication;

import com.czxy.changgou4.domain.Item;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;

import org.springframework.data.elasticsearch.core.ElasticsearchTemplate;

import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

/**

 * @author 桐叔

 * @email [email protected]

 */

@RunWith(SpringRunner.class)

@SpringBootTest(classes = TestESApplication.class)

public class TestES {

@Resource

    private ElasticsearchRestTemplate elasticsearchTemplate;

@Test

    public void testCreateIndex() {

        elasticsearchTemplate.createIndex(Item.class);

    }

}

• 可以根据类的信息自动生成，也可以手动指定indexName和Settings

映射

映射相关的API：

• 一样，可以根据类的字节码信息（注解配置）来生成映射，或者手动编写映射

我们这里采用类的字节码信息创建索引并映射：

package com.czxy;

import com.czxy.pojo.Item;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.data.elasticsearch.core.ElasticsearchTemplate;

import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

/**

 * Created by liangtong.

 */

@RunWith(SpringRunner.class)

@SpringBootTest(classes = ESApplication.class)

public class TestES {

@Resource

private ElasticsearchTemplate elasticsearchTemplate;

@Test

public void createIndex(){

elasticsearchTemplate.createIndex(Item.class );

elasticsearchTemplate.putMapping(Item.class);

}

}

结果：

1. 删除索引

删除索引的API：

可以根据类名或索引名删除。

示例：

@Test

public void deleteIndex() {

deleteIndex("item");

}

1. 新增文档数据

1. Repository接口

Spring Data 的强大之处，就在于你不用写任何DAO处理，自动根据方法名或类的信息进行CRUD操作。只要你定义一个接口，然后继承Repository提供的一些子接口，就能具备各种基本的CRUD功能。

来看下Repository的继承关系：

.

含Crud的接口表示已经完成增删改查操作，例如：ElasticsearchCrudRepository接口：

如果继承ElasticsearchRepository子接口，同时也继承了其父接口声明的所有功能。

所以，我们只需要定义接口，然后继承它就OK了。

public interface ItemRepository extends ElasticsearchRepository<Item,Long> {

}

接下来，我们测试新增数据：

1. 新增一个对象
2. ​

@Autowired
private ItemRepository itemRepository;
@Test
public void index() {
    Item item = new Item(1L, "小米手机7", "手机",
"小米", 3499.00, "http://image.baidu.com/13123.jpg");
save(item);
}
去页面查询看看：
{
"took": 0,
"timed_out": false,
"_shards": {
"total": 1,
"successful": 1,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 1,
"max_score": 1,
"hits": [
{
"_index": "item",
"_type": "docs",
"_id": "1",
"_score": 1,
"_source": {
"id": 1,
"title": "小米手机7",
"category": " 手机",
"brand": "小米",
"price": 3499,
"images": "http://image.baidu.com/13123.jpg"
}
}
      }
]
}
}

1. 批量新增

代码：

@Test

public void indexList() {

List<Item> list = new ArrayList<>();
add(new Item(2L, "坚果手机R1", "手机", "锤子", 3699.00, "http://image.baidu.com/13123.jpg"));
add(new Item(3L, "华为META10", "手机", "华为", 4499.00, "http://image.baidu.com/13123.jpg"));
    // 接收对象集合，实现批量新增
saveAll(list);
}
再次去页面查询：
{
"took": 5,
"timed_out": false,
"_shards": {
"total": 1,
"successful": 1,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 3,
"max_score": 1,
"hits": [
{
"_index": "item",
"_type": "docs",
"_id": "2",
"_score": 1,
"_source": {
"id": 2,
"title": "坚果手机R1",
"category": " 手机",
"brand": "锤子",
"price": 3699,
"images": "http://image.baidu.com/13123.jpg"
}
},
{
"_index": "item",
"_type": "docs",
"_id": "3",
"_score": 1,
"_source": {
"id": 3,
"title": "华为META10",
"category": " 手机",
"brand": "华为",
"price": 4499,
"images": "http://image.baidu.com/13123.jpg"
}
},
{
"_index": "item",
"_type": "docs",
"_id": "1",
"_score": 1,
"_source": {
"id": 1,
"title": "小米手机7",
"category": " 手机",
"brand": "小米",
"price": 3499,
"images": "http://image.baidu.com/13123.jpg"
}
}
]
}
}

1. 修改

修改和新增是同一个接口，区分的依据就是id，这一点跟我们在页面发起PUT请求是类似的。

1. 删除

@Test

public void testDelete() {

    itemRepository.deleteById(1L);

}

1. 查询

1. 基本查询

ElasticsearchRepository提供了一些基本的查询方法：

我们来试试查询所有：

@Test

public void query(){

    // 查询全部，并安装价格降序排序

    Iterable<Item> items = this.itemRepository.findAll(Sort.by("price").descending());

    for (Item item : items) {

out.println("item = "

    }

}

结果：

1. 自定义方法

Spring Data 的另一个强大功能，是根据方法名称自动实现功能。

比如：你的方法名叫做：findByTitle，那么它就知道你是根据title查询，然后自动帮你完成，无需写实现类。

当然，方法名称要符合一定的约定：

例如，我们来按照价格区间查询，定义这样的一个方法：

public interface ItemRepository extends ElasticsearchRepository<Item,Long> {

    /**

     * 根据价格区间查询

     * @param price1

     * @param price2

     * @return

     */

findByPriceBetween(double price1, double

}

然后添加一些测试数据：

@Test

public void indexList() {
    List<Item> list = new ArrayList<>();
add(new Item(1L, "小米手机7", "手机", "小米", 3299.00, "http://image.baidu.com/13123.jpg"));
add(new Item(2L, "坚果手机R1", "手机", "锤子", 3699.00, "http://image.baidu.com/13123.jpg"));
add(new Item(3L, "华为META10", "手机", "华为", 4499.00, "http://image.baidu.com/13123.jpg"));
add(new Item(4L, "小米Mix2S", "手机", "小米", 4299.00, "http://image.baidu.com/13123.jpg"));
add(new Item(5L, "荣耀V10", "手机", "华为", 2799.00, "http://image.baidu.com/13123.jpg"));
    // 接收对象集合，实现批量新增
saveAll(list);
}

不需要写实现类，然后我们直接去运行：

@Test

public void queryByPriceBetween(){
    List<Item> list = this.itemRepository.findByPriceBetween(2000.00, 3500.00);
    for (Item item : list) {
out.println("item = "
    }
}

结果：

1. 自定义查询

先来看最基本的match query：

@Test

public void search(){

    // 构建查询条件

    NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();

    // 添加基本分词查询

withQuery(QueryBuilders.matchQuery("title", "小米手机"));

    // 搜索，获取结果

    Page<Item> items = this.itemRepository.search(queryBuilder.build());

    // 总条数

long total = items.getTotalElements();

out.println("total = "

    for (Item item : items) {

out.println(item);

    }

}

• NativeSearchQueryBuilder：Spring提供的一个查询条件构建器，帮助构建json格式的请求体
• QueryBuilders.matchQuery("title", "小米手机")：利用QueryBuilders来生成一个查询。QueryBuilders提供了大量的静态方法，用于生成各种不同类型的查询：

• Page<item>：默认是分页查询，因此返回的是一个分页的结果对象，包含属性：

• totalElements：总条数
• totalPages：总页数
• Iterator：迭代器，本身实现了Iterator接口，因此可直接迭代得到当前页的数据
• 其它属性：

结果：

1. 练习1：查询标题中含“手机”，且品牌是“小米”的商品列表信息

@Test

public void testQuery2() {

    //1 条件构建器

    NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();

    //2 拼凑条件

    BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();

    boolQueryBuilder.must(QueryBuilders.matchQuery("title","手机"));

    boolQueryBuilder.must(QueryBuilders.matchQuery("brand","小米"));

    queryBuilder.withQuery(boolQueryBuilder);

    //3 查询

    Page<Item> page = this.itemRepository.search(queryBuilder.build());

    //4 处理结果

    System.out.println(page.getTotalElements());

    page.getContent().forEach(System.out::println);

}

1. 练习2：查询标题中含“手机”，且品牌不是“小米”的商品列表信息

1. 分页查询

利用NativeSearchQueryBuilder可以方便的实现分页：

@Test
public void searchByPage(){
    // 构建查询条件
    NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();
    // 添加基本分词查询
withQuery(QueryBuilders.termQuery("category", "手机"));
    // 分页：
int page = 0; //第几页，从0开始
int size = 2; //每页个数
withPageable(PageRequest.of(page,size));
    // 搜索，获取结果
    Page<Item> items = this.itemRepository.search(queryBuilder.build());
    // 总条数
long total = items.getTotalElements();
out.println("总条数 = "
    // 总页数
out.println("总页数 = " + items.getTotalPages());
    // 当前页
out.println("当前页：" + items.getNumber());
    // 每页大小
out.println("每页大小：" + items.getSize());
    for (Item item : items) {
out.println(item);
    }
}

结果：

可以发现，Elasticsearch中的分页是从第0页开始。

1. 排序

排序也通用通过NativeSearchQueryBuilder完成：

@Test
public void searchAndSort(){
    // 构建查询条件
    NativeSearchQueryBuilder queryBuilder = new NativeSearchQueryBuilder();
    // 添加基本分词查询
withQuery(QueryBuilders.termQuery("category", "手机"));
    // 排序
withSort(SortBuilders.fieldSort("price").order(SortOrder.ASC));
    // 搜索，获取结果
    Page<Item> items = this.itemRepository.search(queryBuilder.build());
    // 总条数
long total = items.getTotalElements();
out.println("总条数 = "
    for (Item item : items) {
out.println(item);
    }
}

结果：