Spring data ES攻略

总结下es的使用，方便其他小伙伴使用

一、配置依赖

<dependency>
   <groupId>org.springframework.data</groupId>
   <artifactId>spring-data-elasticsearch</artifactId>
   <version>2.0.4.RELEASE</version>
</dependency>

二、xml配置

创建xml文件，配置ES集群的连接，创建bean对象elasticsearchTemplate（spring对ES java api的封装）；

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/data/elasticsearchhttp://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
http://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd">
    <elasticsearch:transport-client id="client"
        cluster-nodes="${elasticsearch_cluster_nodes}" cluster-name="${elasticsearch_cluster_name}" />

    <bean name="elasticsearchTemplate"
        class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
        <constructor-arg ref="client" />
    </bean>
</beans>

这里使用了transport-client 集群的节点cluster-nodes 可以设置为多个或一个，因为默认开启了transport的嗅探功能，只需要指定其中一台机器，初次连接成功后就会获取到集群的列表。

client.transport.sniff = true 则开启嗅探功能

三、使用

直接上代码这是一个最简单常用的分页查询的方式:

• 其中的注释解释了整个查询方式，依照此流程查询

@Override
public Page<CategoryGoodsData> queryHotSellProductDataByPage(PaginationRequest<BaseDataRequestVo> requestVo) {
   CommonUtils.setStoreIdFromEcBizStoreId(requestVo);
   Page<CategoryGoodsData> resultMerchantSummaryData = null;
   try {
      // 1.构建查询条件
      Date date = DateUtils.addDays(new Date(), -1);
      requestVo.getQueryParameter().setStartTime(DateUtil.format(date, Constant.DATE_STATE_TIME_FORMAT));
      requestVo.getQueryParameter().setEndTime(DateUtil.format(new Date(), Constant.DATE_END_TIME_FORMAT));
      Criteria criteria = new Criteria();
      criteria.and((new Criteria(Constant.ES_PARAM_PID).is(requestVo.getPid())))
            .and((new Criteria(Constant.ES_PARAM_STOREID).is(requestVo.getStoreId())))
            .and((new Criteria(Constant.ES_PARAM_CHANNEL_TYPE).is(requestVo.getQueryParameter().getChannelType())))
            .and(new Criteria(Constant.ES_PARAM_ANALYZEDATE).greaterThanEqual(requestVo.getQueryParameter().getStartTime()))
            .and(new Criteria(Constant.ES_PARAM_ANALYZEDATE).lessThan(requestVo.getQueryParameter().getEndTime()));

      // 1.1模糊匹配商品名称
      if (StringUtils.isNotEmpty(requestVo.getQueryParameter().getPageName())) {
         criteria.and(new Criteria(Constant.ES_PARAM_GOODS_NAME).contains(CommonUtils.removeSpecialCharacters(requestVo.getQueryParameter().getPageName())));
      }
      // 1.2排序
      Sort sort = new Sort(Direction.DESC, Constant.ES_PARAM_ANALYZEDATE);
      if (CollectionUtils.isNotEmpty(requestVo.getOrderBy())) {
         OrderField orderFiled = requestVo.getOrderBy().get(0);
         if (StringUtils.isNotBlank(orderFiled.getSort()) && StringUtils.isNotBlank(orderFiled.getField())) {
            sort = new Sort(DataManagementUtils.getDirection(orderFiled.getSort()), orderFiled.getField());
         }
      }
      // 2.构建查询
      CriteriaQuery criteriaQuery = new CriteriaQuery(criteria);
       // 2.1 设置分页条件
      criteriaQuery.setPageable(new PageRequest(requestVo.getPageNum() - Constant.ES_PAGE_SIZE_DECREASE, requestVo.getPageSize(), sort));
        
      // 2.2 设置索引 (此处是业务要求动态生成索引的方法，灵活变通，不做累赘)
      String[] indexList = DataManagementUtils.getDynamicIndexBusi(requestVo.getQueryParameter().getStartTime(), requestVo.getQueryParameter().getEndTime(),suffix);
      criteriaQuery.addIndices(indexList);

       // 2.3 设定type
      criteriaQuery.addTypes(Constant.ES_TYPE_CATEGORY_GOODS_DATA_1);
        
      // 3. ES API分页查询
      resultMerchantSummaryData = elasticsearchTemplate.queryForPage(criteriaQuery, CategoryGoodsData.class);
   } catch (Exception e) {
      LOGGER.error("findTradeDetailDayDataByPage error", e);
      throw new DataManagementBizException(DataManagementErrorCode.QUERY_CATEGORY_GOODS_ERROR);
   }
   return resultMerchantSummaryData;
}

---

• elasticsearchTemplate中封装了各种查询方式如图，望名之意，并且提供了根据你传入的范型class，从ES命中的Hit记录映射转化为出参对象。
• 图中标红的是本人常用的几种查询方式

四、CriteriaQuery与SearchQuery

在elasticsearchTemplate提供的接口中可以看到:其中入参有CriteriaQuery 和SearchQuery 

• 其中CriteriaQuery满足了在使用的过程中满足了基础的大部分查询，如上面的使用例子，各种列表，分页，查询对象，但是无法使用聚合查询
• 这时候就要用到SearchQuery，SearchQuery中提供了更加丰富的查询方式
• 它似乎SearchQuery依赖于elasticsearch的原生QueryBuilders而CriteriaQuery而是特定于Spring Data。（这点来自下方的ps，提问者的见解） 

五、PS

有了以上四点使用spring data es已经没有问题了

PS：

在我们希望在对CriteriaQuery 和SearchQuery 提供的两种查询使用中，了解到这两种该在分别适合什么场景，该在什么情况下使用，奈何资料甚少

stack overflow上的这个疑问已经存在3年，这个提问者的疑惑也是我的疑惑，不过提问者也提供除了自己的见解