全文搜索引擎 ElasticSearch 入门教程
JanBuchanan
7年前
<p><a href="/misc/goto?guid=4959751450434604184">全文搜索</a>属于最常见的需求，开源的 <a href="/misc/goto?guid=4958878318875848520">ElasticSearch</a> （以下简称 Elastic）是目前全文搜索引擎的首选。</p> <p>它可以快速地储存、搜索和分析海量数据。维基百科、Stack Overflow、Github 都采用它。</p> <p><img alt="全文搜索引擎 ElasticSearch 入门教程 - 阮一峰的网络日志" src="https://simg.open-open.com/show/9bdd8de19c11ef521abfbba488f0ae71.jpg"></p> <p>Elastic 的底层是开源库 <a href="/misc/goto?guid=4959616477822139189">Lucene</a>。但是，你没法直接用 Lucene，必须自己写代码去调用它的接口。Elastic 是 Lucene 的封装，提供了 REST API 的操作接口，开箱即用。</p> <p>本文从零开始，讲解如何使用 Elastic 搭建自己的全文搜索引擎。每一步都有详细的说明，大家跟着做就能学会。</p> <h2>一、安装</h2> <p>Elastic 需要 Java 8 环境。如果你的机器还没安装 Java，可以参考<a href="/misc/goto?guid=4959751450572317153">这篇文章</a>，注意要保证环境变量<code>JAVA_HOME</code>正确设置。</p> <p>安装完 Java，就可以跟着<a href="/misc/goto?guid=4959751450658597696">官方文档</a>安装 Elastic。直接下载压缩包比较简单。</p> <blockquote> <pre> <code> $ wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.5.1.zip $ unzip elasticsearch-5.5.1.zip $ cd elasticsearch-5.5.1/ </code></pre> </blockquote> <p>接着，进入解压后的目录，运行下面的命令，启动 Elastic。</p> <blockquote> <pre> <code> $ ./bin/elasticsearch </code></pre> </blockquote> <p>如果这时<a href="/misc/goto?guid=4959751450742529042">报错</a>"max virtual memory areas vm.max<em>map</em>count [65530] is too low"，要运行下面的命令。</p> <blockquote> <pre> <code> $ sudo sysctl -w vm.max_map_count=262144 </code></pre> </blockquote> <p>如果一切正常，Elastic 就会在默认的9200端口运行。这时，打开另一个命令行窗口，请求该端口，会得到说明信息。</p> <blockquote> <pre> <code> $ curl localhost:9200 { "name" : "atntrTf", "cluster_name" : "elasticsearch", "cluster_uuid" : "tf9250XhQ6ee4h7YI11anA", "version" : { "number" : "5.5.1", "build_hash" : "19c13d0", "build_date" : "2017-07-18T20:44:24.823Z", "build_snapshot" : false, "lucene_version" : "6.6.0" }, "tagline" : "You Know, for Search" } </code></pre> </blockquote> <p>上面代码中，请求9200端口，Elastic 返回一个 JSON 对象，包含当前节点、集群、版本等信息。</p> <p>按下 Ctrl + C，Elastic 就会停止运行。</p> <p>默认情况下，Elastic 只允许本机访问，如果需要远程访问，可以修改 Elastic 安装目录的<code>config/elasticsearch.yml</code>文件，去掉<code>network.host</code>的注释，将它的值改成<code>0.0.0.0</code>，然后重新启动 Elastic。</p> <blockquote> <pre> <code> network.host: 0.0.0.0 </code></pre> </blockquote> <p>上面代码中，设成<code>0.0.0.0</code>让任何人都可以访问。线上服务不要这样设置，要设成具体的 IP。</p> <h2>二、基本概念</h2> <h3>2.1 Node 与 Cluster</h3> <p>Elastic 本质上是一个分布式数据库，允许多台服务器协同工作，每台服务器可以运行多个 Elastic 实例。</p> <p>单个 Elastic 实例称为一个节点（node）。一组节点构成一个集群（cluster）。</p> <h3>2.2 Index</h3> <p>Elastic 会索引所有字段，经过处理后写入一个反向索引（Inverted Index）。查找数据的时候，直接查找该索引。</p> <p>所以，Elastic 数据管理的顶层单位就叫做 Index（索引）。它是单个数据库的同义词。每个 Index （即数据库）的名字必须是小写。</p> <p>下面的命令可以查看当前节点的所有 Index。</p> <blockquote> <pre> <code> $ curl -X GET '<a href="/misc/goto?guid=4959500470929990660">http://localhost</a>:9200/_cat/indices?v' </code></pre> </blockquote> <h3>2.3 Document</h3> <p>Index 里面单条的记录称为 Document（文档）。许多条 Document 构成了一个 Index。</p> <p>Document 使用 JSON 格式表示，下面是一个例子。</p> <blockquote> <pre> <code> { "user": "张三", "title": "工程师", "desc": "数据库管理" } </code></pre> </blockquote> <p>同一个 Index 里面的 Document，不要求有相同的结构（scheme），但是最好保持相同，这样有利于提高搜索效率。</p> <h3>2.4 Type</h3> <p>Document 可以分组，比如<code>weather</code>这个 Index 里面，可以按城市分组（北京和上海），也可以按气候分组（晴天和雨天）。这种分组就叫做 Type，它是虚拟的逻辑分组，用来过滤 Document。</p> <p>不同的 Type 应该有相似的结构（schema），举例来说，<code>id</code>字段不能在这个组是字符串，在另一个组是数值。这是与关系型数据库的表的<a href="/misc/goto?guid=4959751450851797480">一个区别</a>。性质完全不同的数据（比如<code>products</code>和<code>logs</code>）应该存成两个 Index，而不是一个 Index 里面的两个 Type（虽然可以做到）。</p> <p>下面的命令可以列出每个 Index 所包含的 Type。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/_mapping?pretty=true' </code></pre> </blockquote> <p>根据<a href="/misc/goto?guid=4959751450938132282">规划</a>，Elastic 6.x 版只允许每个 Index 包含一个 Type，7.x 版将会彻底移除 Type。</p> <h2>三、新建和删除 Index</h2> <p>新建 Index，可以直接向 Elastic 服务器发出 PUT 请求。下面的例子是新建一个名叫<code>weather</code>的 Index。</p> <blockquote> <pre> <code> $ curl -X PUT 'localhost:9200/weather' </code></pre> </blockquote> <p>服务器返回一个 JSON 对象，里面的<code>acknowledged</code>字段表示操作成功。</p> <blockquote> <pre> <code> { "acknowledged":true, "shards_acknowledged":true } </code></pre> </blockquote> <p>然后，我们发出 DELETE 请求，删除这个 Index。</p> <blockquote> <pre> <code> $ curl -X DELETE 'localhost:9200/weather' </code></pre> </blockquote> <h2>四、中文分词设置</h2> <p>首先，安装中文分词插件。这里使用的是 <a href="/misc/goto?guid=4959652237055128027">ik</a>，也可以考虑其他插件（比如 <a href="/misc/goto?guid=4959751451041808324">smartcn</a>）。</p> <blockquote> <pre> <code> $ ./bin/elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v5.5.1/elasticsearch-analysis-ik-5.5.1.zip </code></pre> </blockquote> <p>上面代码安装的是5.5.1版的插件，与 Elastic 5.5.1 配合使用。</p> <p>接着，重新启动 Elastic，就会自动加载这个新安装的插件。</p> <p>然后，新建一个 Index，指定需要分词的字段。这一步根据数据结构而异，下面的命令只针对本文。基本上，凡是需要搜索的中文字段，都要单独设置一下。</p> <blockquote> <pre> <code> $ curl -X PUT 'localhost:9200/accounts' -d ' { "mappings": { "person": { "properties": { "user": { "type": "text", "analyzer": "ik_max_word", "search_analyzer": "ik_max_word" }, "title": { "type": "text", "analyzer": "ik_max_word", "search_analyzer": "ik_max_word" }, "desc": { "type": "text", "analyzer": "ik_max_word", "search_analyzer": "ik_max_word" } } } } }' </code></pre> </blockquote> <p>上面代码中，首先新建一个名称为<code>accounts</code>的 Index，里面有一个名称为<code>person</code>的 Type。<code>person</code>有三个字段。</p> <blockquote> <ul> <li>user</li> <li>title</li> <li>desc</li> </ul> </blockquote> <p>这三个字段都是中文，而且类型都是文本（text），所以需要指定中文分词器，不能使用默认的英文分词器。</p> <p>Elastic 的分词器称为 <a href="/misc/goto?guid=4959751451129226601">analyzer</a>。我们对每个字段指定分词器。</p> <blockquote> <pre> <code> "user": { "type": "text", "analyzer": "ik_max_word", "search_analyzer": "ik_max_word" } </code></pre> </blockquote> <p>上面代码中，<code>analyzer</code>是字段文本的分词器，<code>search_analyzer</code>是搜索词的分词器。<code>ik_max_word</code>分词器是插件<code>ik</code>提供的，可以对文本进行最大数量的分词。</p> <h2>五、数据操作</h2> <h3>5.1 新增记录</h3> <p>向指定的 /Index/Type 发送 PUT 请求，就可以在 Index 里面新增一条记录。比如，向<code>/accounts/person</code>发送请求，就可以新增一条人员记录。</p> <blockquote> <pre> <code> $ curl -X PUT 'localhost:9200/accounts/person/1' -d ' { "user": "张三", "title": "工程师", "desc": "数据库管理" }' </code></pre> </blockquote> <p>服务器返回的 JSON 对象，会给出 Index、Type、Id、Version 等信息。</p> <blockquote> <pre> <code> { "_index":"accounts", "_type":"person", "_id":"1", "_version":1, "result":"created", "_shards":{"total":2,"successful":1,"failed":0}, "created":true } </code></pre> </blockquote> <p>如果你仔细看，会发现请求路径是<code>/accounts/person/1</code>，最后的<code>1</code>是该条记录的 Id。它不一定是数字，任意字符串（比如<code>abc</code>）都可以。</p> <p>新增记录的时候，也可以不指定 Id，这时要改成 POST 请求。</p> <blockquote> <pre> <code> $ curl -X POST 'localhost:9200/accounts/person' -d ' { "user": "李四", "title": "工程师", "desc": "系统管理" }' </code></pre> </blockquote> <p>上面代码中，向<code>/accounts/person</code>发出一个 POST 请求，添加一个记录。这时，服务器返回的 JSON 对象里面，<code>_id</code>字段就是一个随机字符串。</p> <blockquote> <pre> <code> { "_index":"accounts", "_type":"person", "_id":"AV3qGfrC6jMbsbXb6k1p", "_version":1, "result":"created", "_shards":{"total":2,"successful":1,"failed":0}, "created":true } </code></pre> </blockquote> <p>注意，如果没有先创建 Index（这个例子是<code>accounts</code>），直接执行上面的命令，Elastic 也不会报错，而是直接生成指定的 Index。所以，打字的时候要小心，不要写错 Index 的名称。</p> <h3>5.2 查看记录</h3> <p>向<code>/Index/Type/Id</code>发出 GET 请求，就可以查看这条记录。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/1?pretty=true' </code></pre> </blockquote> <p>上面代码请求查看<code>/accounts/person/1</code>这条记录，URL 的参数<code>pretty=true</code>表示以易读的格式返回。</p> <p>返回的数据中，<code>found</code>字段表示查询成功，<code>_source</code>字段返回原始记录。</p> <blockquote> <pre> <code> { "_index" : "accounts", "_type" : "person", "_id" : "1", "_version" : 1, "found" : true, "_source" : { "user" : "张三", "title" : "工程师", "desc" : "数据库管理" } } </code></pre> </blockquote> <p>如果 Id 不正确，就查不到数据，<code>found</code>字段就是<code>false</code>。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/weather/beijing/abc?pretty=true' { "_index" : "weather", "_type" : "beijing", "_id" : "abc", "found" : false } </code></pre> </blockquote> <h3>5.3 删除记录</h3> <p>删除记录就是发出 DELETE 请求。</p> <blockquote> <pre> <code> $ curl -X DELETE 'localhost:9200/accounts/person/1' </code></pre> </blockquote> <p>这里先不要删除这条记录，后面还要用到。</p> <h3>5.4 更新记录</h3> <p>更新记录就是使用 PUT 请求，重新发送一次数据。</p> <blockquote> <pre> <code> $ curl -X PUT 'localhost:9200/accounts/person/1' -d ' { "user" : "张三", "title" : "工程师", "desc" : "数据库管理，软件开发" }' { "_index":"accounts", "_type":"person", "_id":"1", "_version":2, "result":"updated", "_shards":{"total":2,"successful":1,"failed":0}, "created":false } </code></pre> </blockquote> <p>上面代码中，我们将原始数据从"数据库管理"改成"数据库管理，软件开发"。 返回结果里面，有几个字段发生了变化。</p> <blockquote> <pre> <code> "_version" : 2, "result" : "updated", "created" : false </code></pre> </blockquote> <p>可以看到，记录的 Id 没变，但是版本（version）从<code>1</code>变成<code>2</code>，操作类型（result）从<code>created</code>变成<code>updated</code>，<code>created</code>字段变成<code>false</code>，因为这次不是新建记录。</p> <h2>六、数据查询</h2> <h3>6.1 返回所有记录</h3> <p>使用 GET 方法，直接请求<code>/Index/Type/_search</code>，就会返回所有记录。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/_search' { "took":2, "timed_out":false, "_shards":{"total":5,"successful":5,"failed":0}, "hits":{ "total":2, "max_score":1.0, "hits":[ { "_index":"accounts", "_type":"person", "_id":"AV3qGfrC6jMbsbXb6k1p", "_score":1.0, "_source": { "user": "李四", "title": "工程师", "desc": "系统管理" } }, { "_index":"accounts", "_type":"person", "_id":"1", "_score":1.0, "_source": { "user" : "张三", "title" : "工程师", "desc" : "数据库管理，软件开发" } } ] } } </code></pre> </blockquote> <p>上面代码中，返回结果的 <code>took</code>字段表示该操作的耗时（单位为毫秒），<code>timed_out</code>字段表示是否超时，<code>hits</code>字段表示命中的记录，里面子字段的含义如下。</p> <blockquote> <ul> <li><code>total</code>：返回记录数，本例是2条。</li> <li><code>max_score</code>：最高的匹配程度，本例是<code>1.0</code>。</li> <li><code>hits</code>：返回的记录组成的数组。</li> </ul> </blockquote> <p>返回的记录中，每条记录都有一个<code>_score</code>字段，表示匹配的程序，默认是按照这个字段降序排列。</p> <h3>6.2 全文搜索</h3> <p>Elastic 的查询非常特别，使用自己的<a href="/misc/goto?guid=4959751451214671145">查询语法</a>，要求 GET 请求带有数据体。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/_search' -d ' { "query" : { "match" : { "desc" : "软件" }} }' </code></pre> </blockquote> <p>上面代码使用 <a href="/misc/goto?guid=4959751451293588666">Match 查询</a>，指定的匹配条件是<code>desc</code>字段里面包含"软件"这个词。返回结果如下。</p> <blockquote> <pre> <code> { "took":3, "timed_out":false, "_shards":{"total":5,"successful":5,"failed":0}, "hits":{ "total":1, "max_score":0.28582606, "hits":[ { "_index":"accounts", "_type":"person", "_id":"1", "_score":0.28582606, "_source": { "user" : "张三", "title" : "工程师", "desc" : "数据库管理，软件开发" } } ] } } </code></pre> </blockquote> <p>Elastic 默认一次返回10条结果，可以通过<code>size</code>字段改变这个设置。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/_search' -d ' { "query" : { "match" : { "desc" : "管理" }}, "size": 1 }' </code></pre> </blockquote> <p>上面代码指定，每次只返回一条结果。</p> <p>还可以通过<code>from</code>字段，指定位移。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/_search' -d ' { "query" : { "match" : { "desc" : "管理" }}, "from": 1, "size": 1 }' </code></pre> </blockquote> <p>上面代码指定，从位置1开始（默认是从位置0开始），只返回一条结果。</p> <h3>6.3 逻辑运算</h3> <p>如果有多个搜索关键字， Elastic 认为它们是<code>or</code>关系。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/_search' -d ' { "query" : { "match" : { "desc" : "软件 系统" }} }' </code></pre> </blockquote> <p>上面代码搜索的是<code>软件 or 系统</code>。</p> <p>如果要执行多个关键词的<code>and</code>搜索，必须使用<a href="/misc/goto?guid=4959751451394792289">布尔查询</a>。</p> <blockquote> <pre> <code> $ curl 'localhost:9200/accounts/person/_search' -d ' { "query": { "bool": { "must": [ { "match": { "desc": "软件" } }, { "match": { "desc": "系统" } } ] } } }' </code></pre> </blockquote> <h2>七、参考链接</h2> <ul> <li><a href="/misc/goto?guid=4959751451469653717">ElasticSearch 官方手册</a></li> <li><a href="/misc/goto?guid=4959751451560252679">A Practical Introduction to Elasticsearch</a></li> </ul> <p>（完）</p> <p>来自：http://www.ruanyifeng.com/blog/2017/08/elasticsearch.html</p> <p> </p>