脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot整合Elasticsearch

SpringBoot整合Elasticsearch游标查询的示例代码（scroll）

 更新时间：2020年10月16日 16:48:28   作者：李锋镝的园子  
这篇文章主要介绍了SpringBoot整合Elasticsearch游标查询（scroll）,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

游标查询（scroll）简介

scroll 查询 可以用来对 Elasticsearch 有效地执行大批量的文档查询，而又不用付出深度分页那种代价。

游标查询会取某个时间点的快照数据。 查询初始化之后索引上的任何变化会被它忽略。 它通过保存旧的数据文件来实现这个特性，结果就像保留初始化时的索引 视图 一样。

启用游标查询可以通过在查询的时候设置参数 scroll 的值为我们期望的游标查询的过期时间。 游标查询的过期时间会在每次做查询的时候刷新，所以这个时间只需要足够处理当前批的结果就可以了，而不是处理查询结果的所有文档的所需时间。 这个过期时间的参数很重要，因为保持这个游标查询窗口需要消耗资源，所以我们期望如果不再需要维护这种资源就该早点儿释放掉。 设置这个超时能够让 Elasticsearch 在稍后空闲的时候自动释放这部分资源。

GET /old_index/_search?scroll=1m 
{
  "query": { "match_all": {}},
  "sort" : ["_doc"], 
  "size": 1000
}

scroll=1m：保持游标查询窗口一分钟。

返回结果示例：

{
  "_scroll_id": "cXVlcnlUaGVuRmV0Y2g7NTsxMDk5NDpkUmpiR2FjOFNhNnlCM1ZDMWpWYnRROzEwOTk1OmRSamJHYWM4U2E2eUIzVkMxalZidFE7MTA5OTM6ZFJqYkdhYzhTYTZ5QjNWQzFqVmJ0UTsxMTE5MDpBVUtwN2lxc1FLZV8yRGVjWlI2QUVBOzEwOTk2OmRSamJHYWM4U2E2eUIzVkMxalZidFE7MDs=",
  "took": 10,
  "timed_out": false,
  "_shards": {
    "total": 5,
    "successful": 5,
    "failed": 0
  },
  "hits": {
    "total": 2633253,
    "max_score": 1.0,
    "hits": [
      {
        "_index": "old_index",
        "_type": "old_index_type",
        "_id": "1",
        "_score": 1.0,
        "_source": {
          ...
        }
      }
    ]
  }
}

这个查询的返回结果包括一个字段 _scroll_id， 它是一个base64编码的长字符串 。 现在我们能传递字段 _scroll_id 到 _search/scroll 查询接口获取下一批结果：

GET /_search/scroll
{
  "scroll": "1m", 
  "scroll_id" : "cXVlcnlUaGVuRmV0Y2g7NTsxMDk5NDpkUmpiR2FjOFNhNnlCM1ZDMWpWYnRROzEwOTk1OmRSamJHYWM4U2E2eUIzVkMxalZidFE7MTA5OTM6ZFJqYkdhYzhTYTZ5QjNWQzFqVmJ0UTsxMTE5MDpBVUtwN2lxc1FLZV8yRGVjWlI2QUVBOzEwOTk2OmRSamJHYWM4U2E2eUIzVkMxalZidFE7MDs="
}

注意：需要再次设置游标查询过期时间为一分钟。

这个游标查询返回下一批结果。

另外尽管我们指定字段 size 的值为1000，但是我们有可能取到超过这个值数量的文档。 当查询的时候， 字段 size 作用于单个分片，所以每个批次实际返回的文档数量最大为 size * number_of_primary_shards。

注意：游标查询每次返回一个新字段 _scroll_id。每次我们做下一次游标查询， 我们必须把前一次查询返回的字段_scroll_id 传递进去。 当没有更多的结果返回的时候，我们就处理完所有匹配的文档了。

整合

新增以下三个方法：

/**
 * 游标查询
 * @param params 查询入参
 * @param indexName 索引名称
 * @param type 索引类型
 * @param defaultSort 默认排序
 * @param keyMappings 字段映射
 * @param keyMappingsMap 索引对应字段映射
 * @param scrollTimeInMillis 游标开启的时间
 * @return Page
 */
protected Page<Map> commonStartScroll(Map<String, String> params, String indexName, String type, String defaultSort,
                 Map<Key, FieldDefinition> keyMappings,
                 Map<String, Map<Key, FieldDefinition>> keyMappingsMap, long scrollTimeInMillis) {
  SearchQuery searchQuery = buildSearchQuery(params, indexName, type, defaultSort, keyMappings, keyMappingsMap);
  return elasticsearchTemplate.startScroll(scrollTimeInMillis, searchQuery, Map.class);
}

/**
 * 游标查询
 * @param scrollId 游标ID
 * @param scrollTimeInMillis 游标开启的时间
 * @return Page
 */
