I-team 博客全文检索 Elasticsearch 实战

发布日期:2019-09-06

一直觉得博客缺点东西,最近还是发现了,当博客慢慢多起来的时候想要找一篇之前写的博客很是麻烦,于是作为后端开发的楼主觉得自己动手丰衣足食,也就有了这次博客全文检索功能Elasticsearch实战,这里还要感谢一下‘辉哥’赞助的一台服务器。

全文检索工具选型

众所周知,支持全文检索的工具有很多,像 Lucene,solr, Elasticsearch 等,相比于其他的工具,显然 Elasticsearch 社区更加活跃,遇到问题相对来说也比较好解决,另外 Elasticsearch 提供的restful接口操作起来还是比较方便的,这也是楼主选择 Elasticsearch 的重要原因,当然 Elasticsearch 占据的内存相对来说比较大一点,楼主2G的云服务器跑起来也是捉襟见肘。

数据迁移,从 MySQL 到 Elasticsearch

这个功能相对来说比较简单,就是定时从 MySQL 更新数据到 Elasticsearch 中,本来楼主打算自己写一个数据迁移的工具,但是想起之前楼主做数据迁移时用到的DataX很是不错,看了写官方文档还是支持的,但是楼主硬是没有跑起来,原因就是楼主2G内存的云服务器不够使啊,DataX光是跑起来就要1G多的内存,所以楼主只能另谋它法。对DataX感兴趣的小伙伴可以看看楼主的另一篇文章阿里离线数据同步工具 DataX 踩坑记录。

说起可以省内存的语言,小伙伴可能会想到最近比较火的golang,没错楼主也想到了。最后楼主使用的就是一个叫go-mysql-elasticsearch的工具,就是使用golang实现的从 MySQL 将数据迁移到 Elasticsearch 的工具。具体搭建过程楼主不在这里细说,感兴趣的小伙伴请移步go-mysql-elasticsearch,另外 Elasticsearch 环境的搭建,需要注意的就是安装 Elasticsearch 的机器内存应该大于或者等于2G,否则可能会出现起不起来的情况,楼主也不在这里赘述了,比较简单,请小伙伴们自行google。

另外需要注意的是,在使用 go-mysql-elasticsearch 的时候应该开启mysql的binlog功能,go-mysql-elasticsearch的实现同步数据的思想就是将自己作为MySQL的一个slave挂载在MySQL上,这样就可以很轻松的将数据实时同步到 Elasticsearch 中,在启动 go-mysql-elasticsearch 的机器上最少应该有MySQL client工具,否则会启动报错。楼主的建议是根MySQL部署在同一台机器上,因为golang耗费内存极少,并不会有太大影响。下面给出楼主同步数据时 go-mysql-elasticsearch 的配置文件:

# MySQL address user and password# user must have replication privilege in MySQL.my_addr = "127.0.0.1:3306"my_user = "root"my_pass = "******"my_charset = "utf8"# Set true when elasticsearch use https#es_https = false# Elasticsearch addresses_addr = "127.0.0.1:9200"# Elasticsearch user and password maybe set by shield nginx or x-packes_user = ""es_pass = ""# Path to store data like master.info if not set or empty# we must use this to support breakpoint resume syncing.# TODO: support other storage like etcd.data_dir = "./var"# Inner Http status addressstat_addr = "127.0.0.1:12800"# pseudo server id like a slaveserver_id = 1001# mysql or mariadbflavor = "mysql"# mysqldump execution path# if not set or empty ignore mysqldump.mysqldump = "mysqldump"# if we have no privilege to use mysqldump with --master-data# we must skip it.#skip_master_data = false# minimal items to be inserted in one bulkbulk_size = 128# force flush the pending requests if we don"t have enough items >= bulk_sizeflush_bulk_time = "200ms"# Ignore table without primary keyskip_no_pk_table = false# MySQL data source[[source]]schema = "billboard-blog"# Only below tables will be synced into Elasticsearch.tables = ["content"]# Below is for special rule mapping[[rule]]schema = "billboard-blog"table = "content"index = "contentindex"type = "content"[rule.field]title="title"blog_desc="blog_desc"content="content"# Filter rule[[rule]] schema = "billboard-blog" table = "content" index = "contentindex" type = "content"# Only sync following columnsfilter = ["title" "blog_desc" "content"]# id rule[[rule]] schema = "billboard-blog" table = "content" index = "contentindex" type = "content" id = ["id"]

实现全文检索功能的服务

