ElasticsearchRestTemplate客户端使用

已于 2023-02-23 15:11:52 修改
阅读量3.1k 收藏 16
点赞数 1
分类专栏： Elastic Search 文章标签： elasticsearch
于 2022-10-24 19:16:34 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41787812/article/details/126996435
版权

官方文档

一、基本概念

1、 ElasticsearchTemplate 原生api模板

ElasticsearchTemplate 封装ES客户端的一些原生api模板，方便实现一些查询

elasticsearchTemplate.queryForPage   #是查询一个分页列表，用的就是一个对象实例
    NativeSearchQuery                #是springdata中的查询条件
    NativeSearchQueryBuilder         #用于建造一个NativeSearchQuery查询对象
    QueryBuilders                    #设置查询条件,是ES中的类
    SortBuilders                     #设置排序条件
    HighlightBuilder                 #设置高亮显示

2、SearchRequestBuilder

SearchRequestBuilder常用方法说明

SearchRequestBuilder常用方法说明
　  (1) setIndices(String... indices)：上文中描述过，参数可为一个或多个字符串，表示要进行检索的index；
　　(2) setTypes(String... types)：参数可为一个或多个字符串，表示要进行检索的type，当参数为0个或者不调用此方法时，表示查询所有的type；
　　(3)setSearchType(SearchType searchType)：执行检索的类别，值为org.elasticsearch.action.search.SearchType的元素，SearchType是一个枚举类型的类，
其值如下所示：
　　QUERY_THEN_FETCH:查询是针对所有的块执行的，但返回的是足够的信息，而不是文档内容（Document）。结果会被排序和分级，基于此，只有相关的块的文档对象会被返回。由于被取到的仅仅是这些，故而返回的hit的大小正好等于指定的size。这对于有许多块的index来说是很便利的（返回结果不会有重复的，因为块被分组了）
　　QUERY_AND_FETCH:最原始（也可能是最快的）实现就是简单的在所有相关的shard上执行检索并返回结果。每个shard返回一定尺寸的结果。由于每个shard已经返回了一定尺寸的hit，这种类型实际上是返回多个shard的一定尺寸的结果给调用者。
　　DFS_QUERY_THEN_FETCH：与QUERY_THEN_FETCH相同，预期一个初始的散射相伴用来为更准确的score计算分配了的term频率。
　　DFS_QUERY_AND_FETCH:与QUERY_AND_FETCH相同，预期一个初始的散射相伴用来为更准确的score计算分配了的term频率。
　　SCAN：在执行了没有进行任何排序的检索时执行浏览。此时将会自动的开始滚动结果集。
　　COUNT：只计算结果的数量，也会执行facet。
　　(4) setSearchType(String searchType)，与setSearchType(SearchType searchType)类似，区别在于其值为字符串型的SearchType，值可为dfs_query_then_fetch、dfsQueryThenFetch、dfs_query_and_fetch、dfsQueryAndFetch、query_then_fetch、queryThenFetch、query_and_fetch或queryAndFetch；
　　(5) setScroll(Scroll scroll)、setScroll(TimeValue keepAlive)和setScroll(String keepAlive)，设置滚动，参数为Scroll时，直接用new Scroll(TimeValue)构造一个Scroll，为TimeValue或String时需要将TimeValue和String转化为Scroll；
　　(6) setTimeout(TimeValue timeout)和setTimeout(String timeout)，设置搜索的超时时间；
　　(7) setQuery，设置查询使用的Query；
　　(8) setFilter，设置过滤器；
　　(9) setMinScore，设置Score的最小数量；
　　(10) setFrom，从哪一个Score开始查；
　　(11) setSize，需要查询出多少条结果；

3、QueryBuilders、NativeSearchQuery

springboot中使用QueryBuilders、NativeSearchQuery实现复杂查询

1) QueryBuilders

QueryBuilders是ES中的查询条件构造器
QueryBuilders.boolQuery          #子方法must可多条件联查
QueryBuilders.termQuery          #精确查询指定字段
QueryBuilders.matchQuery         #按分词器进行模糊查询
QueryBuilders.rangeQuery         #按指定字段进行区间范围查询

2) NativeSearchQuery
原生的查询条件类，用来和ES的一些原生查询方法进行搭配，实现一些比较复杂的查询,最终进行构建.build 可作为ElasticsearchTemplate. queryForPage的参数使用

//构建Search对象
        NativeSearchQuery build = new NativeSearchQueryBuilder()
                //条件
                .withQuery(queryBuilder)
                //排序
                .withSort(SortBuilders.fieldSort("id").order(SortOrder.ASC))
                //高亮
                .withHighlightFields(name, ms)
                //分页
                .withPageable(PageRequest.of(pageNum - 1, pageSize))
                //构建
                .build();
 
        AggregatedPage<Goods> aggregatedPage = elasticsearchTemplate.queryForPage(build, Goods.class,new Hig());
 