protected Page<Map> commonContinueScroll(String scrollId, long scrollTimeInMillis) {
  return elasticsearchTemplate.continueScroll(scrollId, scrollTimeInMillis, Map.class);
}

/**
 * 根据游标ID清除游标（提早释放资源，降低ES的负担）
 * @param scrollId 游标ID
 */
protected void clearScroll(String scrollId) {
  elasticsearchTemplate.clearScroll(scrollId);
}

StoreSearchService中增加游标查询方法以及清除游标方法：

/**
 * 游标查询
 * @param params 查询条件
 * @return page
 */
public Page<Map> scroll(Map<String, String> params) {
  IndexConfig config = indexEntity.getConfigByDocCode(DOC_CODE);

  // 如果请求参数包含游标ID，则说明执行翻页操作，否则认为开启新的游标查询
  String scrollId = params.getOrDefault(SCROLL_ID, null);
  if (StringUtils.isNotBlank(scrollId)) {
    return commonContinueScroll(params.get(scrollId), config.getScrollTimeInMillis());
  }
  return commonStartScroll(params, config.getIndexName(), config.getType(), DEFAULT_SORT,
      keyMappings, keyMappingsMap, config.getScrollTimeInMillis());
}
public void clearScroll(String scrollId) {
  super.clearScroll(scrollId);
}

对外暴露接口：

@PostMapping("/scroll")
public ResponseResult scroll(@RequestBody Map<String, String> params) {

  return ResponseResult.success(storeSearchService.scroll(params));
}

@GetMapping("/scroll/clear/{scrollId}")
public ResponseResult clearScroll(@PathVariable String scrollId) {
  storeSearchService.clearScroll(scrollId);
  return ResponseResult.success(null);
}

游标查询分为开启和继续两个步骤，接口/scroll中根据_scrollId判断为开启游标查询还是继续游标查询。

若条件允许的话，尽量将游标查询及时关闭，以释放ES集群的资源，降低负担。

源码

Git项目地址：https://github.com/lifengdi/search

原文链接：https://www.lifengdi.com/archives/article/2119

到此这篇关于SpringBoot整合Elasticsearch游标查询（scroll）的文章就介绍到这了,更多相关SpringBoot整合Elasticsearch内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Guava中这些Map技巧可以让代码量减少了50%

    Guava中这些Map技巧可以让代码量减少了50%

    guava提供了非常强大的操作,可以让我们把java代码写的很简洁,下面这篇文章主要给大家介绍了关于Guava中这些Map使用技巧可以让代码量减少了50%的相关资料,需要的朋友可以参考下
    2022-11-11
  • Java注解(annotation)简述

    Java注解(annotation)简述

    这篇文章主要介绍了使用java的注解(用在java类的方法上的注解)方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-08-08
  • Java设计模式之代理模式与@Async异步注解失效的解决

    Java设计模式之代理模式与@Async异步注解失效的解决

    代理模式是Java常见的设计模式之一。所谓代理模式是指客户端并不直接调用实际的对象，而是通过调用代理，来间接的调用实际的对象
    2022-07-07
  • java获取IP归属地全网显示开源库使用

    java获取IP归属地全网显示开源库使用

    这篇文章主要为大家介绍了java获取IP归属地全网显示的开源库使用示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-07-07
  • java中final修饰符的使用方法

    java中final修饰符的使用方法

    这篇文章主要为大家详细介绍了java中final修饰符的使用方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-07-07
  • Jmeter压力测试简单教程(包括服务器状态监控)

    Jmeter压力测试简单教程(包括服务器状态监控)

    Jmeter是一个非常好用的压力测试工具。Jmeter用来做轻量级的压力测试,非常合适，本文详细的介绍了Jmeter的使用，感性的可以了解一下
    2021-11-11
  • java设置session过期时间的实现方法

    java设置session过期时间的实现方法

    这篇文章主要介绍了java设置session过期时间的实现方法,以实例形式详细讲述了具体实现过程,非常具有参考借鉴价值,需要的朋友可以参考下
    2014-10-10
  • Java Spring Dubbo三种SPI机制的区别

    Java Spring Dubbo三种SPI机制的区别

    这篇文章主要介绍了Java Spring Dubbo三种SPI机制的区别，文章围绕主题展开详细的内容介绍，具有一定的参考价值，感兴趣的小伙伴可以参考一下
    2022-08-08
  • Jackson的用法实例分析

    Jackson的用法实例分析

    这篇文章主要介绍了Jackson的用法实例分析,用于处理Java的json格式数据非常实用,需要的朋友可以参考下
    2014-08-08
  • Java 中的 clone( ) 和 new哪个效率更高

    Java 中的 clone( ) 和 new哪个效率更高

    很多朋友不太清楚clone（）和new那个更快？针对这个问题我百度了好多资料，最终小编总结下关于Java 中的 clone( ) 和 new哪个效率更高的问题，感兴趣的朋友跟随小编一起看看吧
    2021-12-12

最新评论