MyBatisPlus同款ElasticsearchORM框

　　使用过SpringData操作ES的小伙伴应该有所了解，它只能实现一些非常基本的数据管理工作，一旦遇到稍微复杂点的查询，基本都要依赖ES官方提供的RestHighLevelClient，SpringData只是在其基础上进行了简单的封装。最近发现一款更优雅的ESORM框架EasyEs，使用它能像MyBatisPlus一样操作ES，今天就以mall项目中的商品搜索功能为例，来聊聊它的使用！EasyEs简介
　　EasyEs（简称EE）是一款基于Elasticsearch（简称ES）官方提供的RestHighLevelClient打造的ORM开发框架，在RestHighLevelClient的基础上，只做增强不做改变，为简化开发、提高效率而生。EE和MybatisPlus（简称MP）的用法非常相似，如果你之前使用过MP的话，应该能很快上手EE。EE的理念是：把简单、易用、方便留给用户，把复杂留给框架。
　　EE的主要特性如下：全自动索引托管：开发者无需关心索引的创建、更新及数据迁移等繁琐步骤，框架能自动完成。屏蔽语言差异：开发者只需要会MySQL的语法即可使用ES。代码量极少：与直接使用官方提供的RestHighLevelClient相比，相同的查询平均可以节省35倍的代码量。零魔法值：字段名称直接从实体中获取，无需手写。零额外学习成本：开发者只要会国内最受欢迎的MybatisPlus用法，即可无缝迁移至EE。MySQL与EasyEs语法对比
　　首先我们来对MySQL、EasyEs和RestHighLevelClient的语法做过对比，来快速学习下EasyEs的语法。
　　MySQL
　　EasyEs
　　esDSLesjavaapi
　　and
　　and
　　must
　　or
　　or
　　should
　　eq
　　term
　　！
　　ne
　　boolQueryBuilder。mustNot（queryBuilder）
　　gt
　　QueryBuilders。rangeQuery（esfield）。gt（）
　　ge
　　。rangeQuery（esfield）。gte（）
　　lt
　　。rangeQuery（esfield）。lt（）
　　le
　　。rangeQuery（esfield）。lte（）
　　likefield
　　like
　　QueryBuilders。wildcardQuery（field，value）
　　notlikefield
　　notLike
　　mustnotwildcardQuery（field，value）
　　likefield
　　likeLeft
　　QueryBuilders。wildcardQuery（field，value）
　　likefield
　　likeRight
　　QueryBuilders。wildcardQuery（field，value）
　　between
　　between
　　QueryBuilders。rangeQuery（esfield）。from（xx）。to（xx）
　　notBetween
　　notBetween
　　mustnotQueryBuilders。rangeQuery（esfield）。from（xx）。to（xx）
　　isnull
　　isNull
　　mustnotQueryBuilders。existsQuery（field）
　　isnotNull
　　isNotNull
　　QueryBuilders。existsQuery（field）
　　in
　　in
　　QueryBuilders。termsQuery（xxesfield，xx）
　　notin
　　notIn
　　mustnotQueryBuilders。termsQuery（xxesfield，xx）
　　groupby
　　groupBy
　　AggregationBuilders。terms（）
　　orderby
　　orderBy
　　fieldSortBuilder。order（ASCDESC）
　　min
　　min
　　AggregationBuilders。min
　　max
　　max
　　AggregationBuilders。max
　　avg
　　avg
　　AggregationBuilders。avg
　　sum
　　sum
　　AggregationBuilders。sum
　　orderbyxxxasc
　　orderByAsc
　　fieldSortBuilder。order（SortOrder。ASC）
　　orderbyxxxdesc
　　orderByDesc
　　fieldSortBuilder。order（SortOrder。DESC）
　　match
　　matchQuery
　　matchPhrase
　　QueryBuilders。matchPhraseQuery
　　matchPrefix
　　QueryBuilders。matchPhrasePrefixQuery
　　queryStringQuery
　　QueryBuilders。queryStringQuery
　　select
　　matchAllQuery
　　QueryBuilders。matchAllQuery（）
　　highLight
　　HighlightBuilder。Field
　　。。。
　　。。。
　　。。。集成及配置
　　接下来把EasyEs集成到项目中配置下就可以使用了。首先需要在pom。xml中添加EasyEs的相关依赖；dependencygroupIdcn。easyesgroupIdeasyesbootstarterartifactIdversion1。0。2versiondependency
　　由于底层使用了ES官方提供的RestHighLevelClient，这里ES的相关依赖版本需要统一下，这里使用的ES客户端版本为7。14。0，ES版本为7。17。3；dependencyManagementdependenciesdependencygroupIdorg。elasticsearch。clientgroupIdelasticsearchresthighlevelclientartifactIdversion7。14。0versiondependencydependencygroupIdorg。elasticsearchgroupIdelasticsearchartifactIdversion7。14。0versiondependencydependenciesdependencyManagement
　　再修改配置文件application。yml对EasyEs进行配置。easyes：是否开启EE自动配置enable：trueES连接地址端口address：localhost：9200关闭自带bannerbanner：false
　　添加EasyEs的Java配置，使用EsMapperScan配置好EasyEs的Mapper接口和文档对象路径，如果你使用了MyBatisPlus的话，需要和它的扫描路径区分开来。EasyEs配置类Createdbymacroon2022916。ConfigurationEsMapperScan（com。macro。mall。tiny。easyes）publicclassEasyEsConfig｛｝使用
　　EasyEs集成和配置完成后，就可以开始使用了。这里还是以mall项目的商品搜索功能为例，聊聊EasyEs的使用，SpringData的实现方式可以参考Elasticsearch项目实战，商品搜索功能设计与实现！。注解的使用
　　下面我们来学习下EasyEs中注解的使用。首先我们需要创建文档对象EsProduct，然后给类和字段添加上EasyEs的注解；搜索商品的信息Createdbymacroon2018619。DataEqualsAndHashCodeIndexName（valuepms，shardsNum1，replicasNum0）publicclassEsProductimplementsSerializable｛privatestaticfinallongserialVersionUID1L；IndexId（typeIdType。CUSTOMIZE）privateLIndexField（fieldTypeFieldType。KEYWORD）privateStringproductSn；privateLongbrandId；IndexField（fieldTypeFieldType。KEYWORD）privateStringbrandNprivateLongproductCategoryId；IndexField（fieldTypeFieldType。KEYWORD）privateStringproductCategoryNprivateSIndexField（fieldTypeFieldType。TEXT，analyzerikmaxword）privateSIndexField（fieldTypeFieldType。TEXT，analyzerikmaxword）privateStringsubTIndexField（fieldTypeFieldType。TEXT，analyzerikmaxword）privateSprivateBigDprivateIprivateIntegernewSprivateIntegerrecommandSprivateIprivateIntegerpromotionTprivateIIndexField（fieldTypeFieldType。NESTED，nestedClassEsProductAttributeValue。class）privateListEsProductAttributeValueattrValueLScoreprivateF｝EsProduct中的注解具体说明如下：
　　注解名称
　　用途
　　参数
　　IndexName
　　索引名注解
　　value：指定索引名；shardsNum：分片数；replicasNum：副本数
　　IndexId
　　ES主键注解
　　type：指定注解类型，CUSTOMIZE表示自定义
　　IndexField
　　ES字段注解
　　fieldType：字段在索引中的类型；analyzer：索引文档时用的分词器；nestedClass：嵌套类
　　Score
　　得分注解
　　decimalPlaces：得分保留小数位，实体类中被作为ES查询得分返回的字段使用EsProduct中嵌套类型EsProductAttributeValue的代码如下。搜索商品的属性信息Createdbymacroon2018627。DataEqualsAndHashCodepublicclassEsProductAttributeValueimplementsSerializable｛privatestaticfinallongserialVersionUID1L；IndexField（fieldTypeFieldType。LONG）privateLIndexField（fieldTypeFieldType。KEYWORD）privateLongproductAttributeId；属性值IndexField（fieldTypeFieldType。KEYWORD）privateS属性参数：0规格；1参数IndexField（fieldTypeFieldType。INTEGER）privateI属性名称IndexField（fieldTypeFieldType。KEYWORD）privateS｝商品信息维护
　　下面我们来实现几个简单的商品信息维护接口，包括商品信息的导入、创建和删除。首先我们需要定义一个Mapper，继承BaseEsM商品ES操作类Createdbymacroon2018619。publicinterfaceEsProductMapperextendsBaseEsMapperEsProduct｛｝
　　然后在Service实现类中直接使用EsProductMapper内置方法实现即可，是不是和MyBatisPlus的用法一致？搜索商品管理Service实现类Createdbymacroon2018619。ServicepublicclassEsProductServiceImplimplementsEsProductService｛AutowiredprivateEsProductDaoproductDAutowiredprivateEsProductMapperesProductMOverridepublicintimportAll（）｛ListEsProductesProductListproductDao。getAllEsProductList（null）；returnesProductMapper。insertBatch（esProductList）；｝Overridepublicvoiddelete（Longid）｛esProductMapper。deleteById（id）；｝OverridepublicEsProductcreate（Longid）｛EsPListEsProductesProductListproductDao。getAllEsProductList（id）；if（esProductList。size（）0）｛resultesProductList。get（0）；esProductMapper。insert（result）；｝｝Overridepublicvoiddelete（ListLongids）｛if（！CollectionUtils。isEmpty（ids））｛esProductMapper。deleteBatchIds（ids）；｝｝｝简单商品搜索
　　下面我们来实现一个最简单的商品搜索，分页搜索商品名称、副标题、关键词中包含指定关键字的商品。通过QueryWrapper来构造查询条件，然后使用Mapper中的方法来进行查询，使用过MyBatisPlus的小伙伴应该很熟悉了；搜索商品管理Service实现类Createdbymacroon2018619。ServicepublicclassEsProductServiceImplimplementsEsProductService｛AutowiredprivateEsProductMapperesProductMOverridepublicPageInfoEsProductsearch（Stringkeyword，IntegerpageNum，IntegerpageSize）｛LambdaEsQueryWrapperEsProductwrappernewLambdaEsQueryWrapper（）；if（StrUtil。isEmpty（keyword））｛wrapper。matchAllQuery（）；｝else｛wrapper。multiMatchQuery（keyword，EsProduct：：getName，EsProduct：：getSubTitle，EsProduct：：getKeywords）；｝returnesProductMapper。pageQuery（wrapper，pageNum，pageSize）；｝｝
　　使用Swagger访问接口后，可以在控制台输出查看生成的DSL语句
　　把DSL语句直接复制Kibana中即可执行查看结果了，这和我们手写DSL语句没什么两样的。
　　综合商品搜索
　　下面我们来实现一个复杂的商品搜索，涉及到过滤、不同字段匹配权重不同以及可以进行排序。首先来说需求，按输入的关键字搜索商品名称（权重10）、副标题（权重5）和关键词（权重2），可以按品牌和分类进行筛选，可以有5种排序方式，默认按相关度进行排序，看下接口文档有助于理解；
　　这个功能之前使用SpringData来实现非常复杂，使用EasyEs来实现确实简洁不少，下面是使用EasyEs的实现方式；搜索商品管理Service实现类Createdbymacroon2018619。ServicepublicclassEsProductServiceImplimplementsEsProductService｛AutowiredprivateEsProductMapperesProductMOverridepublicPageInfoEsProductsearch（Stringkeyword，LongbrandId，LongproductCategoryId，IntegerpageNum，IntegerpageSize，Integersort）｛LambdaEsQueryWrapperEsProductwrappernewLambdaEsQueryWrapper（）；过滤if（brandId！nullproductCategoryId！null）｛if（brandId！null）｛wrapper。eq（EsProduct：：getBrandId，brandId）；｝if（productCategoryId！null）｛wrapper。eq（EsProduct：：getProductCategoryId，productCategoryId）。enableMust2Filter（true）；｝｝搜索if（StrUtil。isEmpty（keyword））｛wrapper。matchAllQuery（）；｝else｛wrapper。and（ii。match（EsProduct：：getName，keyword，10f）。or（）。match（EsProduct：：getSubTitle，keyword，5f）。or（）。match（EsProduct：：getKeywords，keyword，2f））；｝排序if（sort1）｛按新品从新到旧wrapper。orderByDesc（EsProduct：：getId）；｝elseif（sort2）｛按销量从高到低wrapper。orderByDesc（EsProduct：：getSale）；｝elseif（sort3）｛按价格从低到高wrapper。orderByAsc（EsProduct：：getPrice）；｝elseif（sort4）｛按价格从高到低wrapper。orderByDesc（EsProduct：：getPrice）；｝else｛按相关度wrapper。sortByScore（SortOrder。DESC）；｝returnesProductMapper。pageQuery（wrapper，pageNum，pageSize）；｝｝再对比下之前使用SpringData的实现方式，没有QueryWrapper来构造条件，还要硬编码字段名称，确实优雅了不少！
　　相关商品推荐
　　当我们查看相关商品的时候，一般底部会有一些商品推荐，这里简单来实现下。首先来说下需求，可以根据指定商品的ID来查找相关商品，看下接口文档有助于理解；
　　这里我们的实现原理是这样的：首先根据ID获取指定商品信息，然后以指定商品的名称、品牌和分类来搜索商品，并且要过滤掉当前商品，调整搜索条件中的权重以获取最好的匹配度；使用EasyEs来实现依旧是那么简洁！搜索商品管理Service实现类Createdbymacroon2018619。ServicepublicclassEsProductServiceImplimplementsEsProductService｛AutowiredprivateEsProductMapperesProductMOverridepublicPageInfoEsProductrecommend（Longid，IntegerpageNum，IntegerpageSize）｛LambdaEsQueryWrapperEsProductwrappernewLambdaEsQueryWrapper（）；ListEsProductesProductListproductDao。getAllEsProductList（id）；if（esProductList。size（）0）｛EsProductesProductesProductList。get（0）；StringkeywordesProduct。getName（）；LongbrandIdesProduct。getBrandId（）；LongproductCategoryIdesProduct。getProductCategoryId（）；用于过滤掉相同的商品wrapper。ne（EsProduct：：getId，id）；根据商品标题、品牌、分类进行搜索wrapper。and（ii。match（EsProduct：：getName，keyword，8f）。or（）。match（EsProduct：：getSubTitle，keyword，2f）。or（）。match（EsProduct：：getKeywords，keyword，2f）。or（）。match（EsProduct：：getBrandId，brandId，5f）。or（）。match（EsProduct：：getProductCategoryId，productCategoryId，3f））；returnesProductMapper。pageQuery（wrapper，pageNum，pageSize）；｝returnesProductMapper。pageQuery（wrapper，pageNum，pageSize）；｝｝聚合搜索商品相关信息
　　在搜索商品时，经常会有一个筛选界面来帮助我们找到想要的商品，这里我们来简单实现下。首先来说下需求，可以根据搜索关键字获取到与关键字匹配商品相关的分类、品牌以及属性，下面这张图有助于理解；
　　这里我们可以使用ES的聚合来实现，搜索出相关商品，聚合出商品的品牌、商品的分类以及商品的属性，只要出现次数最多的前十个即可；由于EasyEs目前只用groupBy实现了简单的聚合，对于我们这种有嵌套对象的聚合无法支持，所以需要使用RestHighLevelClient来实现，如果你对照之前的SpringData实现方式的话，可以发现用法差不多，看样子SpringData只是做了简单的封装而已。搜索商品管理Service实现类Createdbymacroon2018619。ServicepublicclassEsProductServiceImplimplementsEsProductService｛AutowiredprivateEsProductMapperesProductMOverridepublicEsProductRelatedInfosearchRelatedInfo（Stringkeyword）｛SearchRequestsearchRequestnewSearchRequest（）；searchRequest。indices（pms）；SearchSourceBuilderbuildernewSearchSourceBuilder（）；搜索条件if（StrUtil。isEmpty（keyword））｛builder。query（QueryBuilders。matchAllQuery（））；｝else｛builder。query（QueryBuilders。multiMatchQuery（keyword，name，subTitle，keywords））；｝聚合搜索品牌名称builder。aggregation（AggregationBuilders。terms（brandNames）。field（brandName））；集合搜索分类名称builder。aggregation（AggregationBuilders。terms（productCategoryNames）。field（productCategoryName））；聚合搜索商品属性，去除type1的属性AbstractAggregationBuilderNestedAggregationBuilderaggregationBuilderAggregationBuilders。nested（allAttrValues，attrValueList）。subAggregation（AggregationBuilders。filter（productAttrs，QueryBuilders。termQuery（attrValueList。type，1））。subAggregation（AggregationBuilders。terms（attrIds）。field（attrValueList。productAttributeId）。subAggregation（AggregationBuilders。terms（attrValues）。field（attrValueList。value））。subAggregation（AggregationBuilders。terms（attrNames）。field（attrValueList。name））））；builder。aggregation（aggregationBuilder）；searchRequest。source（builder）；try｛SearchResponsesearchResponseesProductMapper。search（searchRequest，RequestOptions。DEFAULT）；returnconvertProductRelatedInfo（searchResponse）；｝catch（IOExceptione）｛e。printStackTrace（）；｝｝将返回结果转换为对象privateEsProductRelatedInfoconvertProductRelatedInfo（SearchResponseresponse）｛EsProductRelatedInfoproductRelatedInfonewEsProductRelatedInfo（）；MapString，AggregationaggregationMapresponse。getAggregations（）。asMap（）；设置品牌AggregationbrandNamesaggregationMap。get（brandNames）；ListStringbrandNameListnewArrayList（）；for（inti0；i（（Terms）brandNames）。getBuckets（）。size（）；i）｛brandNameList。add（（（Terms）brandNames）。getBuckets（）。get（i）。getKeyAsString（））；｝productRelatedInfo。setBrandNames（brandNameList）；设置分类AggregationproductCategoryNamesaggregationMap。get（productCategoryNames）；ListStringproductCategoryNameListnewArrayList（）；for（inti0；i（（Terms）productCategoryNames）。getBuckets（）。size（）；i）｛productCategoryNameList。add（（（Terms）productCategoryNames）。getBuckets（）。get（i）。getKeyAsString（））；｝productRelatedInfo。setProductCategoryNames（productCategoryNameList）；设置参数AggregationproductAttrsaggregationMap。get（allAttrValues）；L？extendsTerms。BucketattrIds（（ParsedStringTerms）（（ParsedFilter）（（ParsedNested）productAttrs）。getAggregations（）。get（productAttrs））。getAggregations（）。get（attrIds））。getBuckets（）；ListEsProductRelatedInfo。ProductAttrattrListnewArrayList（）；for（Terms。BucketattrId：attrIds）｛EsProductRelatedInfo。ProductAttrattrnewEsProductRelatedInfo。ProductAttr（）；attr。setAttrId（Long。parseLong（（String）attrId。getKey（）））；ListStringattrValueListnewArrayList（）；L？extendsTerms。BucketattrValues（（ParsedStringTerms）attrId。getAggregations（）。get（attrValues））。getBuckets（）；L？extendsTerms。BucketattrNames（（ParsedStringTerms）attrId。getAggregations（）。get（attrNames））。getBuckets（）；for（Terms。BucketattrValue：attrValues）｛attrValueList。add（attrValue。getKeyAsString（））；｝attr。setAttrValues（attrValueList）；if（！CollectionUtils。isEmpty（attrNames））｛StringattrNameattrNames。get（0）。getKeyAsString（）；attr。setAttrName（attrName）；｝attrList。add（attr）；｝productRelatedInfo。setProductAttrs（attrList）；returnproductRelatedI｝｝总结
　　今天将之前的使用SpringData的商品搜索案例使用EasyEs改写了一下，确实使用EasyEs更简单，但是对于复杂的聚合搜索功能，两者都需要使用原生的RestHighLevelClient用法来实现。使用EasyEs来操作ES确实足够优雅，它类似MyBatisPlus的用法能大大降低我们的学习成本，快速完成开发工作！