要想实现全文检索的功能并对外提供服务,web服务必不可少,楼主使用Spring Boot搭建web服务,对Spring Boot感兴趣的小伙伴也可以看一下楼主的另一篇文章,使用Spring Boot实现博客统计服务。好了废话不多说了,请看代码

接口实现代码,代码比较简单就是接收参数,调用service代码

@ApiOperation(value="全文检索接口" notes="") @ApiImplicitParam(name = "searchParam" value = "博客搜索条件(作者,描述,内容,标题)" required = true dataType = "String") @RequestMapping(value = "/get_content_list_from_es" method = RequestMethod.GET) public ResultCode<List<ContentsWithBLOBs>> getContentListFromEs(String searchParam) { ResultCode<List<ContentsWithBLOBs>> resultCode = new ResultCode() try { LOGGER.info(">>>>>> method getContentListFromEs request params : {}{},{}"searchParam) resultCode = contentService.getContentListFromEs(searchParam) LOGGER.info(">>>>>> method getContentListFromEs return value : {}"JSON.toJSONString(resultCode)) } catch (Exception e) { e.printStackTrace() resultCode.setCode(Messages.API_ERROR_CODE) resultCode.setMsg(Messages.API_ERROR_MSG) } return resultCode }

service代码实现,这里代码主要功能就是调用es的工具类,对博客描述,作者,博客标题,博客内容进行全文检索。

