mall整合Elasticsearch实现商品搜索

本文主要讲解mall整合Elasticsearch的过程,以实现商品信息在Elasticsearch中的导入、查询、修改、删除为例。

项目使用框架介绍

Elasticsearch

Elasticsearch 是一个分布式、可扩展、实时的搜索与数据分析引擎。 它能从项目一开始就赋予你的数据以搜索、分析和探索的能力,可用于实现全文搜索和实时数据统计。

Elasticsearch的安装和使用

1.下载Elasticsearch6.2.2的zip包,并解压到指定目录,下载地址:https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2

mall整合Elasticsearch实现商品搜索

2.安装中文分词插件,在elasticsearch-6.2.2\bin目录下执行以下命令:elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v6.2.2/elasticsearch-analysis-ik-6.2.2.zip

3.运行bin目录下的elasticsearch.bat启动Elasticsearch

4.下载Kibana,作为访问Elasticsearch的客户端,请下载6.2.2版本的zip包,并解压到指定目录,下载地址:https://artifacts.elastic.co/downloads/kibana/kibana-6.2.2-windows-x86_64.zip

5.运行bin目录下的kibana.bat,启动Kibana的用户界面

6.访问http://localhost:5601 即可打开Kibana的用户界面

Spring Data Elasticsearch

Spring Data Elasticsearch是Spring提供的一种以Spring Data风格来操作数据存储的方式,它可以避免编写大量的样板代码。

常用注解

@Document

  1. //标示映射到Elasticsearch文档上的领域对象

  2. public @interface Document {

  3.  //索引库名次,mysql中数据库的概念

  4.    String indexName();

  5.  //文档类型,mysql中表的概念

  6.    String type() default "";

  7.  //默认分片数

  8.    short shards() default 5;

  9.  //默认副本数量

  10.    short replicas() default 1;


  11. }

@Id

//表示是文档的id,文档可以认为是mysql中表行的概念public @interface Id {}

@Field

public @interface Field {  //文档中字段的类型    FieldType type() default FieldType.Auto;  //是否建立倒排索引    boolean index() default true;  //是否进行存储    boolean store() default false;  //分词器名次    String analyzer() default "";}
//为文档自动指定元数据类型public enum FieldType {    Text,//会进行分词并建了索引的字符类型    Integer,    Long,    Date,    Float,    Double,    Boolean,    Object,    Auto,//自动判断字段类型    Nested,//嵌套对象类型    Ip,    Attachment,    Keyword//不会进行分词建立索引的类型}

Sping Data方式的数据操作

继承ElasticsearchRepository接口可以获得常用的数据操作方法

可以使用衍生查询

在接口中直接指定查询方法名称便可查询,无需进行实现,如商品表中有商品名称、标题和关键字,直接定义以下查询,就可以对这三个字段进行全文搜索。

    /**     * 搜索查询     *     * @param name              商品名称     * @param subTitle          商品标题     * @param keywords          商品关键字     * @param page              分页信息     * @return     */    Page<EsProduct> findByNameOrSubTitleOrKeywords(String name, String subTitle, String keywords, Pageable page);

在idea中直接会提示对应字段

使用@Query注解可以用Elasticsearch的DSL语句进行查询
@Query("{"bool" : {"must" : {"field" : {"name" : "?0"}}}}")Page<EsProduct> findByName(String name,Pageable pageable);

项目使用表说明

  • pms_product:商品信息表

  • pms_product_attribute:商品属性参数表

  • pms_product_attribute_value:存储产品参数值的表

整合Elasticsearch实现商品搜索

在pom.xml中添加相关依赖

<!--Elasticsearch相关依赖--><dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-data-elasticsearch<artifactId></dependency>

修改SpringBoot配置文件

修改application.yml文件,在spring节点下添加Elasticsearch相关配置。

data:  elasticsearch:    repositories:      enabled: true    cluster-nodes: 127.0.0.1:9300 # es的连接地址及端口号    cluster-name: elasticsearch # es集群的名称

添加商品文档对象EsProduct

不需要中文分词的字段设置成@Field(type = FieldType.Keyword)类型,需要中文分词的设置成@Field(analyzer = "ikmaxword",type = FieldType.Text)类型。


  1. package com.macro.mall.tiny.nosql.elasticsearch.document;


  2. import org.springframework.data.annotation.Id;

  3. import org.springframework.data.elasticsearch.annotations.Document;

  4. import org.springframework.data.elasticsearch.annotations.Field;

  5. import org.springframework.data.elasticsearch.annotations.FieldType;


  6. import java.io.Serializable;

  7. import java.math.BigDecimal;

  8. import java.util.List;


  9. /**

  10. * 搜索中的商品信息

  11. * Created by macro on 2018/6/19.

  12. */

  13. @Document(indexName = "pms", type = "product",shards = 1,replicas = 0)

