分布式搜索--ElasticSearch 数据聚合&自动补全(五)

ShiShuoMing
115 阅读10分钟

一、数据聚合

1.聚合的作用

聚合(aggregations)可以让我们极其方便的实现对数据的统计、分析、运算。例如：

  • 什么品牌的手机最受欢迎？
  • 这些手机的平均价格、最高价格、最低价格？
  • 这些手机每月的销售情况如何？

实现这些统计功能的比数据库的sql要方便的多，而且查询速度非常快，可以实现近实时搜索效果。

2.聚合的种类

聚合常见的有三类：

  • 桶（Bucket）聚合：用来对文档做分组 (非text类型,text类型分词会有多个字段值)

    • TermAggregation：按照文档字段值分组，例如按照品牌值分组、按照国家分组
    • Date Histogram：按照日期阶梯分组，例如一周为一组，或者一月为一组

  • 度量（Metric）聚合：用以计算一些值，比如：最大值、最小值、平均值等

    • Avg：求平均值
    • Max：求最大值
    • Min：求最小值
    • Stats：同时求max、min、avg、sum等

  • 管道（pipeline）聚合：其它聚合的结果为基础做聚合

注意：参加聚合的字段必须是keyword、日期、数值、布尔类型

3.Bucket聚合

如果我们要统计所有数据中的酒店品牌有几种，其实就是按照品牌对数据分组。此时可以根据酒店品牌的名称做聚合，也就是Bucket聚合。

语法如下：

GET /hotel/_search
{
  "size": 0,  // 设置size为0，这样结果中不包含文档数据，只包含聚合结果
  "aggs": { // 定义聚合
    "brandAgg": { //给聚合起个名字(品牌聚合)，自定义
      "terms": { // 聚合的类型，按照品牌值聚合，所以选择term
        "field": "brand", // 参与聚合的字段
        "size": 20 // 希望获取的聚合结果数量
      }
    }
  }
}

size为0，hits文档内容不显示

image.png

默认情况下，Bucket聚合会统计Bucket内的文档数量，记为_count，并且按照_count降序排序。

我们可以通过指定order属性，自定义聚合的排序方式：

GET /hotel/_search
{
  "size": 0, 
  "aggs": {
    "brandAgg": {
      "terms": {
        "field": "brand",
        "order": {
          "_count": "asc" // 按照_count升序排列
        },
        "size": 20
      }
    }
  }
}

默认情况下，Bucket聚合是对索引库的所有文档做聚合，但真实场景下，只会对用户搜索的结果聚合。因此上述聚合必须添加限定条件。

我们要限定聚合的文档范围，只需添加query条件即可：

GET /hotel/_search
{
  "query": {
    "range": {
      "price": {
        "lte": 200 // 只对200元以下的文档聚合
      }
    }
  }, 
  "size": 0, 
  "aggs": {
    "brandAgg": {
      "terms": {
        "field": "brand",
        "size": 20
      }
    }
  }
}
4.Metric聚合

上述我们通过使用Bucket聚合对酒店按照品牌分组，形成了一个个桶。现在我们需要对桶内的酒店做运算，获取每个品牌的用户评分的min、max、avg等值。

这就要用到Metric聚合了，例如stat聚合：就可以获取min、max、avg等结果。

语法如下：

GET /hotel/_search
{
  "size": 0, 
  "aggs": {
    "brandAgg": { 
      "terms": { 
        "field": "brand", 
        "size": 20
      },
      "aggs": { // 是brands聚合的子聚合，也就是分组后对每组分别计算
        "score_stats": { // 聚合名称
          "stats": { // 聚合类型，这里stats可以计算min、max、avg等
            "field": "score" // Metric聚合字段，这里是score
          }
        }
      }
    }
  }
}

这里的score_stats聚合是在brandAgg的聚合内部嵌套的子聚合。因为我们需要在每个桶分别计算。

image.png

另外，我们还可以给聚合结果做个排序，例如按照每个桶的酒店平均分做排序：

image.png

5.RestClient实现聚合

聚合条件与query条件同级别，因此需要使用request.source()来指定聚合条件。

聚合条件的语法： image.png

聚合的结果也与查询结果不同，API也比较特殊。不过同样是JSON逐层解析：

image.png

需求： 查询杭州的所有酒店分类数据。

