Spring Boot操作 Elasticsearch

Spring Data简介

原生状态下,我们使用JDBC连接数据库,因为代码过于繁琐,所以改为使用Mybatis框架

在ES的原生状态下,我们java代码需要使用socket访问ES,但是也是过于繁琐,我们可以使用SpringData框架简化

Spring Data是Spring提供的一套连接各种第三方数据源的框架集

我们需要使用的是其中连接ES的Spring Data Elasticseatrch

官方网站:Spring Data

 

官网中列出了它可以操作的数据源列表

每个列表中都包含一些使用的介绍

要想实现Spring Boot操作ES添加依赖后,按照要求编写代码即可

 

添加依赖

在上面章节中,我们创建的search模块中添加以下依赖

 
      <!-- Spring Data Elasticsearch依赖 -->
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
      </dependency>

application.properties添加配置

# 设置连接ES的ip地址和端口号
spring.elasticsearch.rest.uris=http://localhost:9200
 
# 为了观察运行状态信息,将日志输出门槛设置为debug
logging.level.xx.xx.search=debug
logging.level.org.elasticsearch.client.RestClient=debug

演示

创建一个操作ES的数据类

和数据库一样

操作ES时也需要一个类似实体类的数据类,作为操作ES的数据载体

search项目创建entity包

在包中创建Item(商品)类

@Data
@Accessors(chain = true)    // 生成和链式赋值的set方法
@AllArgsConstructor         // 自动生成包含全部参数的构造方法
@NoArgsConstructor          // 自动生成无参构造方法
// SpringData要求我们在"实体类"中使用特定注解标记
// @Document注解标记当前类和ES关联
// indexName指定索引名称,我们这里叫items,当操作这个索引时,如果索引不存在,会自动创建
@Document(indexName = "items")
public class Item  implements Serializable {
 
    // SpingData标记这个字段为当前类主键
    @Id
    private Long id;
    // SpringData使用@Field标记文档中属性的类型和各种特征
    @Field(type = FieldType.Text,
            analyzer = "ik_max_word",
            searchAnalyzer = "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;     //价格
    // 图片地址不会称为搜索条件,所以设置index=false
    // 效果是imgPath字段不会生成索引库,节省空间
    @Field(type = FieldType.Keyword,index = false)
    private String imgPath;   //图片地址
 
    // images/hjdsf-ahsa-qwezx-jashjdas.png
    // Text和Keyword都是字符串类型,只是Text会分词,而Keyword不会!
}

创建操作ES的持久层

我们使用SpringData连接操作ES

需要使用SpringData框架对持久层的命名规则

创建repository包,在包中创建接口ItemRepository

代码如下

// Spring 家族下持久层名称都叫repository
@Repository
public interface ItemRepository extends ElasticsearchRepository<Item,Long> {
    // 当前接口继承ElasticsearchRepository父接口后
    // 会自动在类中生成基本的增删改查方法,直接可以使用
    // 它自动识别或自动生成的规则,是我们定义的两个泛型ElasticsearchRepository<[实体类名],[主键类型]>
 
}

测试操作ES

打开test测试类进行测试

@SpringBootTest
class SearchApplicationTests {
 
   // 注入SpringData操作Es的持久层对象
   @Autowired
   private ItemRepository itemRepository;
 
   // 单增
   @Test
   void addOne() {
      // 实例化Item对象,赋值并新增到ES
      Item item=new Item()
            .setId(1L)
            .setTitle("罗技激光无线游戏鼠标")
            .setCategory("鼠标")
            .setBrand("罗技")
            .setPrice(128.0)
            .setImgPath("/1.jpg");
      // 利用自动生成的方法将item新增到ES,索引不存在会自动创建
      itemRepository.save(item);
      System.out.println("ok");
   }
 
   // 按id查询
   @Test
   void getOne(){
      // SpringData框架自带的按id查询的方法
      // Optional是一个类似包装类的概念,查询的结果封装到了这个类型中
      Optional<Item> optional=itemRepository.findById(1L);
      // 需要使用查询内容时使用optional.get()即可
      System.out.println(optional.get());
   }
 
   // 批量增
   @Test
   void addList(){
      // 实例化一个List集合
      List<Item> list=new ArrayList<>();
      // 将要新增的Item对象保存到这个List中
      list.add(new Item(2L,"罗技激光有线办公鼠标","鼠标",
            "罗技",89.0,"/2.jpg"));
      list.add(new Item(3L,"雷蛇机械无线游戏键盘","键盘",
            "雷蛇",299.0,"/3.jpg"));
      list.add(new Item(4L,"微软有线静音办公鼠标","鼠标",
            "微软",208.0,"/4.jpg"));
      list.add(new Item(5L,"罗技有线机械背光键盘","键盘",
            "罗技",266.0,"/5.jpg"));
      // 下面使用SpringData提供的方法执行批量新增
      itemRepository.saveAll(list);
      System.out.println("ok");
 
   }
 
