【热更新IK词典】ElasticSearch IK 自动热更新原理与实现

一、热更新原理

　　elasticsearch开启加载外部词典功功能后，会每60s间隔进行刷新字典。具体原理代码如下所示：

public void loadDic(HttpServletRequest req,HttpServletResponse response){
    String eTag =req.getParameter("If-None-Match");
    try {
        OutputStream out= response.getOutputStream();
        List<String> list=new ArrayList<String>();
        list.add("中华人民共和国");
        list.add("我爱你爱我");
        String oldEtag = list.size() + "";
        StringBuffer sb=new StringBuffer();
        if (oldEtag != eTag) {
            for (String str : list) {
                if(StringUtils.isNotBlank(str)){
                    sb.append("\r\n");
                }
                sb.append(str+"\r\n");
            }
        }
        String data=sb.toString();

        response.setHeader("Last-Modified", String.valueOf(list.size()));
        response.setHeader("ETag",String.valueOf(list.size()));
        response.setContentType("text/plain; charset=gbk");
        out.write(data.getBytes());
        out.flush();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

二、配置说明

　　我们公司以及用户常用的分词器为 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">http://xxx.com/xxx.dic</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)

　　1. 一个是 Last-Modified，

　　2. 一个是 ETag

　　这两者都是字符串类型，只要有一个发生变化，该插件就会去抓取新的分词进而更新词库。
　　该 http 请求返回的内容格式是一行一个分词，换行符用 \n 即可。

　　满足上面两点要求就可以实现热更新分词了，不需要重启 ES 实例。还需要注意的是获取词典的url，必须支持head访问

下面自己做的访问远程扩展词典的web api 服务接口（这一步可以直接忽略，看第三个即可，这里只是想说明也可以使用下面这种方式）

[HttpHead, HttpGet, HttpPost]
public async Task<HttpResponseMessage> GetDictionary(string path)
{
    var response = this.Request.CreateResponse(HttpStatusCode.OK);
    var content = File.ReadAllText(path);
    response.Content = new StringContent(content, Encoding.UTF8);
    response.Headers.Age = TimeSpan.FromHours(1);
    response.Headers.ETag = EntityTagHeaderValue.Parse($"\"{content.ToMD5()}\"");
    return response;
}

三、Tomcat 服务器自动更新

　1、部署http服务

　　在这使用 tomcat8 作为 web 容器，先下载一个 tomcat8.5.16，然后上传到某一台服务器上(192.168.80.100)。

　　再执行以下命令

tar -zxvf apache-tomcat-8.5.16.tar.gz
cd apache-tomcat-8.5.16/webapp/ROOT
vim hot_ext.dic<br>智能移动机器人<br>vim hot_stopwords.dic<br>项目

　　之后验证一下这个文件是否可以正常访问   http://192.168.80.100:8080/hot.dic

　　通过tomcat访问词典，可以在不停用tomcat的情况下直接更新词典

　2、修改ik插件的配置文件

　　修改 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">http://192.168.80.100:8080/hot_ext.dic</entry>
    <!--用户可以在这里配置远程扩展停止词字典-->
    <entry key="remote_ext_stopwords">http://192.168.80.100:8080/hot_stopwords.dic</entry>
</properties>

3、验证

　　重启es，会看到如下日志信息，说明远程的词典加载成功了。

　　

　　在浏览器中输入如下命令：http://localhost:9200/patent/_analyze?analyzer=ik_smart&text=智能移动机器人

　　正常情况下会分出很多次，这次发现只有这一个词，不会被分词，说明刚才配置远程的词库生效了，那么我们再换一个：北京雾霾，正常情况下可能会被分成两个词：北京、雾霾，如果我直接修改 tomcat 下的 hot_ext.dic 词库文件，增加一个关键词：北京雾霾，文件保存之后，查看es的日志会看到如下日志信息：

　　

　　此时，再执行下面命令查看分词效果：http://localhost:9200/patent/_analyze?analyzer=ik_smart&text=北京雾霾

　　结果就是只有一个词，不会被分词了。

　　到这为止，可以实现动态添加自定义词库实现词库热更新。~~

代码实现

1.首先将di词典放在tomcat目录下

2.通过url读取配置文件

    /**
     * @Description 加载远程词典内容
     * @param menuId 菜单id
     * @param request http请求
     * @return String 词典内容*/
    @RequestMapping(value = "/loadDictionary", produces = "text/html;charset=UTF-8")
    @ResponseBody
    public String loadDictionary(Integer menuId, HttpServletRequest request) {
        String filePath = getFilePath(request);
        String context = readDictionary(filePath);
        return context;
    }

    /**
     * @Description 获取词典路径
     * @param request HTTP请求
     * @return String 词典路径*/
    private String getFilePath(HttpServletRequest request) {
        return "http://" + request.getServerName() + ":" + request.getServerPort() + "/" + "RemoteDictionary.dic";
    }

    /**
     * @Description 读取远程词典
     * @param filePath 词典路径
     * @return String 词典内容*/
    private String readDictionary(String filePath) {
        StringBuffer document = new StringBuffer();
        try {
            URL url = new URL(filePath);
            URLConnection conn = url.openConnection();
            BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
            String line = null;
            while ((line = reader.readLine()) != null) {
                document.append(line + System.getProperty("line.separator"));
            }
            reader.close();
        } catch (MalformedURLException e) {
            System.out.println("Unable to connect to URL: " + filePath);
        } catch (IOException e) {
            System.out.println("IOException when connecting to URL: " + filePath);
        }
        return document.toString();
    }

3.将修改好的词典内容保存

    /**
     * @Description 保存词典
     * @param menuId 菜单id
     * @param context 词典内容
     * @param request HTTP请求
     * @return boolean 是否成果能够*/
    @RequestMapping(value = "/saveDictionary")
    @ResponseBody
    public boolean saveDictionary(Integer menuId, String context, HttpServletRequest request) {　　　　 //获取tomcat的路径
        String filePath = System.getProperty("catalina.home")+"\\webapps\\ROOT\\RemoteDictionary.dic";
        boolean result = writeDictionary(filePath, context);
        return result;
    }

    /**
     * @Description 上传词典
     * @param filePath 词典路径
     * @param content 修改的内容
     * @return boolean 是否上传成功*/
    private boolean writeDictionary(String filePath, String content) {
        try {
            File f = new File(filePath);
            if (!f.exists()) {
                return false;
            }
            OutputStreamWriter write = new OutputStreamWriter(new FileOutputStream(f), "UTF-8");
            BufferedWriter writer = new BufferedWriter(write);
            writer.write(content);
            writer.close();
            return true;
        } catch (Exception e) {
            return false;
        }
    }