  14. public class EsProduct implements Serializable {

  15.    private static final long serialVersionUID = -1L;

  16.    @Id

  17.    private Long id;

  18.    @Field(type = FieldType.Keyword)

  19.    private String productSn;

  20.    private Long brandId;

  21.    @Field(type = FieldType.Keyword)

  22.    private String brandName;

  23.    private Long productCategoryId;

  24.    @Field(type = FieldType.Keyword)

  25.    private String productCategoryName;

  26.    private String pic;

  27.    @Field(analyzer = "ik_max_word",type = FieldType.Text)

  28.    private String name;

  29.    @Field(analyzer = "ik_max_word",type = FieldType.Text)

  30.    private String subTitle;

  31.    @Field(analyzer = "ik_max_word",type = FieldType.Text)

  32.    private String keywords;

  33.    private BigDecimal price;

  34.    private Integer sale;

  35.    private Integer newStatus;

  36.    private Integer recommandStatus;

  37.    private Integer stock;

  38.    private Integer promotionType;

  39.    private Integer sort;

  40.    @Field(type =FieldType.Nested)

  41.    private List<EsProductAttributeValue> attrValueList;


  42.    //省略了所有getter和setter方法

  43. }

添加EsProductRepository接口用于操作Elasticsearch

继承ElasticsearchRepository接口,这样就拥有了一些基本的Elasticsearch数据操作方法,同时定义了一个衍生查询方法。


  1. package com.macro.mall.tiny.nosql.elasticsearch.repository;


  2. import com.macro.mall.tiny.nosql.elasticsearch.document.EsProduct;

  3. import org.springframework.data.domain.Page;

  4. import org.springframework.data.domain.Pageable;

  5. import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;


  6. /**

  7. * 商品ES操作类

  8. * Created by macro on 2018/6/19.

  9. */

  10. public interface EsProductRepository extends ElasticsearchRepository<EsProduct, Long> {

  11.    /**

  12.     * 搜索查询

  13.     *

  14.     * @param name              商品名称

  15.     * @param subTitle          商品标题

  16.     * @param keywords          商品关键字

  17.     * @param page              分页信息

  18.     * @return

  19.     */

  20.    Page<EsProduct> findByNameOrSubTitleOrKeywords(String name, String subTitle, String keywords, Pageable page);


  21. }

添加EsProductService接口


  1. package com.macro.mall.tiny.service;


  2. import com.macro.mall.tiny.nosql.elasticsearch.document.EsProduct;

  3. import org.springframework.data.domain.Page;


  4. import java.util.List;


  5. /**

  6. * 商品搜索管理Service

  7. * Created by macro on 2018/6/19.

  8. */

  9. public interface EsProductService {

  10.    /**

  11.     * 从数据库中导入所有商品到ES

  12.     */

  13.    int importAll();


  14.    /**

  15.     * 根据id删除商品

  16.     */

  17.    void delete(Long id);


  18.    /**

  19.     * 根据id创建商品

  20.     */

  21.    EsProduct create(Long id);


  22.    /**

  23.     * 批量删除商品

  24.     */

  25.    void delete(List<Long> ids);


  26.    /**

  27.     * 根据关键字搜索名称或者副标题

  28.     */

  29.    Page<EsProduct> search(String keyword, Integer pageNum, Integer pageSize);


  30. }

添加EsProductService接口的实现类EsProductServiceImpl


  1. package com.macro.mall.tiny.service.impl;


  2. import com.macro.mall.tiny.dao.EsProductDao;

  3. import com.macro.mall.tiny.nosql.elasticsearch.document.EsProduct;

  4. import com.macro.mall.tiny.nosql.elasticsearch.repository.EsProductRepository;

  5. import com.macro.mall.tiny.service.EsProductService;

  6. import org.slf4j.Logger;

  7. import org.slf4j.LoggerFactory;

  8. import org.springframework.beans.factory.annotation.Autowired;

  9. import org.springframework.data.domain.Page;

  10. import org.springframework.data.domain.PageRequest;

  11. import org.springframework.data.domain.Pageable;

  12. import org.springframework.stereotype.Service;

  13. import org.springframework.util.CollectionUtils;


  14. import java.util.ArrayList;

  15. import java.util.Iterator;

  16. import java.util.List;



  17. /**

  18. * 商品搜索管理Service实现类

  19. * Created by macro on 2018/6/19.

  20. */

  21. @Service

