热更新 IK 分词使用方法

下载，解压，安装

1、进入https://github.com/medcl/elasticsearch-analysis-ik/，找到ik分词器对应的版本为5.1.1，直接下载其release的版本（避免maven打包）；

2、在/usr/share/elasticsearch/plugins下建立ik目录：

 mkdir /usr/share/elasticsearch/plugins/ik

3、复制文件至elasticsearch的plugins文件夹的ik文件夹下：

 cp  elasticsearch-analysis-ik-5.1.1.zip  /usr/share/elasticsearch/plugins/ik

4.解压文件：

 unzip elasticsearch-analysis-ik-5.1.1.zip

重启 ElasticSearch 即可。

---

分词器：

IK 包含两类分词器：

ik_max_word: 会将文本做最细粒度的拆分，比如会将“中华人民共和国国歌”拆分为“中华人民共和国,中华人民,中华,华人,人民共和国,人民,人,民,共和国,共和,和,国国,国歌”，会穷尽各种可能的组合；
ik_smart: 会做最粗粒度的拆分，比如会将“中华人民共和国国歌”拆分为“中华人民共和国,国歌”。

不同项目可以不同选择，个人是推荐使用【ik_smart】，相对来说分出来的词更符合直观感受。

---

在ES的配置文件config/elasticsearch.yml中增加ik的配置，在最后增加：

    index:  
      analysis:  
        analyzer:  
          ik:  
              alias: [ik_analyzer]  
              type: org.elasticsearch.index.analysis.IkAnalyzerProvider  
          ik_max_word:  
              type: ik  
              use_smart: false  
          ik_smart:  
              type: ik  
              use_smart: true  

或者

index.analysis.analyzer.ik.type : "ik"  

以上两种配置方式的区别：

1. 第二种方式，只定义了一个名为 ik 的 analyzer，其 use_smart 采用默认值 false
2. 第一种方式，定义了三个 analyzer，分别为：ik、ik_max_word、ik_smart，其中 ik_max_word 和
   ik_smart 是基于 ik 这个 analyzer 定义的，并各自明确设置了 use_smart 的不同值。
3. 其实，ik_max_word 等同于 ik。ik_max_word
   会将文本做最细粒度的拆分，比如会将“中华人民共和国国歌”拆分为“中华人民共和国,中华人民,中华,华人,人民共和国,人民,人,民,共和国,共和,和,国国,国歌”，会穷尽各种可能的组合；而
   ik_smart 会做最粗粒度的拆分，比如会将“中华人民共和国国歌”拆分为“中华人民共和国,国歌”。

因此，建议，在设置 mapping 时，用 ik 这个 analyzer，以尽可能地被搜索条件匹配到。
不过，如果你想将 /index_name/_analyze 这个 RESTful API 做为分词器用，用来提取某段文字中的主题词，则建议使用 ik_smart 这个 analyzer。

---

输入命令：

http://localhost:9203/megacorp/_analyze?analyzer=ik_smart&pretty=true&text=中华人民共和国国歌

返回:

{ 
  "tokens" : [ { 
    "token" : "中华人民共和国", 
    "start_offset" : 0, 
    "end_offset" : 7, 
    "type" : "CN_WORD", 
    "position" : 1 
  }, { 
    "token" : "国歌", 
    "start_offset" : 7, 
    "end_offset" : 9, 
    "type" : "CN_WORD", 
    "position" : 2 
  } ] 
} 

另外，可以在 elasticsearch.yml 里加上如下一行，设置默认的 analyzer 为 ik：

index.analysis.analyzer.default.type : "ik" 

curl -XPOST  "http://localhost:9203/megacorp/_analyze?analyzer=ik&pretty=true&text=我是中国人"  

测试结果如下：

{  
tokens: [  
{  
token: text  
start_offset: 2  
end_offset: 6  
type: ENGLISH  
position: 1  
}  
{  
token: 我  
start_offset: 9  
end_offset: 10  
type: CN_CHAR  
position: 2  
}  
{  
token: 中国人  
start_offset: 11  
end_offset: 14  
type: CN_WORD  
position: 3  
}  
{  
token: 中国  
start_offset: 11  
end_offset: 13  
type: CN_WORD  
position: 4  
}  
{  
token: 国人  
start_offset: 12  
end_offset: 14  
type: CN_WORD  
position: 5  
}  
]  
}  

自定义字典

config/ik/IKAnalyzer.cfg.xml

