1. 数据聚合
1.1 聚合的种类
-
聚合常见的有三类:
-
桶(Bucket)聚合:用来对文档做分组
- TermAggregation:按照文档字段值分组,例如按照品牌值分组、按照国家分组
- Date Histogram:按照日期阶梯分组,例如一周为一组,或者一月为一组
-
度量(Metric)聚合:用以计算一些值,比如:最大值、最小值、平均值等
- Avg:求平均值
- Max:求最大值
- Min:求最小值
- Stats:同时求max、min、avg、sum等
-
管道(pipeline)聚合:其它聚合的结果为基础做聚合
-
注意:参加聚合的字段必须是keyword、日期、数值、布尔类型
1.2.DSL实现聚合
1.2.1.Bucket聚合语法
- 现在,我们要统计所有数据中的酒店品牌有几种,其实就是按照品牌对数据分组。此时可以根据酒店品牌的名称做聚合,也就是Bucket聚合。
- 语法如下:
GET /hotel/_search
{
"size": 0, // 设置size为0,结果中不包含文档,只包含聚合结果
"aggs": { // 定义聚合
"brandAgg": { //给聚合起个名字
"terms": { // 聚合的类型,按照品牌值聚合,所以选择term
"field": "brand", // 参与聚合的字段
"size": 20 // 希望获取的聚合结果数量
}
}
}
}
- 结果如图:
1.2.2.聚合结果排序
- 默认情况下,Bucket聚合会统计Bucket内的文档数量,记为_count,并且按照_count降序排序。
- 我们可以指定order属性,自定义聚合的排序方式
- 语法如下
GET /hotel/_search
{
"size": 0,
"aggs": {
"brandAgg": {
"terms": {
"field": "brand",
"order": {
"_count": "asc" // 按照_count升序排列
},
"size": 20
}
}
}
}
1.2.3.限定聚合范围
- 默认情况下,Bucket聚合是对索引库的所有文档做聚合,但真实场景下,用户会输入搜索条件,因此聚合必须是对搜索结果聚合。那么聚合必须添加限定条件。
- 我们可以限定要聚合的文档范围,只要添加query条件即可:
- 语法如下
GET /hotel/_search
{
"query": {
"range": {
"price": {
"lte": 200 // 只对200元以下的文档聚合
}
}
},
"size": 0,
"aggs": {
"brandAgg": {
"terms": {
"field": "brand",
"size": 20
}
}
}
}
- 这次,聚合得到的品牌明显变少了:
1.2.4.Metric聚合语法
- 上节课,我们对酒店按照品牌分组,形成了一个个桶。现在我们需要对桶内的酒店做运算,获取每个品牌的用户评分的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" // 聚合字段,这里是score
}
}
}
}
}
}
- 这次的score_stats聚合是在brandAgg的聚合内部嵌套的子聚合。因为我们需要在每个桶分别计算。另外,我们还可以给聚合结果做个排序,例如按照每个桶的酒店平均分做排序:
1.2.5.小结
- aggs代表聚合,与query同级,此时query的作用是?
- 限定聚合的的文档范围
- 聚合必须的三要素:
- 聚合名称
- 聚合类型
- 聚合字段
- 聚合可配置属性有:
- size:指定聚合结果数量
- order:指定聚合结果排序方式
- field:指定聚合字段
1.3.RestAPI实现聚合
1.3.1.API语法
- 聚合条件与query条件同级别,因此需要使用request.source()来指定聚合条件。
- 聚合条件的语法:
- 聚合条件的语法:
- 聚合的结果也与查询结果不同,API也比较特殊。不过同样是JSON逐层解析:
1.3.2.业务实例
- 需求:搜索页面的品牌、城市等信息不应该是在页面写死,而是通过聚合索引库中的酒店数据得来的
- 分析:
-
目前,页面的城市列表、星级列表、品牌列表都是写死的,并不会随着搜索结果的变化而变化。但是用户搜索条件改变时,搜索结果会跟着变化。
-
例如:用户搜索“东方明珠”,那搜索的酒店肯定是在上海东方明珠附近,因此,城市只能是上海,此时城市列表中就不应该显示北京、深圳、杭州这些信息了。
-
也就是说,搜索结果中包含哪些城市,页面就应该列出哪些城市;搜索结果中包含哪些品牌,页面就应该列出哪些品牌。
-
如何得知搜索结果中包含哪些品牌?如何得知搜索结果中包含哪些城市?
-
使用聚合功能,利用Bucket聚合,对搜索结果中的文档基于品牌分组、基于城市分组,就能得知包含哪些品牌、哪些城市了。
-
因为是对搜索结果聚合,因此聚合是限定范围的聚合,也就是说聚合的限定条件跟搜索文档的条件一致。
-
- 查看浏览器可以发现,前端其实已经发出了这样的一个请求:
- 返回值类型就是页面要展示的最终结果:
- 结果是一个Map结构:
- key是字符串,城市、星级、品牌、价格
- value是集合,例如多个城市的名称
- 业务代码
/**
* 聚合
*
* @param requestParam
* @return
*/
@Override
public Map<String, List<String>> FilterHotel(RequestParams requestParam) {
//创建请求
SearchRequest searchRequest = new SearchRequest(EsConstant.INDEX);
//调用查询条件
Search(requestParam, searchRequest);
//城市聚合
AggMethod(searchRequest, "cityAgg", "city", 20);
//星级聚合
AggMethod(searchRequest, "starNameAgg", "starName", 20);
//品牌聚合
AggMethod(searchRequest, "brandAgg", "brand", 20);
// 3.发出请求
try {
SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
//创建集合存储解析结果
Map<String, List<String>> result = new HashMap<>();
//获取aggregations
Aggregations aggregations = searchResponse.getAggregations();
//获取城市聚合获取对应的结果
List<String> cityAgg = getAggByName(aggregations, "cityAgg");
//获取星级聚合获取对应的结果
List<String> starNameAgg = getAggByName(aggregations, "starNameAgg");
//获取品牌聚合获取对应的结果
List<String> brandAgg = getAggByName(aggregations, "brandAgg");
//将结果集添加到集合
result.put("city", cityAgg);
result.put("starName", starNameAgg);
result.put("brand", brandAgg);
//返回结果值
return result;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
- 业务代码中抽取的方法1
/**
* 根据聚合名称获取对应的结果
*
* @param aggregations
* @param aggName 聚合名称
* @return
*/
private List<String> getAggByName(Aggregations aggregations, String aggName) {
//创建新的集合用于获取聚合的key
List<String> aggList = new ArrayList<>();
//根据聚合名称获取聚合结果
Terms Agg = aggregations.get(aggName);
//获取buckets
List<? extends Terms.Bucket> buckets = Agg.getBuckets();
//遍历buckets,获取里面的key
for (Terms.Bucket bucket : buckets) {
//获取key
String keyAsString = bucket.getKeyAsString();
//添加到集合
aggList.add(keyAsString);
}
return aggList;
}
- 业务代码中抽取的方法2
/**
* 聚合方法
*
* @param searchRequest
* @param aggName 聚合名称
* @param fieldName 聚合字段
* @param size 显示条数
*/
private void AggMethod(SearchRequest searchRequest, String aggName, String fieldName, int size) {
//设置显示的条数
searchRequest.source().size(0);
//设置聚合
searchRequest.source().aggregation(
//聚合名称
AggregationBuilders.terms(aggName)
//聚合字段
.field(fieldName)
//显示条数
.size(size)
);
}
2.自动补全
- 当用户在搜索框输入字符时,我们应该提示出与该字符有关的搜索项,如图:
- 这种根据用户输入的字母,提示完整词条的功能,就是自动补全了。因为需要根据拼音字母来推断,因此要用到拼音分词功能。
2.1.拼音分词器
- 测试用法如下:
POST /_analyze
{
"text": "如家酒店还不错",
"analyzer": "pinyin"
}
2.2.自定义分词器
- 默认的拼音分词器会将每个汉字单独分为拼音,而我们希望的是每个词条形成一组拼音,需要对拼音分词器做个性化定制,形成自定义分词器。
- elasticsearch中分词器(analyzer)的组成包含三部分:
- character filters:在tokenizer之前对文本进行处理。例如删除字符、替换字符
- tokenizer:将文本按照一定的规则切割成词条(term)。例如keyword,就是不分词;还有ik_smart
- tokenizer filter:将tokenizer输出的词条做进一步处理。例如大小写转换、同义词处理、拼音处理等
- 声明自定义分词器的语法如下
PUT /test
{
"settings": {
"analysis": {
"analyzer": {
"my_analyzer": {
"tokenizer": "ik_max_word",
"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": {
"name": {
"type": "text",
"analyzer": "my_analyzer",
"search_analyzer": "ik_smart"
}
}
}
}
- 测试
2.3.自动补全查询
- elasticsearch提供了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条结果
}
}
}
}
2.4 业务示例
-
现在,我们的hotel索引库还没有设置拼音分词器,需要修改索引库中的配置。但是我们知道索引库是无法修改的,只能删除然后重新创建。
-
另外,我们需要添加一个字段,用来做自动补全,将brand、suggestion、city等都放进去,作为自动补全的提示。
-
因此,总结一下,我们需要做的事情包括:
-
修改hotel索引库结构,设置自定义拼音分词器
-
修改索引库的name、all字段,使用自定义分词器
-
索引库添加一个新字段suggestion,类型为completion类型,使用自定义的分词器
-
给HotelDoc类添加suggestion字段,内容包含brand、business
-
重新导入数据到hotel库
-
2.4.1.修改hotel映射结构
- 代码示例(包含自动补全和拼音分词)
// 酒店数据索引库
PUT /hotel
{
"settings": {
"analysis": {
"analyzer": {
"text_anlyzer": {
"tokenizer": "ik_max_word",
"filter": "py"
},
"completion_analyzer": {
"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"
}
}
}
}
2.4.2.修改HotelDoc实体
- HotelDoc中要添加一个字段,用来做自动补全,内容可以是酒店品牌、城市、商圈等信息。按照自动补全字段的要求,最好是这些字段的数组。
- 因此我们在HotelDoc中添加一个suggestion字段,类型为
List<String>
,然后将brand、city、business等信息放到里面。- 代码如下:
package cn.itcast.hotel.pojo;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
@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 Boolean isAD;
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();
// 组装suggestion
if(this.business.contains("/")){
// business有多个值,需要切割
String[] arr = this.business.split("/");
// 添加元素
this.suggestion = new ArrayList<>();
this.suggestion.add(this.brand);
Collections.addAll(this.suggestion, arr);
}else {
this.suggestion = Arrays.asList(this.brand, this.business);
}
}
}
2.4.3.自动补全查询的JavaAPI
- 之前我们学习了自动补全查询的DSL,而没有学习对应的JavaAPI,这里给出一个示例:
- 而自动补全的结果也比较特殊,解析的代码如下:
2.4.5.实现搜索框自动补全
/**
* 自动补全
*
* @param prefix 关键字
* @return
*/
@Override
public List<String> getSuggestions(String prefix) {
try {
//创建请求
SearchRequest searchRequest = new SearchRequest(EsConstant.INDEX);
//准备DSL
searchRequest.source().suggest(
new SuggestBuilder()
//hotel_suggest自动补全的名称,suggestion实体类中自定义的自动补全的属性名
.addSuggestion("hotel_suggest", SuggestBuilders.completionSuggestion("suggestion")
//关键字
.prefix(prefix)
//自动补全
.skipDuplicates(true)
//展示的条数
.size(10)
)
);
//发送请求
SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT);
//获取suggest
Suggest suggest = searchResponse.getSuggest();
//创建一个新的集合用于存储自动补全的数值
List<String> list = new ArrayList<>();
//Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>> hotelSuggest = suggest.getSuggestion("hotel_suggest");
//根据自动补全的名称获取对应的结果
CompletionSuggestion hotelSuggest = suggest.getSuggestion("hotel_suggest");
//获取options集合
List<CompletionSuggestion.Entry.Option> optionList = hotelSuggest.getOptions();
//遍历options获取里面的text(根据前缀搜索的内容)
for (CompletionSuggestion.Entry.Option option : optionList) {
String text = option.getText().toString();
//添加到集合中
list.add(text);
}
//返回结果值
return list;
} catch (IOException e) {
//抛出异常
throw new RuntimeException(e);
}
}