//queryForPage 参数一: NativeSearchQuery 封装的查询数据对象
               参数二: es对应索引实体类
               参数三: 调用高亮工具类
          
 大于等于      .from    .gte   
 小于等于      .to      .lte

4、 @Document 和 @Field 注解详解

首先在用法上的区别，@Document 一般用在类上，引起其他类。而 @Field 注解一般用在参数上，比如定义一个es操作的VO：

1、创建 ArticleEsDto

import java.io.Serializable;
import java.util.Date;
import lombok.Data;
import lombok.ToString;
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.FieldType;

/**
 * @author nandao 2021/7/27
 */
@Data
@Document(indexName = "#{esAttribute.indexArticleType}", type = "#{esAttribute.indexArticleType}")
@ToString
public class ArticleEsDto implements Serializable {

    private static final long serialVersionUID = 7118858963867439527L;

    /**
     * es id
     */
    @Id
    private String id;

    /**
     * 原始ID
     */
    @Field(type = FieldType.Long)
    private Long jid;
    /**
     * 文章ID
     */
    @Field(type = FieldType.Long)
    private Long articleId;
    /**
     * 文章标题
     */
    @Field(type = FieldType.Text)
    private String title;

    /**
     * 内容
     */
    @ToString.Exclude
    @Field(type = FieldType.Text)
    private String content;
    /**
     * 摘要
     */
    @ToString.Exclude
    @Field(type = FieldType.Text)
    private String summary;

    /**
     * 列表图
     */
    @Field(type = FieldType.Text)
    private String listPicturePath;

    /**
     * 文章来源
     */
    @Field(type = FieldType.Text)
    private String source;

    /**
     * 发布时间
     */
    @Field(type = FieldType.Long)
    private Date publishTime;


}

2、分析：@Document注解：

@Document(indexName = "#{esAttribute.indexArticleType}", type = "#{esAttribute.indexArticleType}")

2.1、点开@Document 进入：

@Persistent
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface Document {

	String indexName();//索引库的名称，个人建议以项目的名称命名

	String type() default "";//类型，个人建议以实体的名称命名

	boolean useServerConfiguration() default false;

	short shards() default 5;//默认分区数

	short replicas() default 1;//每个分区默认的备份数

	String refreshInterval() default "1s";//刷新间隔

	String indexStoreType() default "fs";//索引文件存储类型

	boolean createIndex() default true;//创建新数据接口

	VersionType versionType() default VersionType.EXTERNAL;//版本类型参数
}

2.2、esAttribute.indexArticleType 指一个类中的参数：

import lombok.Data;
import lombok.ToString;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

/**
 * @author nandao
 * @version 1.0
 * @description 初始化索引配置
 * @date 2021/07/27 
 **/
@Component
@Data
@ToString
public class EsAttribute {

   
  /**
   * 文章索引名字
   */
  @Value("${spring.data.index.articleType}")//对应配置文件中的articleType
  private String indexArticleType;
}

3、@Field注解分析，点击进入：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Inherited
public @interface Field {

	FieldType type() default FieldType.Auto; //自动检测属性的类型，可以根据实际情况自己设置
 
    FieldIndex index() default FieldIndex.analyzed; //默认情况下分词，一般默认分词就好，除非这个字段你确定查询时不会用到
 
    DateFormat format() default DateFormat.none; //时间类型的格式化
 
    String pattern() default ""; 
 
    boolean store() default false; //默认情况下不存储原文

	boolean fielddata() default false;

	String searchAnalyzer() default "";//指定字段搜索时使用的分词器

	String analyzer() default "";

	String normalizer() default "";

	String[] ignoreFields() default {};//如果某个字段需要被忽略

	boolean includeInParent() default false;

	String[] copyTo() default {};
}

3.1、FieldType类型有多种：

@Field(type = FieldType.Text)
@Field(type = FieldType.Long)

点击进入该枚举类：

public enum FieldType {
	Text,
	Integer,
	Long,
	Date,
	Float,
	Double,
	Boolean,
	Object,
	Auto,
	Nested,
	Ip,
	Attachment,
	Keyword
}

Text类型：索引全文字段，如电子邮件正文的描述或者产品描述。这些字段被分析器将字符串转换为单个术语列表。分析过程允许es在每个的全文域中搜索单个单词。文本字段不用于排序，也很少用于聚合。

Object类型：Json文档本质上是分层的，文档可能包含内部对象，而这些对象又可能包含内部对象本身。

Nested类型：嵌套类型是对象数据类型的一个专门的版本，他允许对象数组以一种彼此独立查询的方式进行索引。

