自己挖坑自己填 spring-data-elasticsearch 4.0.0.M4 简单实践

最新推荐文章于 2024-05-21 16:23:30 发布

lixiang19971019

最新推荐文章于 2024-05-21 16:23:30 发布

阅读量5.8k

点赞数 22

分类专栏： elastic search 文章标签： elasticsearch java spring boot nosql

本文链接：https://blog.csdn.net/lixiang19971019/article/details/105009148

版权

前几天安装了elasticsearch7.6.1,今天准备实践下spring-data-elasticsearch文章目录搭建环境编写yml配置创建实体类基于Spring Data的CRUD直接从方法名称派生查询自定义的查询ElasticsearchRestTemplate的使用indexOperations 索引库相关操作有关Query的构造器QueryBuilders构造复杂查询条件Docu...

摘要由CSDN通过智能技术生成

前几天安装了elasticsearch7.6.1,今天准备实践下spring-data-elasticsearch,没想到4.0改动大资料少,全靠官方文档撑着

文章目录

搭建环境

进入spring官网,了解一下spring-data-elasticsearch版本
在这里插入图片描述
从上面可以看到,目前版本为3.2.5,但是点进去看后发现,这个版本并不适用于elasticsearch7.6.1,而适用于6.8.6.

而我们真正需要使用的是spring-data-elasticsearch4.0以上与spring boot2.3以上
所以在maven中的pom要导入如下依赖

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.0.M3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    
    <dependencies>
        <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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

编写yml配置

在这里插入图片描述 配置es

#配置es
spring:
  elasticsearch:
    rest:
      uris: 192.168.231.128:9200 #配置节点地址数组
  application:
    name: search-service

上面给出的节点地址配置和旧版本的配置可能有所不同,我用网上的如下配置方式,无法成功启动spring-data-elasticsearch
在这里插入图片描述
下面为部分可以进行的配置选项

创建实体类

@Data
@NoArgsConstructor
@AllArgsConstructor
@Document(indexName = "goods",shards = 1,replicas = 0)
public class Item implements Serializable {
   
    @Id
    Long id;
    @Field(type = FieldType.Text,analyzer = "ik_max_word")
    String title;
    @Field(type = FieldType.Keyword)
    String category;
    @Field(type = FieldType.Keyword)
    String brand;
    @Field(type = FieldType.Double)
    Double price;
    @Field(type = FieldType.Keyword,index = false)//不会对图片地址查询,指定为false
    String images;
}

可以注意到有关实体类的注释:

为需要使用索引库的实体类加上注解 @Document 部分属性如下
- indexName="索引库名"
- shards = 分片数量(默认1)
- replicas = 副本数量(默认1)
为id属性添加 @Id 注释
各个字段加上注解并制定类型 @Field 部分属性如下
- type= FieldType.枚举 指定字段类型 Keyword不分词, Text分词下面为可选类型,对应着elasticsearch的字段类型
- 为需要分词的字段添加分词器 analyzer="分词器名" (ik分词器固定写法 ik_max_word )
- 是否创建索引 index=boolean(默认true) 例如样例中的图片地址不需要创建索引

基于Spring Data的CRUD

自定义接口继承ElasticsearchRepository<类名,id类型>

public interface ItemRepository extends ElasticsearchRepository<Item,Long> {
   
}

下面通过文档可以发现两种建立查询的方式:
在这里插入图片描述

直接从方法名称派生查询

ElasticsearchRepository的父类已经写好了部分原生查询,这里有部分已被弃用的查询方法(例如:search)就不演示了
编写测试类
注意: 测试之前要保证你的es中已经存在相应的索引库

@SpringBootTest
class EsDemoApplicationTests {
    //注入jpa查询
    @Autowired
    private ItemRepository itemRepository;
    
    @Test
    public void testSaveAll2() {
        List<Item> list = new ArrayList<>();
        list.add(new Item(1L,"OPPOFindX2","手机","OPPO",4999d,"http://image.leyou.com/13123.jpg"));
        list.add(new Item(2L,"OPPOFindX","手机","OPPO",3999d,"http://image.leyou.com/13123.jpg"));
        list.add(new Item(3L,"OPPORENO","手机","OPPO",2999d,"http://image.leyou.com/13123.jpg"));
        list.add(new Item(4L, "小米手机7", "手机", "小米", 3299.00, "http://image.leyou.com/13123.jpg"));
        list.add(new Item(5L, "坚果手机R1", "手机", "锤子", 3699.00, "http://image.leyou.com/13123.jpg"));
        list.add(new Item(6L, "华为META10", "手机", "华为", 4499.00, "http://image.leyou.com/13123.jpg"));
        list.add(new Item(7L, "小米Mix2S", "手机", "小米", 4299.00, "http://image.leyou.com/13123.jpg"));
        list.add(new Item(8L, "荣耀V10", "手机", "华为", 2799.00, "http://image.leyou.com/13123.jpg"));
        itemRepository.saveAll(list);
        Iterable<Item> all = itemRepository.findAll();
        all.forEach(System.out::println);
    }
}