@Test
void tesAggregationt() throws IOException {
    SearchRequest request = new SearchRequest("hotel");
    request.source().query(QueryBuilders.termQuery("city", "上海"));

    request.source().size(0);
    request.source().aggregation(AggregationBuilders
            .terms("brandAgg")
            .field("brand")
            .size(100)
    );
    SearchResponse search = client.search(request, RequestOptions.DEFAULT);

    Aggregations aggregations = search.getAggregations();
    Terms brandAgg = aggregations.get("brandAgg");
    List<? extends Terms.Bucket> buckets = brandAgg.getBuckets();
    for(Terms.Bucket bucket : buckets) {
        String key = bucket.getKeyAsString();
        System.out.println(key);
    }
}
6.案例

搜索页面的品牌、城市等信息的选项不应该是在页面写死，而应该通过聚合索引库中的酒店数据得来的：

image.png

使用聚合功能，利用Bucket聚合，对搜索结果中的文档基于品牌分组、基于城市分组，就能得知包含哪些品牌、哪些城市了。

image.png

结果是一个Map结构：

  • key是字符串，城市、星级、品牌、价格
  • value是集合，例如多个城市的名称
@PostMapping("filters")
public Map<String, List<String>> getFilters(@RequestBody RequestParams requestParams) {
    return hotelService.getFilters(requestParams);
}