Ip类型：ip字段可以索引和存储IPV4和IPv6地址。

Keyword类型：用于索引结构化内容（如电子邮件地址，主机名，状态码，邮政编码等）的字段。他们通常用于过滤、排序、聚合。关键字字段只能根据期确切的值进行搜索。

二、整合springboot

1、导入依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <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>
        <!--elasticsearch -->
<!--        <dependency>-->
<!--            <groupId>org.elasticsearch</groupId>-->
<!--            <artifactId>elasticsearch</artifactId>-->
<!--        </dependency>-->
<!--        &lt;!&ndash; https://mvnrepository.com/artifact/org.elasticsearch.client/transport &ndash;&gt;-->
<!--        <dependency>-->
<!--            <groupId>org.elasticsearch.client</groupId>-->
<!--            <artifactId>transport</artifactId>-->
<!--        </dependency>-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
    </dependencies>

2、properties文件

server.port=8080
spring.application.name=psas-server
server.tomcat.uri-encoding=UTF-8

# es
spring.data.elasticsearch.repositories.enabled=true
spring.elasticsearch.rest.uris=192.168.60.181:9200
#spring.elasticsearch.rest.username=elastic
#spring.elasticsearch.rest.password=nE7jA%5m

# ???
#elasticsearch.cluster.name=${ELASTICSEARCH_NAME:tmxmall_cluster}
#elasticsearch.master.address=${ELASTICSEARCH_HOST:elasticsearch}
#elasticsearch.cluster.tcp-port=${ELASTICSEARCH_PORT:9300}

三、基本操作

1、判断索引是否存在

elasticsearchRestTemplate.indexExists(indexName);

2、ElasticsearchRestTemplate Java聚合查询+操作索引+查询时10000条上限

参考笔记

四、批量操作

1、批量保存

2、全量查询

五、聚合查询

1、按时间聚合统计

ElasticSearch按时间聚合统计

六、ES-分片路由（routing）

七、使用ElasticsearchRepository完成数据的操作

视频教程和笔记

相关笔记