saveAll():通过传入对象列表的方式保存多个文档
findAll():查询索引库中所有文档

还有部分find,delete相关方法就不演示了

可以发现单单ElasticsearchRepository的方法是非常少的,无法满足我们的需求
但spring data会根据方法名称自动实现功能。
比如：你的方法名叫做：findByTitle，那么它就知道你是根据title查询，然后自动帮你完成，无需写实现类。
例如: 向接口中自定义两个方法

public interface ItemRepository extends ElasticsearchRepository<Item,Long> {
   

    /**
     * 不需要实现
     */
    List<Item> findByTitle(String title);

    /**
     * 范围查item
     * @param left
     * @param right
     * @return
     */
    List<Item> findByPriceBetween(Double left,Double right);
}

其中提供了大量的自定义模板供我们使用
在这里插入图片描述
方法的返回值也可以为stream流对象

返回stream,有利于我们对返回数据进一步的操作
返回类型也可以是其他集合类型

自定义的查询

例:

	/**
     * match查询并设置operator
     * @param title
     * @param operator
     * @return
     */
    @Query("{\"match\": {\"title\":{ \"query\": \"?0\",\"operator\":\"?1\"}}}")
    Item findByTitleOperator(String title,String operator);

自定义查询: 在@Query中写出你的查询json,占位符?0与?1是方法的参数
调用方式与上一种一样,但是可以发现手写json还是非常麻烦的

ElasticsearchRestTemplate的使用

在这里插入图片描述 我们可以发现ElasticsearchRestTemplate使用高级REST客户端,继承了增删改查接口,其中还有创建HTTP请求的工厂对象

indexOperations 索引库相关操作

下面使用ElasticsearchRestTemplate对象indexOps方法,创建indexOperations的实现类对象并创建索引库

注入ElasticsearchRestTemplate
设置索引信息indexOps()传入类的字节码文件,返回IndexOperations接口的实现DefaultIndexOperations,这个类实现了索引的CRUD与http请求
create() 创建索引库
indexOperations.createMapping() 创建映射
indexOperations.putMapping(mapping); 将创建的映射写入索引库

@SpringBootTest
class EsDemoApplicationTests {
   
    @Autowired
    private ElasticsearchRestTemplate elasticsearchRestTemplate
    /**
     * 创建索引库
     */
    @Test
    void textIndex() {
   
        //设置索引信息(绑定实体类)  返回IndexOperations
        IndexOperations indexOperations = elasticsearchRestTemplate.indexOps(Item.class);
        //创建索引库
        indexOperations.create();
        //Creates the index mapping for the entity this IndexOperations is bound to.
        //为该IndexOperations绑定到的实体创建索引映射。  有一个为给定类创建索引的重载,需要类的字节码文件
        Document mapping = indexOperations.createMapping();
        //writes a mapping to the index  将刚刚通过类创建的映射写入索引
        indexOperations.putMapping(mapping);
    }
}

通过indexOperations还能判断索引库是否存在,删除索引库等等

有关Query的构造器

经过查看结构发现Query接口有一个抽象实现和三个实现
在这里插入图片描述
那我们在使用时真的要new NativeSearchQuery()吗?

可以通过new NativeSearchQueryBuilder()来构建NativeSearchQuery对象
NativeSearchQuery中有众多的方法来为我们实现复杂的查询与筛选等操作
其中的build()返回NativeSearchQuery,所以,在众多的筛选条件之后别忘了加上build()
在这里插入图片描述
例如查询withQuery,过滤withFilter,排序withSort等等符合es语法的操作

QueryBuilders构造复杂查询条件

在这里插入图片描述
我们需要在这里传入一个QueryBuilder,可以用QueryBuilders构造QueryBuilder对象
下面的查询实现,对应了es的各种查询

例

NativeSearchQueryBuilder nativeSearchQueryBuilder = new NativeSearchQueryBuilder();
MatchQueryBuilder matchQueryBuilder = QueryBuilders.matchQuery("title", "OPPOFindX");
NativeSearchQuery query = nativeSearchQueryBuilder.withQuery(matchQueryBuilder).build();

DocumentOperations文档相关操作

delete()删除文档
在这里插入图片描述

其中IndexCoordinates为封装索引库名称的不可变值对象, 用IndexCoordinates.of("索引库名")来构造该对象
前4个重载返回的是影响条数String型,注意传入的id也是String

@Test
void testDelete1(){
   
	String count = elasticsearchRestTemplate.delete(1 + "", IndexCoordinates.of("goods"));
	Sys

最低0.47元/天解锁文章

lixiang19971019

关注

22
点赞
踩
30

收藏

觉得还不错? 一键收藏
15
评论
自己挖坑自己填 spring-data-elasticsearch 4.0.0.M4 简单实践

前几天安装了elasticsearch7.6.1,今天准备实践下spring-data-elasticsearch文章目录搭建环境编写yml配置创建实体类基于Spring Data的CRUD直接从方法名称派生查询自定义的查询ElasticsearchRestTemplate的使用indexOperations 索引库相关操作有关Query的构造器QueryBuilders构造复杂查询条件Docu...
复制链接

扫一扫