简介
我们的应用经常需要添加检索功能,开源的 ElasticSearch 是目前全文搜索引擎的首选。他可以快速的存储、搜索和分析海量数据。Spring Boot通过整合Spring Data ElasticSearch为我们提供了非常便捷的检索功能支持;
Elasticsearch是一个分布式搜索服务,提供Restful API,底层基于Lucene,采用多shard(分片)的方式保证数据安全,并且提供自动resharding的功能,github等大型的站点也是采用了ElasticSearch作为其搜索服务。
我们可以在ES的官网查看ES的使用文档文档
概念
以员工文档的形似存储为例:一个文档代表一个员工数据。存储数据到ElasticSearch的行为叫做索引,但在索引一个文档之前。需要确定将文档存储在哪里
一个ElasticSearch集群可以包含多个索引,相应的每个索引可以包含多个类型。这些不同的类型存储着多个文档,每个文档又有多个属性。
索引(Index):Elastic 会索引所有字段,经过处理后写入一个反向索引(Inverted Index)。查找数据的时候,直接查找该索引。所以,Elastic 数据管理的顶层单位就叫做 Index(索引)。它是单个数据库的同义词。每个 Index (即数据库)的名字必须是小写。
- 索引(名词):
如前所述,一个 索引 类似于传统关系数据库中的一个 数据库 ,是一个存储关系型文档的地方。 索引 (index) 的复数词为 indices 或 indexes 。 - 索引(动词):
索引一个文档 就是存储一个文档到一个 索引 (名词)中以便被检索和查询。这非常类似于 SQL 语句中的
INSERT
关键词,除了文档已存在时,新文档会替换旧文档情况之外。- 索引(名词):
文档(Document):Index 里面单条的记录称为 Document(文档)。许多条 Document 构成了一个 Index。同一个 Index 里面的 Document,不要求有相同的结构(scheme),但是最好保持相同,这样有利于提高搜索效率。
类型(Type):Document 可以分组,比如weather这个 Index 里面,可以按城市分组(北京和上海),也可以按气候分组(晴天和雨天)。这种分组就叫做 Type,它是虚拟的逻辑分组,用来过滤 Document。
ElasticSearch与数据库的对应
- 索引—数据库
- 类型—表
- 文档—表中的记录
- 属性—列
ElasticSearch基础入门
这个教程完全来自于ElasticSearch的官方教程,官方教程
实现案例-创建一个雇员目录
我们受雇于 Megacorp 公司,作为 HR 部门新的 “热爱无人机” (”We love our drones!”)激励项目的一部分,我们的任务是为此创建一个员工目录。该目录应当能培养员工认同感及支持实时、高效、动态协作,因此有一些业务需求:
- 支持包含多值标签、数值、以及全文本的数据
- 检索任一员工的完整信息
- 允许结构化搜索,比如查询 30 岁以上的员工
- 允许简单的全文搜索以及较复杂的短语搜索
- 支持在匹配文档内容中高亮显示搜索片段
- 支持基于数据创建和管理分析仪表盘
索引员工文档
第一个业务需求是存储员工数据。 这将会以 员工文档 的形式存储:一个文档代表一个员工。存储数据到 Elasticsearch 的行为叫做 索引 ,但在索引一个文档之前,需要确定将文档存储在哪里。
对于员工目录,我们将做如下操作:
- 每个员工索引一个文档,文档包含该员工的所有信息。
- 每个文档都将是
employee
类型 。 - 该类型位于 索引
megacorp
内。
实践中这非常简单(尽管看起来有很多步骤),我们可以通过一条命令完成所有这些动作:注意,路径 /megacorp/employee/1 包含了三部分的信息:PUT /megacorp/employee/1
{
"first_name" : "John",
"last_name" : "Smith",
"age" : 25,
"about" : "I love to go rock climbing",
"interests": [ "sports", "music" ]
}megacorp
: 索引名称employee
: 类型名称1
:特定雇员的ID
请求体 —— JSON 文档 —— 包含了这位员工的所有详细信息,他的名字叫 John Smith ,今年 25 岁,喜欢攀岩。
返回值包含了创建的后的一些信息这个请求我们可以通过postman发送,去实现{
"_index": "megacorp",
"_type": "employee",
"_id": "1",
"_version": 1,
"result": "created",
"_shards": {
"total": 2,
"successful": 1,
"failed": 0
},
"created": true
}
很简单!无需进行执行管理任务,如创建一个索引或指定每个属性的数据类型之类的,可以直接只索引一个文档。Elasticsearch 默认地完成其他一切,因此所有必需的管理任务都在后台使用默认设置完成。
进行下一步前,让我们增加更多的员工信息到目录中:
PUT /megacorp/employee/2 |
检索文档
目前我们已经在 Elasticsearch 中存储了一些数据, 接下来就能专注于实现应用的业务需求了。第一个需求是可以检索到单个雇员的数据。
这在 Elasticsearch
中很简单。简单地执行 一个 HTTP GET
请求并指定文档的地址——索引库、类型和ID。 使用这三个信息可以返回原始的 JSON 文档:
GET /megacorp/employee/1 |
返回的数据为:
{ |
将 HTTP
命令由 PUT
改为 GET
可以用来检索文档,同样的,可以使用 DELETE
命令来删除文档,以及使用 HEAD
指令来检查文档是否存在。如果想更新已存在的文档,只需再次 PUT
。
轻量搜索
一个 GET
是相当简单的,可以直接得到指定的文档。 现在尝试点儿稍微高级的功能,比如一个简单的搜索!
第一个尝试的几乎是最简单的搜索了。我们使用下列请求来搜索所有雇员:
GET /megacorp/employee/_search |
可以看到,我们仍然使用索引库 megacorp
以及类型 employee
,但与指定一个文档 ID 不同,这次使用 _search
。返回结果包括了所有三个文档,放在数组 hits
中。一个搜索默认返回十条结果。
{ |
注意:返回结果不仅告知匹配了哪些文档,还包含了整个文档本身:显示搜索结果给最终用户所需的全部信息。
接下来,尝试下搜索姓氏为 Smith
的雇员。为此,我们将使用一个 高亮 搜索,很容易通过命令行完成。这个方法一般涉及到一个 查询字符串 (query-string) 搜索,因为我们通过一个URL参数来传递查询信息给搜索接口:
GET /megacorp/employee/_search?q=last_name:Smith |
我们仍然在请求路径中使用 _search
端点,并将查询本身赋值给参数 q=
。返回结果给出了所有的 Smith
:
{ |
使用查询表达式搜索
Query-string
搜索通过命令非常方便地进行临时性的即席搜索 ,但它有自身的局限性(参见 轻量 搜索 )。Elasticsearch 提供一个丰富灵活的查询语言叫做 查询表达式 , 它支持构建更加复杂和健壮的查询。领域特定语言 (DSL)
, 使用 JSON 构造了一个请求。我们可以像这样重写之前的查询所有名为 Smith
的搜索 :
GET /megacorp/employee/_search |
返回结果与之前的查询一样,但还是可以看到有一些变化。其中之一是,不再使用 query-string 参数,而是一个请求体替代。这个请求使用 JSON 构造,并使用了一个 match 查询(属于查询类型之一,后面将继续介绍)。
更复杂的搜索
现在尝试下更复杂的搜索。 同样搜索姓氏为 Smith
的员工,但这次我们只需要年龄大于 30
的。查询需要稍作调整,使用过滤器 filter
,它支持高效地执行一个结构化查询。
GET /megacorp/employee/_search |
目前无需太多担心语法问题,后续会更详细地介绍。只需明确我们添加了一个 过滤器 用于执行一个范围查询,并复用之前的 match 查询。现在结果只返回了一名员工,叫 Jane Smith,32 岁。
全文搜索
截止目前的搜索相对都很简单:单个姓名,通过年龄过滤。现在尝试下稍微高级点儿的全文搜索——一项 传统数据库确实很难搞定的任务。
搜索下所有喜欢攀岩(rock climbing)的员工:
GET /megacorp/employee/_search |
显然我们依旧使用之前的 match 查询在about
属性上搜索 “rock climbing” 。得到两个匹配的文档:
{ |
Elasticsearch 默认按照相关性得分排序,即每个文档跟查询的匹配程度。第一个最高得分的结果很明显:John Smith 的 about 属性清楚地写着 “rock climbing” 。
但为什么 Jane Smith 也作为结果返回了呢?原因是她的 about 属性里提到了 “rock” 。因为只有 “rock” 而没有 “climbing” ,所以她的相关性得分低于 John 的。
这是一个很好的案例,阐明了 Elasticsearch 如何 在 全文属性上搜索并返回相关性最强的结果。Elasticsearch中的 相关性 概念非常重要,也是完全区别于传统关系型数据库的一个概念,数据库中的一条记录要么匹配要么不匹配。
短语搜索
找出一个属性中的独立单词是没有问题的,但有时候想要精确匹配一系列单词或者短语 。 比如, 我们想执行这样一个查询,仅匹配同时包含 “rock” 和 “climbing” ,并且 二者以短语 “rock climbing” 的形式紧挨着的雇员记录。
为此对 match
查询稍作调整,使用一个叫做 match_phrase
的查询:
GET /megacorp/employee/_search |
返回的结果为
{ |
高亮搜索
许多应用都倾向于在每个搜索结果中 高亮 部分文本片段,以便让用户知道为何该文档符合查询条件。在 Elasticsearch 中检索出高亮片段也很容易。
再次执行前面的查询,并增加一个新的 highlight
参数:
GET /megacorp/employee/_search |
当执行该查询时,返回结果与之前一样,与此同时结果中还多了一个叫做 highlight
的部分。这个部分包含了 about 属性匹配的文本片段,并以 HTML 标签 封装:
{ |
分析
终于到了最后一个业务需求:支持管理者对员工目录做分析。 Elasticsearch 有一个功能叫聚合(aggregations),允许我们基于数据生成一些精细的分析结果。聚合与 SQL 中的 GROUP BY 类似但更强大。
举个例子,挖掘出员工中最受欢迎的兴趣爱好:
GET /megacorp/employee/_search |
这里需要注意,这样直接聚合会出现错误,因为聚合是非常消耗内存的,所以需要在聚合之前对需要聚合的字段开启限制,
PUT /megacorp/_mapping/employee/ |
然后我们才可以获取到结果,暂时忽略掉语法,直接看看结果:
{ |
可以看到,两位员工对音乐感兴趣,一位对林业感兴趣,一位对运动感兴趣。这些聚合的结果数据并非预先统计,而是根据匹配当前查询的文档即时生成的。如果想知道叫 Smith 的员工中最受欢迎的兴趣爱好,可以直接构造一个组合查询:
GET /megacorp/employee/_search |
返回的结果就是
{ |
聚合还支持分级汇总 。比如,查询特定兴趣爱好员工的平均年龄:
GET /megacorp/employee/_search |
返回的结果为:
{ |
输出基本是第一次聚合的加强版。依然有一个兴趣及数量的列表,只不过每个兴趣都有了一个附加的 avg_age 属性,代表有这个兴趣爱好的所有员工的平均年龄。
到这里简单额ES的体验就结束了,更加详细的ES教程我会单独开篇解说。
SpringBoot整合ElasticSearch
在pom文件中引入ElasticSearch的依赖,SpringBoot默认使用SpringData来操作ElasticSearch
<dependency> |
SpringBoot默认支持三种技术来与ElasticSearch交互
- Jest(默认不)
- 需要导入工具包(io.searchbox.client.JestClient)
- 从springboot2.2.0以后被弃用
- rest是ES的官方客户端
RestClient
可以使用,es已经将其集成- 具体使用在后面实现
- SpringData ElasticSearch
- 配置了
TransportClient
需要配置两个属性:clusterNodes
,clusterName
ElasticsearchTemplate
操作es - 对应客户端为TransportClient(弃用)ElasticsearchRestTemplate
也可以操作es - 对应客户端为High Level REST Client
- 配置了
使用Rest客户端操作ES
- 我们创建一个bean
//确定索引和类型
"ustc",type = "book") (indexName =
public class Book {
private Integer id;
private String bookName;
private String author;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getBookName() {
return bookName;
}
public void setBookName(String bookName) {
this.bookName = bookName;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public String toString() {
return "Book{" +
"id=" + id +
", bookName='" + bookName + '\'' +
", author='" + author + '\'' +
'}';
}
} - 配置主机地址
- 配置类配置:
注意:这种方式底层依赖于Http相关类,因此要导入web相关jar包
public class EsConfig {
RestHighLevelClient client()
{
ClientConfiguration clientConfiguration = ClientConfiguration.builder()
.connectedTo("192.163.1.8:9200")
.build();
return RestClients.create(clientConfiguration).rest();
}
} - spring配置文件指定
http://192.168.1.8:9200 =
- 配置类配置:
- 在要使用的地方注入客户端
RestHighLevelClient highLevelClient; - 创建索引我们可以从浏览器输入http://192.168.1.8:9200/ustc/book/_search,就可以看到我们之前创建好的文档
void contextLoads() {
IndexRequest request = new IndexRequest("ustc", "book",
UUID.randomUUID().toString())
.source(Collections.singletonMap("feature", "high-level-rest-client"))
.setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE);
try
{
IndexResponse index = highLevelClient.index(request, RequestOptions.DEFAULT);
System.out.println(index.toString());
}catch (IOException ex)
{
ex.printStackTrace();
}
}{
"took": 6,
"timed_out": false,
"_shards": {
"total": 5,
"successful": 5,
"skipped": 0,
"failed": 0
},
"hits": {
"total": 1,
"max_score": 1.0,
"hits": [
{
"_index": "ustc",
"_type": "book",
"_id": "99031c16-15b2-423c-9b45-3e009f9d5aa4",
"_score": 1.0,
"_source": {
"feature": "high-level-rest-client"
}
}
]
}
} - 获取索引
public void GetIndex()
{
//分别指定要获取的索引、类型、id
GetRequest getRequest = new GetRequest("ustc","book","99031c16-15b2-423c-9b45-3e009f9d5aa4");
try
{
GetResponse documentFields = highLevelClient.get(getRequest, RequestOptions.DEFAULT);
System.out.println(documentFields);
}
catch (Exception ex)
{
ex.printStackTrace();
}
}
使用ElasticsearchRestTemplate操作ES
ES有两个模板,分别为ElasticsearchRestTemplate
和ElasticsearchTemplate
分别对应于High Level REST Client
和Transport Client
(弃用),两个模板都实现了ElasticsearchOperations
接口,因此使用时我们一般使用ElasticsearchOperations
,具体实现方式由底层决定。
由于在AbstractElasticsearchConfiguration
中已经向容器中导入了ElasticsearchRestTemplate
,因此我们使用时可以直接注入
注入SpringData的操作模板
ElasticsearchOperations elasticsearchOperations;向ES里面保存一个文档
public void SaveIndex()
{
Book book = new Book();
book.setAuthor("路遥");
book.setBookName("平凡的世界");
book.setId(1);
IndexQuery indexQuery = new IndexQueryBuilder()
.withId(book.getId().toString())
.withObject(book)
.build();
String index = elasticsearchOperations.index(indexQuery);
}查询文档
public void FindBook()
{
Book book = elasticsearchOperations.queryForObject(GetQuery.getById("1"), Book.class);
System.out.println(book.toString());
}Elasticsearch Repositories操作ES
编写相关Repository并继承Repository或ElasticsearchRepository,泛型分别为<查询类,主键>
public interface BookRepository extends Repository<Book,Integer> {
List<Book> findByBookNameAndAuthor(String bookName, String author);
}查询的方法仅需按照一定规则命名即可实现功能,无需编写实现,如上findByBookNameAndAuthor()方法相当于ES的json查询
{
"query": {
"bool" : {
"must" : [
{ "query_string" : { "query" : "?", "fields" : [ "bookName" ] } },
{ "query_string" : { "query" : "?", "fields" : [ "author" ] } }
]
}
}
}@Query
注解自定义请求jsonpublic interface BookRepository extends Repository<Book,Integer> {
"{\"match\": {\"name\": {\"query\": \"?0\"}}}") (
Page<Book> findByName(String name, Pageable pageable);
}若参数为John,相当于请求体为
{
"query": {
"match": {
"name": {
"query": "John"
}
}
}
}更多整合案例请参考官方文档