  22. public class EsProductServiceImpl implements EsProductService {

  23.    private static final Logger LOGGER = LoggerFactory.getLogger(EsProductServiceImpl.class);

  24.    @Autowired

  25.    private EsProductDao productDao;

  26.    @Autowired

  27.    private EsProductRepository productRepository;


  28.    @Override

  29.    public int importAll() {

  30.        List<EsProduct> esProductList = productDao.getAllEsProductList(null);

  31.        Iterable<EsProduct> esProductIterable = productRepository.saveAll(esProductList);

  32.        Iterator<EsProduct> iterator = esProductIterable.iterator();

  33.        int result = 0;

  34.        while (iterator.hasNext()) {

  35.            result++;

  36.            iterator.next();

  37.        }

  38.        return result;

  39.    }


  40.    @Override

  41.    public void delete(Long id) {

  42.        productRepository.deleteById(id);

  43.    }


  44.    @Override

  45.    public EsProduct create(Long id) {

  46.        EsProduct result = null;

  47.        List<EsProduct> esProductList = productDao.getAllEsProductList(id);

  48.        if (esProductList.size() > 0) {

  49.            EsProduct esProduct = esProductList.get(0);

  50.            result = productRepository.save(esProduct);

  51.        }

  52.        return result;

  53.    }


  54.    @Override

  55.    public void delete(List<Long> ids) {

  56.        if (!CollectionUtils.isEmpty(ids)) {

  57.            List<EsProduct> esProductList = new ArrayList<>();

  58.            for (Long id : ids) {

  59.                EsProduct esProduct = new EsProduct();

  60.                esProduct.setId(id);

  61.                esProductList.add(esProduct);

  62.            }

  63.            productRepository.deleteAll(esProductList);

  64.        }

  65.    }


  66.    @Override

  67.    public Page<EsProduct> search(String keyword, Integer pageNum, Integer pageSize) {

  68.        Pageable pageable = PageRequest.of(pageNum, pageSize);

  69.        return productRepository.findByNameOrSubTitleOrKeywords(keyword, keyword, keyword, pageable);

  70.    }


  71. }

添加EsProductController定义接口


  1. package com.macro.mall.tiny.controller;


  2. import com.macro.mall.tiny.common.api.CommonPage;

  3. import com.macro.mall.tiny.common.api.CommonResult;

  4. import com.macro.mall.tiny.nosql.elasticsearch.document.EsProduct;

  5. import com.macro.mall.tiny.service.EsProductService;

  6. import io.swagger.annotations.Api;

  7. import io.swagger.annotations.ApiOperation;

  8. import org.springframework.beans.factory.annotation.Autowired;

  9. import org.springframework.data.domain.Page;

  10. import org.springframework.stereotype.Controller;

  11. import org.springframework.web.bind.annotation.*;


  12. import java.util.List;


  13. /**

  14. * 搜索商品管理Controller

  15. * Created by macro on 2018/6/19.

  16. */

  17. @Controller

  18. @Api(tags = "EsProductController", description = "搜索商品管理")

  19. @RequestMapping("/esProduct")

  20. public class EsProductController {

  21.    @Autowired

  22.    private EsProductService esProductService;


  23.    @ApiOperation(value = "导入所有数据库中商品到ES")

  24.    @RequestMapping(value = "/importAll", method = RequestMethod.POST)

  25.    @ResponseBody

  26.    public CommonResult<Integer> importAllList() {

  27.        int count = esProductService.importAll();

  28.        return CommonResult.success(count);

  29.    }


  30.    @ApiOperation(value = "根据id删除商品")

  31.    @RequestMapping(value = "/delete/{id}", method = RequestMethod.GET)

  32.    @ResponseBody

  33.    public CommonResult<Object> delete(@PathVariable Long id) {

  34.        esProductService.delete(id);

  35.        return CommonResult.success(null);

  36.    }


  37.    @ApiOperation(value = "根据id批量删除商品")

  38.    @RequestMapping(value = "/delete/batch", method = RequestMethod.POST)

  39.    @ResponseBody

  40.    public CommonResult<Object> delete(@RequestParam("ids") List<Long> ids) {

  41.        esProductService.delete(ids);

  42.        return CommonResult.success(null);

  43.    }


  44.    @ApiOperation(value = "根据id创建商品")

  45.    @RequestMapping(value = "/create/{id}", method = RequestMethod.POST)

  46.    @ResponseBody

  47.    public CommonResult<EsProduct> create(@PathVariable Long id) {

  48.        EsProduct esProduct = esProductService.create(id);

  49.        if (esProduct != null) {

  50.            return CommonResult.success(esProduct);

  51.        } else {

  52.            return CommonResult.failed();

  53.        }

  54.    }


  55.    @ApiOperation(value = "简单搜索")

  56.    @RequestMapping(value = "/search/simple", method = RequestMethod.GET)

  57.    @ResponseBody

  58.    public CommonResult<CommonPage<EsProduct>> search(@RequestParam(required = false) String keyword,

  59.                                                      @RequestParam(required = false, defaultValue = "0") Integer pageNum,

  60.                                                      @RequestParam(required = false, defaultValue = "5") Integer pageSize) {

  61.        Page<EsProduct> esProductPage = esProductService.search(keyword, pageNum, pageSize);

  62.        return CommonResult.success(CommonPage.restPage(esProductPage));

  63.    }


  64. }

进行接口测试

将数据库中数据导入到Elasticsearch

mall整合Elasticsearch实现商品搜索mall整合Elasticsearch实现商品搜索

进行商品搜索

mall整合Elasticsearch实现商品搜索mall整合Elasticsearch实现商品搜索


上一篇:【译】Rust宏:教程与示例(二) - Rust过程宏,看完本文就会写!


下一篇:mall整合Redis实现缓存功能