坚持学习永不言弃
关注
  • 1
    点赞
  • 踩
  • 16
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring-data-elasticsearch中文使用文档
09-29
spring-data-elasticsearch中文使用文档，spring-data-elasticsearch、elasticsearch、ES、ElasticSearch、ES中文教程
ElasticsearchRestTemplate 基本使用
zh1685188342的博客
04-06 3454
ElasticsearchRestTemplate 如何实现排序、模糊查询、条件查询、区间查询、距离排序、多条件查询等功能。
ElasticSearch 实战：如何使用ES的索引模板(index template)
最新发布
qq_33240556的博客
03-28 345
在Elasticsearch中，索引模板用于定义一组索引的配置，当新的索引被创建时，如果索引名称符合模板定义的模式（index pattern），那么该模板中的设置将自动应用于新创建的索引。索引模板可以预先定义索引的分片数量、副本数量、映射（mapping）和设置（settings）等信息。
SpringBoot之ElasticsearchRestTemplate常用示例.rar
12-31
SpringBoot之ElasticsearchRestTemplate常用示例
ElasticsearchRestTemplate 和ElasticsearchRepository 的使用
深圳市多克创新科技有限公司
10-16 5824
ElasticsearchRestTemplate 和ElasticSearchClient 的使用
springboot整合elasticsearch
hwp_ing的博客
08-14 875
相关文章ElasticsearchTemplate现在已弃用，建议使用ElasticSearchRestTemplateElasticSearchRestTemplate建立在RestHighLevelClient 之上。您可以将其视为 RestHighLevelClient 上的 Spring 包装器TIPS：spring-data-elasticsearch的底层其实也是否则了elasticsearch-rest-high-level-client的api。......
SpringBoot之ElasticsearchRestTemplate常用示例
weixin 19953181360
12-31 1万+
目录1.引入pom依赖2.application 配置3.JavaBean配置以及ES相关注解3.1 Student实体类3.2 Teacher实体类3.3 Headmaster 实体类 1.引入pom依赖 主要引用 elasticsearch使用相关依赖 注意ES 服务端版本(7.4.0)要与客户端版本相容 注意 hutool的工具类 实体转map 版本 <!--引入springboot父工程依赖--> <!--引入依赖作用： 可以省去version标签
ElasticsearchTemplate的详细使用，完成多条件查询、匹配度查询等
qq_16436555的博客
07-02 2万+
ElasticsearchTemplate是Spring对ES的java api进行的封装，提供了大量的相关的类来完成各种各样的查询。在日常的使用中，应该说最常用的查询就是queryList方法。 public <T> List<T> queryForList(SearchQuery query, Class<T> clazz) { return...
Elasticsearch之Template详解
weixin_44692700的博客
12-26 8172
Elasticsearch之Template详解一、Index Template示例1示例2示例3二、Dynamic Template示例1 在ES中我们可以通过设置Index Template和Dynamic Template来更好的为我们管理和设置索引和mapping。 一、Index Template 比如一个我们需要使用ES来做日志管理，我们都知道日志的数据量是十分庞大的，如果使用单个索引来保存所有日志数据的话，可能会存在一些性能问题。我们可以通过按天或月来自动生成index，这时候我们就可以用到I
Elasticsearch学习之SearchRequestBuilder常用方法说明
weixin_30252709的博客
05-12 1834
SearchRequestBuilder常用方法说明 　 (1) setIndices(String... indices)：上文中描述过，参数可为一个或多个字符串，表示要进行检索的index；　　(2) setTypes(String... types)：参数可为一个或多个字符串，表示要进行检索的type，当参数为0个或者不调用此方法时，表示查询所有的type；　　setSearchType...
elasticsearch-tutorial:使用测试用例的ElasticSearch Java API教程
05-05
弹性搜索教程使用测试用例的ElasticSearch Java API教程。 本教程以使用junit测试用例针对不同功能的示例为例，说明了 Java api的用法。第1部分介绍ElasticSearch集群设置以及ES入门。 索引，文档类型，节点，分片/...
spring-data-elasticsearch:使用Elasticsearch时，提供支持以提高Java开发人员的工作效率。 使用熟悉的Spring概念，例如用于核心API使用和轻量级存储库样式数据访问的模板类
05-11
Spring配置支持使用基于Java的@Configuration类或ES客户端实例的XML名称空间。 ElasticsearchRestTemplate帮助程序类，可提高执行常规ES操作的效率。 包括文档和POJO之间的集成对象映射。 与Spring的转换服务集成...
基于HanLP自然语言处理包的elasticsearch分词器 hanlp-tokenizer-master
04-22
本分词器使用HanLP提供的维特比分词 屏蔽了本地配置用户词典 增加同义词索引功能 增加远程词典热更新（用户词典，停词典，同义词典） 使用 目前支持的es版本为2.3.5和5.6.3，其他版本请修改plugin-descriptor....
ElasticSearch系列(四)--springboot使用ElasticsearchRestTemplate整合ElasticSearch,实现文本高亮检索
热门推荐
zisuu的博客
05-13 2万+
前言 ElasticsearchRestTemplate是spring-data-elasticsearch项目中的一个类，和其他spring项目中的template类似。 网上的学习资料大都是基于ElasticsearchTemplate,但是ElasticsearchTemplate在未来的版本会被废除 预备知识 - 建立索引 因为是基于springboot,那就不再使用kibana进行建立索引,而是用springboot来创建.创建索引的api: ElasticsearchRestTemplate
Spring Data Elasticsearch--ElasticsearchRestTemplate--使用/教程/实例
IT利刃出鞘的博客
10-14 1万+
本文用实例来介绍如何使用Spring Data Elasticsearch的ElasticsearchRestTemplate来操作ES。包括：索引的增删等、文档的增删改查、文档的动态查询（或者说：多条件查询、复杂查询）。 动态查询的含义：查询条件有多个时，某个查询条件可能有也可能没有，这时就需要手动判断，如果为空则不拼装搜索条件。 本文用博客的业务进行示例。索引名：blog，里边有标题、内容、作者、创建时间等。
ElasticsearchRestTemplate 用法
orange_bug的博客
06-03 1万+
pom.xml配置 <?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 https://maven.apache.org/xsd/m
Elasticsearch 7.X SpringBoot 使用 ElasticsearchRestTemplate 操作 ES
小毕超博客
01-03 1万+
一、ElasticsearchRestTemplate 前面学习了es rest接口对es进行操作的方式，并且还学习了es的分片及扩容，有讲解了几种常见的分词器，喜欢的小伙伴可以看下本专栏的其他文章，本篇主要将 在 SpringBoot 中使用ElasticsearchRestTemplate 对ES进行操作。 对于SpringBoot对ES的操作早在以前我就写过一篇文章，但那时基于ES 6.X 的，在新版本的ES中都已经不建议使用了。 注意: 在网上还有些教程是使用TransportClient进行操作的
ElasticsearchRestTemplate 使用
04-08
ElasticsearchRestTemplate 是 Spring Data Elasticsearch 提供的一个类，它是 Elasticsearch 的 Java 客户端之一，可以方便地在 Spring 应用程序中使用 Elasticsearch 进行搜索和存储操作。如果您对 ElasticsearchRestTemplate 感兴趣，可以进一步了解它的使用和实现。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值