<?xml version="1.0" encoding="UTF-8"?> 
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> 
<properties> 
    <comment>IK Analyzer 扩展配置</comment> 
    <!--用户可以在这里配置自己的扩展字典 --> 
    <entry key="ext_dict">custom/mydict.dic;custom/single_word_low_freq.dic</entry> 
     <!--用户可以在这里配置自己的扩展停止词字典--> 
    <entry key="ext_stopwords">custom/ext_stopword.dic</entry> 
    <!--用户可以在这里配置远程扩展字典 --> 
    <entry key="remote_ext_dict">location</entry> 
    <!--用户可以在这里配置远程扩展停止词字典--> 
    <entry key="remote_ext_stopwords">location</entry> 
</properties> 

热更新 IK 分词使用方法

目前该插件支持热更新 IK 分词，通过上文在 IK 配置文件中提到的如下配置

 <!--用户可以在这里配置远程扩展字典 --> 
    <entry key="remote_ext_dict">location</entry> 
    <!--用户可以在这里配置远程扩展停止词字典--> 
    <entry key="remote_ext_stopwords">location</entry> 

其中 location 是指一个 url，比如 http://yoursite.com/getCustomDict，该请求只需满足以下两点即可完成分词热更新。

该 http 请求需要返回两个头部(header)，一个是 Last-Modified，一个是 ETag，这两者都是字符串类型，只要有一个发生变化，该插件就会去抓取新的分词进而更新词库。
该 http 请求返回的内容格式是一行一个分词，换行符用 \n 即可。
满足上面两点要求就可以实现热更新分词了，不需要重启 ES 实例。

可以将需自动更新的热词放在一个 UTF-8 编码的 .txt 文件里，放在 nginx 或其他简易 http server 下，当 .txt 文件修改时，http server 会在客户端请求该文件时自动返回相应的 Last-Modified 和 ETag。可以另外做一个工具来从业务系统提取相关词汇，并更新这个 .txt 文件。

---

常见问题

1.自定义词典为什么没有生效？
请确保你的扩展词典的文本格式为 UTF8 编码

---

开始使用

先创建名叫【index】的索引：

curl -XPUT http://localhost:9200/index

创建名为【fulltext】的类型，并设定其使用【IK】分词器。这一步很重要，必须在往索引中添加数据前完成

 curl -XPOST http://localhost:9200/index/fulltext/_mapping -d'
    {
        "fulltext": {
                 "_all": {
                "analyzer": "ik_max_word",
                "search_analyzer": "ik_max_word",
                "term_vector": "no",
                "store": "false"
            },
            "properties": {
                "content": {
                    "type": "string",
                    "store": "no",
                    "term_vector": "with_positions_offsets",
                    "analyzer": "ik_max_word",
                    "search_analyzer": "ik_max_word",
                    "include_in_all": "true",
                    "boost": 8
                }
            }
        }
    }'

往索引库中添加数据：

    curl -XPOST http://localhost:9200/index/fulltext/1 -d'{"content":"美国留给伊拉克的是个烂摊子吗"}'
    curl -XPOST http://localhost:9200/index/fulltext/2 -d'{"content":"公安部：各地校车将享最高路权"}'
    curl -XPOST http://localhost:9200/index/fulltext/3 -d'{"content":"中韩渔警冲突调查：韩警平均每天扣1艘中国渔船"}'
    curl -XPOST http://localhost:9200/index/fulltext/4 -d'{"content":"中国驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首"}'

查询测试：

查询语句：

    curl -XPOST http://localhost:9200/index/fulltext/_search  -d'
    {
        "query" : { "term" : { "content" : "中国" }},
        "highlight" : {
            "pre_tags" : ["<tag1>", "<tag2>"],
            "post_tags" : ["</tag1>", "</tag2>"],
            "fields" : {
                "content" : {}
            }
        }
    }
    '

查询结果：

    {
        "took": 14,
        "timed_out": false,
        "_shards": {
            "total": 5,
            "successful": 5,
            "failed": 0
        },
        "hits": {
            "total": 2,
            "max_score": 2,
            "hits": [
                {
                    "_index": "index",
                    "_type": "fulltext",
                    "_id": "4",
                    "_score": 2,
                    "_source": {
                        "content": "中国驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首"
                    },
                    "highlight": {
                        "content": [
                            "<tag1>中国</tag1>驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首 "
                        ]
                    }
                },
                {
                    "_index": "index",
                    "_type": "fulltext",
                    "_id": "3",
                    "_score": 2,
                    "_source": {
                        "content": "中韩渔警冲突调查：韩警平均每天扣1艘中国渔船"
                    },
                    "highlight": {
                        "content": [
                            "均每天扣1艘<tag1>中国</tag1>渔船 "
                        ]
                    }
                }
            ]
        }
    }