@Override public ResultCode<List<ContentsWithBLOBs>> getContentListFromEs(String searchParam) { ResultCode resultCode = new ResultCode() // 校验参数,参数不能为空 if (StringUtils.isBlank(searchParam)) { LOGGER.info(">>>>>> params not be null") resultCode.setMsg(Messages.INPUT_ERROR_MSG) resultCode.setCode(Messages.INPUT_ERROR_CODE) return resultCode } String matchStr = "blog_desc=" + searchParam List<Map<String Object>> result = ElasticsearchUtils.searchListData(BillboardContants.ES_CONTENT_INDEXBillboardContants.ES_CONTENT_TYPEBillboardContants.ES_CONTENT_FIELDtruematchStr) matchStr = "author=" + searchParam result.addAll(ElasticsearchUtils.searchListData(BillboardContants.ES_CONTENT_INDEXBillboardContants.ES_CONTENT_TYPEBillboardContants.ES_CONTENT_FIELDtruematchStr)) matchStr = "title=" + searchParam result.addAll(ElasticsearchUtils.searchListData(BillboardContants.ES_CONTENT_INDEXBillboardContants.ES_CONTENT_TYPEBillboardContants.ES_CONTENT_FIELDtruematchStr)) matchStr = "content=" + searchParam result.addAll(ElasticsearchUtils.searchListData(BillboardContants.ES_CONTENT_INDEXBillboardContants.ES_CONTENT_TYPEBillboardContants.ES_CONTENT_FIELDtruematchStr)) List<ContentsWithBLOBs> data = JSON.parseArray(JSON.toJSONString(result)ContentsWithBLOBs.class) LOGGER.info("es return data : {}"JSON.toJSONString(result)) resultCode.setData(data) return resultCode }

楼主用到的es的工具类代码实现,就是使用es的java客户端对es进行检索。

/** * 使用分词查询 * * @param index 索引名称 * @param type 类型名称可传入多个type逗号分隔 * @param fields 需要显示的字段,逗号分隔(缺省为全部字段) * @param matchPhrase true 使用,短语精准匹配 * @param matchStr 过滤条件(xxx=111aaa=222) * @return */ public static List<Map<String Object>> searchListData(String index String type String fields boolean matchPhrase String matchStr) { return searchListData(index type 0 0 null fields null matchPhrase null matchStr) } /** * 使用分词查询 * * @param index 索引名称 * @param type 类型名称可传入多个type逗号分隔 * @param startTime 开始时间 * @param endTime 结束时间 * @param size 文档大小限制 * @param fields 需要显示的字段,逗号分隔(缺省为全部字段) * @param sortField 排序字段 * @param matchPhrase true 使用,短语精准匹配 * @param highlightField 高亮字段 * @param matchStr 过滤条件(xxx=111aaa=222) * @return */ public static List<Map<String Object>> searchListData(String index String type long startTime long endTime Integer size String fields String sortField boolean matchPhrase String highlightField String matchStr) { SearchRequestBuilder searchRequestBuilder = client.prepareSearch(index) if (StringUtils.isNotEmpty(type)) { searchRequestBuilder.setTypes(type.split("")) } BoolQueryBuilder boolQuery = QueryBuilders.boolQuery() if (startTime > 0 && endTime > 0) { boolQuery.must(QueryBuilders.rangeQuery("processTime") .format("epoch_millis") .from(startTime) .to(endTime) .includeLower(true) .includeUpper(true)) } //搜索的的字段 if (StringUtils.isNotEmpty(matchStr)) { for (String s : matchStr.split("")) { String[] ss = s.split("=") if (ss.length > 1) { if (matchPhrase == Boolean.TRUE) { boolQuery.must(QueryBuilders.matchPhraseQuery(s.split("=")[0] s.split("=")[1])) } else { boolQuery.must(QueryBuilders.matchQuery(s.split("=")[0] s.split("=")[1])) } } } } // 高亮(xxx=111aaa=222) if (StringUtils.isNotEmpty(highlightField)) { HighlightBuilder highlightBuilder = new HighlightBuilder() //highlightBuilder.preTags("<span style="color:red" >")//设置前缀 //highlightBuilder.postTags("</span>")//设置后缀 // 设置高亮字段 highlightBuilder.field(highlightField) searchRequestBuilder.highlighter(highlightBuilder) } searchRequestBuilder.setQuery(boolQuery) if (StringUtils.isNotEmpty(fields)) { searchRequestBuilder.setFetchSource(fields.split("") null) } searchRequestBuilder.setFetchSource(true) if (StringUtils.isNotEmpty(sortField)) { searchRequestBuilder.addSort(sortField SortOrder.DESC) } if (size != null && size > 0) { searchRequestBuilder.setSize(size) } //打印的内容 可以在 Elasticsearch head 和 Kibana 上执行查询 LOGGER.info("{}" searchRequestBuilder) SearchResponse searchResponse = searchRequestBuilder.execute().actionGet() long totalHits = searchResponse.getHits().totalHits long length = searchResponse.getHits().getHits().length LOGGER.info("共查询到[{}]条数据处理数据条数[{}]" totalHits length) if (searchResponse.status().getStatus() == 200) { // 解析对象 return setSearchResponse(searchResponse highlightField) } return null }

最后,楼主使用postman测试web服务,如下图所示:

过程中遇到的坑

IK分词器的设置

这里需要注意的是,Elasticsearch的版本一定要与ik分词器的版本对应,不对应的话 Elasticsearch 会报错的。

$ ./bin/elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v6.3.0/elasticsearch-analysis-ik-6.3.0.zip

接着,重新启动 Elastic,就会自动加载这个新安装的插件。

然后,新建一个 Index,指定需要分词的字段。这一步根据数据结构而异,下面的命令只针对本文。基本上,凡是需要搜索的中文字段,都要单独设置一下。

$ curl -X PUT "localhost:9200/contentindex" -H "Content-Type: application/json" -d "{ "mappings": { "content": { "properties": { "content": { "type": "text" "analyzer": "ik_max_word" "search_analyzer": "ik_max_word" } "title": { "type": "text" "analyzer": "ik_max_word" "search_analyzer": "ik_max_word" } "blog_desc": { "type": "text" "analyzer": "ik_max_word" "search_analyzer": "ik_max_word" } "author": { "type": "text" "analyzer": "ik_max_word" "search_analyzer": "ik_max_word" } } } }}"

上面代码中,首先新建一个名称为contentindex的 Index,里面有一个名称为content的 Type。content有好多个字段,这里只为其中四个字段指定分词,contenttitleblog_descauthor

这四个字段都是中文,而且类型都是文本(text),所以需要指定中文分词器,不能使用默认的英文分词器。

MySQL binlog的设置

因为楼主运行 go-mysql-elasticsearch 的时候使用的MySQL的客户端跟要导出数据的MySQL server端的版本不一致导致报错,最终在 go-mysql-elasticsearch 原作者的帮助下解决,所以一定要使用同版本的MySQL server 与client,因为不同版本的MySQL特性不一样,也就导致了 go-mysql-elasticsearch 导出数据有略微的不同。

小结

整个过程相对来说比较简单,当然楼主通过这个功能的实现,也对es有了一个相对的认识,学习了一项新的技能,可能有的小伙伴对楼主的整个工程的代码比较感兴趣,暂时先不能透露,等楼主完善好了一并贡献出来。

参考文章

戳这里,欢迎光临小站 -_-全文搜索引擎 Elasticsearch 入门教程