   // 全查
   @Test
   void getAll(){
      // 利用SpringData的方法从ES中查询所有数据
      Iterable<Item> items=itemRepository.findAll();
//    for(Item item: items){
//       System.out.println(item);
//    }
      items.forEach(item -> System.out.println(item));
 
   }
 
 
}

SpringData自定义查询

SpringData框架提供基本增删改查方法

但是如果有具体的针对性的查询逻辑,一定还是需要我们自己编写代码

例如实现类似数据库中的模糊查询

单条件查询

我们的查询需求是查询title属性中包含"游戏"这个分词的商品信息

参考模糊查询代码

select * from item where title like '%游戏%'

我们使用ES查询,本质上运行的就是我们在es.http文档中编写的查询语句

但是SpringData框架下,编写查询语句更加简单

我们在ItemRepository接口中添加如下代码

// SpringData自定义查询
// 遵循SpringData框架规定的格式的前提下,编写方法名会自动生成查询逻辑
// query: 表示当前方法是一个查询功能,类似sql中的select
// Item\Items: 表示查询结果的实体类,带s的返回集合
// By:标识开始设置条件,类似sql的where
// Title: 要查询的字段名称
// Matches: 是要执行的查询操作,这里是分词查询,类似sql的like
Iterable<Item> queryItemsByTitleMatches(String title);

再测试类中进行测试

//单条件自定义查询
@Test
void queryOne(){
   // 查询 ES中title字段包含"游戏"分词的数据
   Iterable<Item> items=itemRepository.queryItemsByTitleMatches("游戏");
   items.forEach(item -> System.out.println(item));
}

上面代码运行时底层运行的查询语句为:

### 单条件搜索
POST http://localhost:9200/items/_search
Content-Type: application/json
 
{
  "query": {"match": { "title":  "游戏" }}
}

多条件查询

在相对复杂的查询逻辑下

经常使用多个条件来定位查询需要的数据

这样就需要逻辑运算符"and"/"or"

ItemRepository接口中添加多条件的查询方法

// 多条件查询
// 两个或多个条件之间直接编写And或Or表示查询逻辑
// 参数名称实际上没有要求必须和字段名称匹配,底层代码是按照参数顺序赋值的
Iterable<Item> queryItemsByTitleMatchesAndBrandMatches(String title,String brand);

上面的查询添加了品牌作为条件

逻辑关系是and(与)

测试代码如下

// 多条件自定义查询
@Test
void queryTwo(){
   Iterable<Item> items=itemRepository
         .queryItemsByTitleMatchesAndBrandMatches("游戏","雷蛇");
   items.forEach(item -> System.out.println(item));
}

底层运行的请求

### 多字段搜索
POST http://localhost:9200/items/_search
Content-Type: application/json
 
{
  "query": {
    "bool": {
      "must": [
        { "match": { "title": "游戏"}},
        { "match": { "brand": "雷蛇"}}
      ]
    }
  }
}

当查询条件关系为And时,查询语句关键字为must

当查询条件关系为Or时,查询语句关键字为should

 

自定义查询

排序查询

如果实施排序需求,就在Repository接口中添加方法如下

// 排序查询
// 默认情况下,ES查询结果按score排序,如果想按其他的规则排序可以加OrderBy
// 和数据库一样,默认升序排序 Desc会降序
Iterable<Item> queryItemsByTitleMatchesOrBrandMatchesOrderByPriceDesc(
                                String title, String brand);

测试代码如下

// 排序查询
@Test
void queryOrder(){
   Iterable<Item> items=itemRepository
      .queryItemsByTitleMatchesOrBrandMatchesOrderByPriceDesc("游戏","罗技");
   items.forEach(item -> System.out.println(item));
}

底层代码逻辑

### 多字段搜索
POST http://localhost:9200/items/_search
Content-Type: application/json
 
{
  "query": {
    "bool": {
      "should": [
        { "match": { "title": "游戏"}},
        { "match": { "brand": "罗技"}}
      ]
    }
  },"sort":[{"price":"desc"}]
}

分页查询

SpringData框架支持分页查询

只需要修改参数和返回值就能实现自动分页的效果

修改ItemRepository接口代码如下

// 分页查询
// 当查询数据较多时,我们可以利用SpringData的分页功能,按用户要求的页码查询需要的数据
// 返回值修改为Page类型,这个类型对象除了包含Iterable能够包含的集合信息之外,还包含分页信息
Page<Item> queryItemsByTitleMatchesOrBrandMatchesOrderByPriceDesc(
        String title, String brand, Pageable pageable);

测试代码如下

// 分页查询
@Test
void queryPage(){
   int pageNum=1;  //页码
   int pageSize=2; //每页条数
   Page<Item> page= itemRepository
      .queryItemsByTitleMatchesOrBrandMatchesOrderByPriceDesc(
            "游戏","罗技", PageRequest.of(pageNum-1,pageSize));
   page.forEach(item -> System.out.println(item));
   // page对象中还包含了一些基本的分页信息
   System.out.println("总页数:"+page.getTotalPages());
   System.out.println("当前页:"+page.getNumber());
   System.out.println("每页条数:"+page.getSize());
   System.out.println("当前页是不是首页:"+page.isFirst());
   System.out.println("当前页是不是末页:"+page.isLast());
}