@Override
public Map<String, List<String>> getFilters(RequestParams requestParams) {
    try {
        SearchRequest request = new SearchRequest("hotel");
        request.source().query(boolQueryBuilder(requestParams));

        //聚合
        request.source().size(0);
        request.source().aggregation(AggregationBuilders
                .terms("brandAgg")
                .field("brand")
                .size(100));
        request.source().aggregation(AggregationBuilders
                .terms("cityAgg")
                .field("city")
                .size(100));

        request.source().aggregation(AggregationBuilders
                .terms("starAgg")
                .field("starName")
                .size(100));

        SearchResponse search = client.search(request, RequestOptions.DEFAULT);
        Aggregations aggregations = search.getAggregations();
        Map<String, List<String>> map = new HashMap<>();
        map.put("品牌", getAggByName(aggregations, "brandAgg"));
        map.put("城市", getAggByName(aggregations, "cityAgg"));
        map.put("星级", getAggByName(aggregations, "starAgg"));
        System.out.println(map);
        return map;
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}
private List<String> getAggByName(Aggregations aggregations, String brandAgg) { //根据聚合名称，封装方法
    Terms aggregation = aggregations.get(brandAgg);
    List<? extends Terms.Bucket> buckets = aggregation.getBuckets();

    List<String> list = new ArrayList<>();
    for(Terms.Bucket bucket : buckets) {
        list.add(bucket.getKeyAsString());
    }
    return list;
}

二、自动补全

当用户在搜索框输入字符时，我们应该提示出与该字符有关的搜索项，如图：

image.png

这种根据用户输入的字母，提示完整词条的功能，就是自动补全了。

1.拼音分词器

要实现根据字母做补全，就必须对文档按照拼音分词，这时就需要自己配置拼音分词功能,在GitHub上恰好有elasticsearch的拼音分词插件。

安装步骤：

    1. 连接服务器，切换到es绑定的插件数据卷中
    • cd /var/lib/docker/volumes/es-plugins/_data
    1. 将压缩包上传至此目录并解压(也可在本地解压好,传过去)
    • unzip elasticsearch-analysis-pinyin-7.12.1.zip -d py
    1. 重启elasticsearch
    • docker restart es

测试：

POST /_analyze
{
  "text": "如家酒店还不错",
  "analyzer": "pinyin"
}

image.png

如上可以看到我们已经成功安装好了拼音分词器。但是它还存在一些问题，无法直接使用，接下来让我们一起解决吧。

2.自定义分词器

(1)前言

默认的拼音分词器会将每个汉字单独分为拼音，而我们所希望的是每个词条形成一组拼音，因此需要对拼音分词器做个性化定制，形成自定义分词器。

elasticsearch中分词器（analyzer）的组成包含三部分：

  • character filters：在tokenizer之前对文本进行处理。例如删除字符、替换字符

  • tokenizer：将文本按照一定的规则切割成词条（term）。例如keyword，就是不分词；还有ik_smart

  • tokenizer filter：将tokenizer输出的词条做进一步处理。例如大小写转换、同义词处理、拼音处理等

文档分词时会依次由这三部分来处理文档：

image.png

(2)使用

我们在可以在创建索引库时，通过settings来配置自定义的analyzer(分词器)。

声明自定义分词器的语法如下：

PUT /test  // 创建索引库
{
  "settings": { //配置自定义分词器
    "analysis": {
      "analyzer": { // 自定义分词器
        "my_analyzer": {  // 自定义分词器名称
          "tokenizer": "ik_max_word", // 切割词条
          "filter": "py"      // 自定义拼音处理方式
        }
      },
      "filter": { // 自定义tokenizer filter
        "py": { // 过滤器名称
          "type": "pinyin", // 过滤器类型，这里是pinyin
          //拼音分词器filter属性配置
          "keep_full_pinyin": false,
          "keep_joined_full_pinyin": true,
          "keep_original": true,
          "limit_first_letter_length": 16,
          "remove_duplicated_term": true,
          "none_chinese_pinyin_tokenize": false
        }
      }
    }
  },
  "mappings": {
    "properties": {
      "name": {  // 定义字段
        "type": "text",  // 定义类型
        "analyzer": "my_analyzer",  // 定义字段分词器
      }
    }
  }
}

拼音分词器filter属性详细配置介绍可以看官方文档拼音分词插件。

setting配置只能在当前索引库使用，my_analyzer分词器只能在test索引库使用

image.png

(3)改进

当搜索内容有中文的 shizi 时，分词器会把搜索内容按照 拼音分词器 分词，再进行匹配，会把同音不同字的结果查出来

image.png

拼音分词器适合在创建倒排索引的时候使用，但不适合在搜索的时候使用，这是为了避免搜索时搜到到同音字。

image.png

改进使用：

PUT /test  
{
  "settings": {
    "analysis": {
      "analyzer": { 
        "my_analyzer": {  
          "tokenizer": "ik_max_word", 
          "filter": "py"      
        }
      },
      "filter": { 
        "py": {...}
      }
    }
  },
  "mappings": {
    "properties": {
      "name": {  
        "type": "text",  
        "analyzer": "my_analyzer",  // 指定创建倒排索引分词器
        "search_analyzer": "ik_smart"   // 指定搜索时分词器
      }
    }
  }
}

我们可以在配置中指定两个分词器，一个用于创建倒排索引，一个用于搜索(search_analyzer)。

image.png

3.自动补全查询

es提供了Completion Suggester查询来实现自动补全功能。这个查询会匹配以用户输入内容开头的词条并返回。为了提高补全查询的效率，对于文档中字段的类型有一些约束：

  • 参与补全查询的字段必须是completion类型。
  • 字段的内容一般是用来补全的多个词条形成的数组。

使用数组的好处是查询结果会按照用户输入的前缀进行匹配，数组有多个元素只要前缀能匹配任意元素，即可返回数组的全部值

比如，一个这样的索引库：

// 创建索引库
PUT test
{
  "mappings": {
    "properties": {
      "title":{
        "type": "completion"
      }
    }
  }
}

然后插入下面的数据：

// 示例数据
POST test/_doc
{
  "title": ["Sony", "WH-1000XM3"]
}
POST test/_doc
{
  "title": ["SK-II", "PITERA"]
}
POST test/_doc
{
  "title": ["Nintendo", "switch"]
}

查询的DSL语句如下：

// 自动补全查询
GET /test/_search
{
  "suggest": {
    "title_suggest": { //查询名称，可自定义
      "text": "s", // 查询时待补全关键字
      "completion": {
        "field": "title", // 补全查询的字段
        "skip_duplicates": true, // 跳过重复的
        "size": 10 // 获取前10条结果
      }
    }
  }
}

返回结果中_source.title为数组全部值

image.png

4.RestClient实现自动补全

(1)前言 为了更好的用户体验，当用户在搜索框搜索内容时，我们可以给出相似选项提示，效果如下：

image.png

查看前端页面，可以发现当我们在输入框键入时，前端会发起ajax请求：

image.png

返回值是补全词条的集合，类型为List<String>,请求参数key在url中

(2)修改索引库配置

我们创建索引库并未提前设置拼音分词器。我们知道索引库是无法修改的，因此只能先删除然后重新创建。

此外，我们还需要添加一个completion类型字段，用来做自动补全，将brand、business、city等都放进去，作为自动补全的提示。

在kinbana中进行如下操作：

    1. 先删除酒店数据索引库
DELETE /hotel
  • 2. 重新创建索引库
// 酒店数据索引库
PUT /hotel
{
  "settings": {
    "analysis": {
      "analyzer": {  //自定义两个分词器，一个分词，一个不分词
        "text_anlyzer": { //文本类型要分词
          "tokenizer": "ik_max_word",
          "filter": "py"
        },
        "completion_analyzer": { //补全时不分词，因为补全内容为brand、business、city全是keyword不需要分词
          "tokenizer": "keyword",
          "filter": "py"
        }
      },
      "filter": {
        "py": {
          "type": "pinyin",
          "keep_full_pinyin": false,
          "keep_joined_full_pinyin": true,
          "keep_original": true,
          "limit_first_letter_length": 16,
          "remove_duplicated_term": true,
          "none_chinese_pinyin_tokenize": false
        }
      }
    }
  },
  "mappings": {
    "properties": {
      "id":{
        "type": "keyword"
      },
      "name":{
        "type": "text",
        "analyzer": "text_anlyzer",
        "search_analyzer": "ik_smart",
        "copy_to": "all"
      },
      "address":{
        "type": "keyword",
        "index": false
      },
      "price":{
        "type": "integer"
      },
      "score":{
        "type": "integer"
      },
      "brand":{
        "type": "keyword",
        "copy_to": "all"
      },
      "city":{
        "type": "keyword"
      },
      "starName":{
        "type": "keyword"
      },
      "business":{
        "type": "keyword",
        "copy_to": "all"
      },
      "location":{
        "type": "geo_point"
      },
      "pic":{
        "type": "keyword",
        "index": false
      },
      "all":{
        "type": "text",
        "analyzer": "text_anlyzer",
        "search_analyzer": "ik_smart"
      },
      "suggestion":{
          "type": "completion",
          "analyzer": "completion_analyzer"
      }
    }
  }
}

(3)修改实体类

我们需要在HotelDoc中添加一个字段，用来做自动补全，内容可以是酒店品牌、城市、商圈等信息。按照自动补全字段的要求，最好是这些字段的数组。

因此我们在HotelDoc中添加一个字段，类型为List<String>，然后将brand、city、business等信息放到里面。

代码如下 (business商圈信息会出现 多个地区简以/连接在一起，所以要将其分开为不同商圈)：

@Data
@NoArgsConstructor
public class HotelDoc {
    private Long id;
    private String name;
    private String address;
    private Integer price;
    private Integer score;
    private String brand;
    private String city;
    private String starName;
    private String business;
    private String location;
    private String pic;
    // 添加记录排序时的 距离值
    private Object distance;

    //自动补全
    private List<String> suggestion;

    public HotelDoc(Hotel hotel) {
        this.id = hotel.getId();
        this.name = hotel.getName();
        this.address = hotel.getAddress();
        this.price = hotel.getPrice();
        this.score = hotel.getScore();
        this.brand = hotel.getBrand();
        this.city = hotel.getCity();
        this.starName = hotel.getStarName();
        this.business = hotel.getBusiness();
        this.location = hotel.getLatitude() + ", " + hotel.getLongitude();
        this.pic = hotel.getPic();

        if(this.business.contains("/")) {
            String[] split = this.business.split("/");
            this.suggestion = new ArrayList<>();
            this.suggestion.add(this.city);
            this.suggestion.add(this.brand);
            Collections.addAll(this.suggestion, split);
        } else {
            this.suggestion = Arrays.asList(this.city, this.business, this.brand);
        }
    }
}

(4)批量导入数据

执行之前写过的批量导入方法，将数据库中的数据导入es中

image.png

(5)测试DSL

GET /hotel/_search
{
  "suggest": {
    "my_suggestion": {
      "text": "s",
       "completion":{
         "field": "suggestion",
          "skip_duplicates": true, 
          "size": 10
       }
    }
  }
}

image.png

(6)定义Controller层

@GetMapping("suggestion")
public List<String> getSuggestions(@RequestParam("key") String  prefix) {
    return hotelService.getSuggestions(prefix);
}

(7)定义service层

image.png

image.png

@Override
public List<String> getSuggestions(String prefix) {
    try {
        SearchRequest request = new SearchRequest("hotel");
        request.source().suggest(new SuggestBuilder().addSuggestion(
                "mySuggestion", //查询名称，可自定义
                SuggestBuilders.completionSuggestion("suggestion") //补全查询的字段
                        .prefix(prefix)
                        .skipDuplicates(true) //去重,跳过重复的
                        .size(10)
        ));

        SearchResponse response = client.search(request, RequestOptions.DEFAULT);

        Suggest suggest = response.getSuggest();
        CompletionSuggestion suggestion = suggest.getSuggestion("mySuggestion");
        List<CompletionSuggestion.Entry.Option> options = suggestion.getOptions();
        List<String> list = new ArrayList<>();
        for(CompletionSuggestion.Entry.Option opt : options) {
            list.add(opt.getText().string());
        }
        return list;
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

image.png

avatar
文章
阅读
粉丝