【电商项目】商品搜索开发复盘（2）：构造ES搜索条件逻辑实现与思考

目录一、整体思路二、分模块代码实现2.1 关键字条件2.2 品牌条件2.3 价格条件2.4 规格项条件2.5 分页处理2.6 排序处理最后返回代码整体展示本篇小结在1我们了解了大体实现思路这一篇我们实现第一个内容把前端传过来的JSON业务参数转换成ES客户端能够识别执行的查询格式。文章内容均为小编开发过程中思考的记录由于是新手所以很多地方不理解问题也就比较多发出来见笑了。一、整体思路处理流程接收参数 → 重新组装成ES查询语法先创建两个核心对象NativeQueryBuilder大容器存放完整的一次ES查询请求查询条件、分页、排序全部往里装BoolQuery.Builder布尔查询构造器专门拼装一个个小查询条件NativeQueryBuilder nativeQueryBuilder new NativeQueryBuilder(); BoolQuery.Builder builder new BoolQuery.Builder();我们直接看入参实体GoodsSearchParam就知道需要处理哪些条件关键字、品牌、价格、规格、排序、分页。遍历每一项参数按需拼装到布尔查询中。二、分模块代码实现每一个筛选条件统一思路接收参数做非空判断组装为ES可识别的查询对象。2.1 关键字条件逻辑没有关键字查询全部商品有关键字多字段全文检索。String keyword goodsSearchParam.getKeyword(); if(!StringUtils.hasText(keyword)){ MatchAllQuery matchAllQuery new MatchAllQuery.Builder().build(); builder.must(matchAllQuery._toQuery()); }else{ MultiMatchQuery multiMatchQuery MultiMatchQuery.of(q - q .query(keyword) .fields(goodsName, caption, brand)); builder.must(multiMatchQuery._toQuery()); }2.1.1 MatchAllQuery、MultiMatchQuery、_toQuery()是什么MatchAllQuery匹配全部文档用户不输入关键词时返回全部商品MultiMatchQuery多字段全文匹配会对关键词分词检索_toQuery()把具体查询对象转为ES客户端通用的Query类型统一交给布尔查询使用2.1.2 为什么MatchAllQuery需要.Builder().build()BoolQuery只需要.Builder()Builder是建造者只负责拼接参数调用build()才生成最终完整查询对象。BoolQuery.Builder我们后续还会持续追加条件所以暂时不buildMatchAllQuery参数一次性设置完毕直接build拿到对象。2.1.3builder.must(multiMatchQuery._toQuery())must()等价于SQL的AND里面的条件必须全部满足传入经过_toQuery()转换后的查询对象加入布尔查询。2.1.4 MultiMatchQuery为什么不用new实体化可以直接使用新版本ES Java客户端大量使用静态工厂方法of()替代new构造对象属于官方推荐写法。2.2 品牌条件品牌属于精准匹配不分词使用TermQuery。String brand goodsSearchParam.getBrand(); if(StringUtils.hasText(brand)){ TermQuery termQuery TermQuery.of(q - q .field(brand) .value(brand)); builder.must(termQuery._toQuery()); }2.2.1 TermQuery 和 MatchAllQuery 的区别TermQuery精确匹配不分词适合品牌、规格、ID这类确定值MatchAllQuery查询全部文档不做过滤2.2.2 为什么关键字用queryfields品牌用fieldvalue关键字是MultiMatchQuery全文检索关键词需要分词同时搜索多个字段。query是搜索词复数fields指定要检索的多个字段。品牌是TermQuery精准匹配明确知道要查哪一个字段单数field指定字段value填写完整匹配值。小技巧看到复数fields就是多字段全文搜索单数field一般是精准单字段查询。2.3 价格条件价格是数值区间使用RangeQuery做范围过滤。Double highPrice goodsSearchParam.getHighPrice(); Double lowPrice goodsSearchParam.getLowPrice(); if(highPrice ! null highPrice ! 0){ RangeQuery price RangeQuery.of(q - q .field(price) .lte(JsonData.of(highPrice))); builder.must(price._toQuery()); } if(lowPrice ! null lowPrice ! 0){ RangeQuery price RangeQuery.of(q - q .field(price) .gte(JsonData.of(lowPrice))); builder.must(price._toQuery()); }2.3.1 RangeQuery说明是专门用来做数值区间筛选的gte大于等于lte小于等于。2.3.2 为什么要用JsonData.of()包裹数值ES客户端强制要求把Java数值包装为JsonData明确告诉ES这是数字类型避免ES把数字当成字符串对比导致区间查询出错。2.4 规格项条件前端传规格JSON对象解析成Map循环每一组键值拼接ES字段路径生成TermQuery。MapString, String specificationOption goodsSearchParam.getSpecificationOption(); if(specificationOption ! null !specificationOption.isEmpty()){ SetMap.EntryString, String entrySet specificationOption.entrySet(); for (Map.EntryString, String es : entrySet) { String key es.getKey(); String value es.getValue(); TermQuery termQuery TermQuery.of( q - q .field(specification. key .keyword) .value(value)); builder.must(termQuery._toQuery()); } } nativeQueryBuilder.withQuery(builder.build()._toQuery());2.4.1 entrySet把Map拆成一堆键值对方便遍历2.4.2 entrySet已经拿到键值对为什么不能直接丢ES还要循环取key、valueentrySet只是Java集合对象ES不识别Map必须循环逐个构建TermQuery查询条件。2.4.3 Map本身存键值为什么要用entrySet不直接遍历Map的keySet、values是两套独立集合一轮循环拿不到成对key‑valueentrySet把一组keyvalue封装为Entry不用额外调用map.get(key)。2.4.4 entrySet 之后是不是如果没有 entrySet直接拿 key 和 value 会配对错乱是的。只遍历 keySet再遍历 values两个集合分开顺序不能保证一一对应容易键值匹配错误。Entry 把 key 和 value 绑定成一个单元遍历就不会乱。2.4.5 entrySet 是把键值对应然后形成一组组数据的吗不是。entrySet没法同时拿到一组配套的 keyvalue单独遍历 keySet 只拿到一堆键、遍历 values 只拿到一堆值两组集合分开没法保证顺序配对极易错乱。2.4.6 规格过滤为什么接收Map不用别的集合取决于前端传参。前端传{颜色:红,内存:16G}JSON 对象 → Spring 自动解析为 Map如果用ListSpec前端就得传数组格式[{key:颜色,value:红}]。 这里选 Map 是适配前端传参。2.4.7为什么 编写品牌时field直接写字段名brand而规格要拼接specification.key.keyword以及各部分含义是什么ES 文档层级不一样brand是顶层单层字段直接写字段名即可specification是嵌套对象里面规格名颜色 / 内存是动态变化的 key真实查询字段路径是specification.颜色.keyword字段名一部分运行时才确定代码只能字符串拼接完整路径。2.4.8 nativeQueryBuilder 和 builder.must 关系builder负责拼装一堆must条件拼装完成调用build生成完整布尔查询交给nativeQueryBuilder容器保存。逻辑前端规格 JSON → 解析为 Map → entrySet 得到 Entry 集合 → 循环取出成对 key、value → 拼接 ES 嵌套字段路径 → 循环生成 TermQuery 加入布尔查询完成规格过滤。2.5 分页处理PageRequest pageRequest PageRequest.of(goodsSearchParam.getPage() - 1, goodsSearchParam.getSize()); nativeQueryBuilder.withPageable(pageRequest);注意ES分页从0开始前端传的页码是从1开始所以要做减1处理。2.5.1 NativeQueryBuilder到底是什么相当于一个大箱子存放一次ES查询全部组件nativeQueryBuilder.withQuery(...)存放查询条件关键词、品牌、价格等nativeQueryBuilder.withPageable(...)存放分页信息nativeQueryBuilder.withSort(...)存放排序规则2.5.2 withQuery要build()_toQuery()withPageable直接传对象为什么BoolQuery.Builder是临时构造器必须build生成布尔查询对象再转统一Query对象这是查询条件的格式要求。 PageRequest本身就是Spring提供完整分页实体不需要构建转换直接传入即可。2.6 排序处理String sortFiled goodsSearchParam.getSortFiled(); // 排序字段 String sort goodsSearchParam.getSort(); // 排序方式 if (StringUtils.hasText(sortFiled) StringUtils.hasText(sort)){ Sort sortParam null; // 组装好的排序规则 // 新品的正序是id的倒序 if (sortFiled.equals(NEW)){ if (sort.equals(ASC)){ // 升序 sortParam Sort.by(Sort.Direction.DESC, id); // id从小到大 → 旧商品在前 } if (sort.equals(DESC)){ // 降序 sortParam Sort.by(Sort.Direction.ASC, id); // id从大到小 → 新商品在前 } } // 价格的正序是price的正序 if (sortFiled.equals(PRICE)){ if (sort.equals(ASC)){ sortParam Sort.by(Sort.Direction.ASC, price); } if (sort.equals(DESC)){ sortParam Sort.by(Sort.Direction.DESC, price); } } nativeQueryBuilder.withSort(sortParam); }2.6.1 变量说明sortFiled按什么维度排序NEW代表新品PRICE代表价格sort排序方向ASC升序DESC降序sortParamSpring Sort对象组装完成的排序规则Sort.by(Direction.DESC, id)创建排序规则第一个参数方向第二个ES字段名2.6.2 为什么只判断NEW和PRICE业务上商品搜索就两种常用排序按新品、按价格不需要支持任意字段排序。2.6.3 新品排序为什么逻辑是反转的id越大代表商品越新。业务认知选新品我们希望新商品排在最前面。前端传递的ASC/DESC不能直接拿来用需要手动转换映射到id字段。最后返回// 返回组装完毕的ES查询条件对象 return nativeQueryBuilder.build();代码整体展示/* * 构造搜索条件 * param goodsSearchParam 查询条件对象 * return 搜索条件对象 */ public NativeQuery buildQuery(GoodsSearchParam goodsSearchParam) { // 1.创建复杂查询条件对象 NativeQueryBuilder nativeQueryBuilder new NativeQueryBuilder(); BoolQuery.Builder builder new BoolQuery.Builder(); // 2.如果查询条件有关键词关键词可以匹配商品名、副标题、品牌字段否则查询所有商品 String keyword goodsSearchParam.getKeyword(); if(!StringUtils.hasText(keyword)){ MatchAllQuery matchAllQuery new MatchAllQuery.Builder().build(); builder.must(matchAllQuery._toQuery()); }else{ MultiMatchQuery multiMatchQuery MultiMatchQuery.of(q - q .query(keyword) .fields(goodsName, caption, brand)); builder.must(multiMatchQuery._toQuery()); } // 3.如果查询条件有品牌则精准匹配品牌 String brand goodsSearchParam.getBrand(); if(StringUtils.hasText(brand)){ TermQuery termQuery TermQuery.of(q - q .field(brand) .value(brand)); builder.must(termQuery._toQuery()); } // 4.如果查询条件有价格则匹配价格 Double highPrice goodsSearchParam.getHighPrice(); Double lowPrice goodsSearchParam.getLowPrice(); if(highPrice ! null highPrice ! 0){ RangeQuery price RangeQuery.of(q - q .field(price) .lte(JsonData.of(highPrice))); builder.must(price._toQuery()); } if(lowPrice ! null lowPrice ! 0){ RangeQuery price RangeQuery.of(q - q .field(price) .gte(JsonData.of(lowPrice))); builder.must(price._toQuery()); } // 5.如果查询条件有规格项则精准匹配规格项 MapString, String specificationOption goodsSearchParam.getSpecificationOption(); if(specificationOption ! null !specificationOption.isEmpty()){ SetMap.EntryString, String entrySet specificationOption.entrySet(); for (Map.EntryString, String es : entrySet) { String key es.getKey(); String value es.getValue(); TermQuery termQuery TermQuery.of( q - q .field(specification. key .keyword) .value(value)); builder.must(termQuery._toQuery()); } } nativeQueryBuilder.withQuery(builder.build()._toQuery()); // 6.添加分页条件 PageRequest pageRequest PageRequest.of(goodsSearchParam.getPage() - 1, goodsSearchParam.getSize()); nativeQueryBuilder.withPageable(pageRequest); // 7.如果查询条件有排序则添加排序条件 String sortFiled goodsSearchParam.getSortFiled(); // 排序字段 String sort goodsSearchParam.getSort(); // 排序方式 if (StringUtils.hasText(sortFiled) StringUtils.hasText(sort)){ Sort sortParam null; // 组装好的排序规则 // 新品的正序是id的倒序 if (sortFiled.equals(NEW)){ if (sort.equals(ASC)){ // 升序 sortParam Sort.by(Sort.Direction.DESC, id); // id从小到大 → 旧商品在前 } if (sort.equals(DESC)){ // 降序 sortParam Sort.by(Sort.Direction.ASC, id); // id从大到小 → 新商品在前 } } // 价格的正序是price的正序 if (sortFiled.equals(PRICE)){ if (sort.equals(ASC)){ sortParam Sort.by(Sort.Direction.ASC, price); } if (sort.equals(DESC)){ sortParam Sort.by(Sort.Direction.DESC, price); } } nativeQueryBuilder.withSort(sortParam); } // 8.返回查询条件对象 return nativeQueryBuilder.build(); }本篇小结整个过程本质就是翻译前端业务参数 → ES客户端对象。全文检索MultiMatchQuery精准匹配TermQuery数值区间RangeQuery所有小条件交给BoolQuery.Builder拼装全部条件、分页、排序统一装进NativeQueryBuilder容器