GoFly快速开发框架集成ZincSearch全文搜索引擎-Zinc是Elasticsearch轻量级替代

前言

我们在项目开发中会遇到如下业务场景：

1. 电子商务：实现商品搜索与推荐、价格监控。
2. 日志分析：进行系统日志分析和网络流量监控。
3. 社交媒体：内容搜索与发现以及用户行为分析。
4. 企业知识管理：进行知识搜索与共享和文档版本管理。
5. 新闻媒体：实现新闻搜索与推荐以及热点话题追踪。
6. 金融领域：进行金融资讯搜索和风险监控预警。
7. 医疗领域：病历管理与检索以及医学文献搜索研究。

我们需要从海量的数据中快速找到需要的内容，如果我们用Mysql等数据库来处理处理复杂条件查询的方式的话，因为只能通过一个索引进行过滤，所以需要进行大量的 I/O 操作来读取行数据，并消耗 CPU 进行内存过滤，导致查询性能的下降。而且mysql数据库没有像全文搜索引擎为我们集成好分词器、高亮搜索等功能，如果使用mysql数据库我们需要自己开发好分词器、高亮搜索等功能，费时不说还有性能问题也是很影响应用使用体验。所以我们在需要对文本内容搜索时，需要使用到搜索和分析引擎。

说到搜索引擎大家可能就想到Elasticsearch（简称ES）,虽然 Elasticsearch 是一款出色的产品，但它很复杂，需要大量资源，并且已有十多年的历史，它包太大（约1G），他是Java开发的安装需要配置JVM运行环境。所以我们就不用他了，我们选用一个用Go语言开发的轻量级ZincSearch 全文索引的搜索引擎，与 Elasticsearch 相比，它操作起来很简单，Elasticsearch 需要几十个 knobs 来理解和调整，你可以在 2 分钟内启动并运行，ZincSearch安装和运行都是单个二进制文件，二进制文件适用于多个平台的发行版，不需配置运行环境，运行内存不到 100 MB 的 RAM 。并且ZincSearch开发一套兼容Elasticsearch 的API，方便Elasticsearch 迁移到 Zinc 的应用。

ZincSearch特点：

• 无模式索引
• 资源利用率低
• 用于查询用 Vue 编写的数据的 Web UI
• 内置身份验证
• 用于编程使用的简单 API
• 与希望从 Elasticsearch 迁移到 Zinc 的应用程序兼容的 Elasticsearch API（单条记录和批量 API）。

ZincSearch使用文档

ZincSearch官方文档只有英文版，英文文档地址：https://zincsearch-docs.zinc.dev ，为了方便我们使用，GoFly社区把它翻译成中文并对使用相关内容进行补全，也是让大家能有个全面使用参考文档，帮助大家开发效率，这是我们翻译及gofly框架集成完善的文档：ZincSearch中文开发文档开发文档中我们对官方翻译同时结合开发实战得出经验结果对文档内容修改补全，并把实战示例代码也附到文档中，因此ZincSearch中文开发文档 可以更好指导开发。

GoFly框架对ZincSearch集成

如果你是在使用我们的GoFly快速开发框架，你可以更加简单 容易的使用ZincSearch了，我们把它封装成一个组件包，可以像使用ORM链式操作mysql一样使用ZincSearch，统一了代码风格可以提高开发效率和降低维护成本。

快速使用ZincSearch插件

在你安装好gofly快速开发框架后登录到管理后台，到开发者工具->代码仓，找到“Zinc全文搜索引擎”代码包进行安装，安装好后到数据中心->配置管理 找到ZincSearch配置项，把ZincSearch的账号、密码、访问路径配置好就可以使用了。

gofly框架在业务开发位置调用很简单，在import中引入gofly/utils/plugin扩展。

• 在使用的位置引入插件

引入代码如下：

import (
  "gofly/utils/plugin"
)

• 调用方法

 调用代码格式：plugin.ZincSearch().xx().方法()，例如： 

res, err := plugin.ZincSearch().Index().Insert("indexname", "fields")

使用时索引的添加、更新、删除、获取索引列表，文档数据的添加、更新、删除以及搜索使用直接到开发文档：GoFly框架使用ZincSearch文档说明 文档写的很详细，开发是复制示例代码过来改参数即可。

实例代码

把我们测试用的示例代码ZincSearch.go完整代码提供给大家做个参考，GoFly框架使用完整代码如下：

package createcode

import (
	"gofly/utils/gf"
	"gofly/utils/plugin"
)

// 测试ZincSearch全文搜索引擎接口
type ZincSearch struct{}

func init() {
	fpath := ZincSearch{}
	gf.Register(&fpath, fpath)
}

// 添加索引
func (api *ZincSearch) AddIndex(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	res, err := plugin.ZincSearch().Index().Insert(gf.String(param["name"]), param["fields"])
	if err != nil {
		gf.Failed().SetMsg("添加索引失败").SetData(err).Regin(c)
		return
	}
	gf.Success().SetMsg("添加索引成功").SetData(res).Regin(c)
}

// 获取索引
func (api *ZincSearch) GetList(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	list, err := plugin.ZincSearch().Index().Page(1, 10).FindName(gf.String(param["name"])).List()
	if err != nil {
		gf.Failed().SetMsg("添加索引失败").SetData(err).Regin(c)
		return
	}
	gf.Success().SetMsg("添加索引成功").SetData(list).Regin(c)
}

// 添加文档数据
func (api *ZincSearch) AddDoc(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	res, err := plugin.ZincSearch().Doc().Insert(gf.String(param["name"]), param["data"])
	if err != nil {
		gf.Failed().SetMsg(err.Error()).Regin(c)
		return
	}
	gf.Success().SetMsg("添加文档数据成功").SetData(res).Regin(c)
}

// 更新文档数据
func (api *ZincSearch) UpdateDoc(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	res, err := plugin.ZincSearch().Doc().Update(gf.String(param["name"]), param["id"], param["data"])
	if err != nil {
		gf.Failed().SetMsg(err.Error()).Regin(c)
		return
	}
	gf.Success().SetMsg("更新文档数据成功").SetData(res).Regin(c)
}

// 删除文档数据
func (api *ZincSearch) DelDoc(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	res, err := plugin.ZincSearch().Doc().Del(gf.String(param["name"]), param["id"])
	if err != nil {
		gf.Failed().SetMsg(err.Error()).Regin(c)
		return
	}
	gf.Success().SetMsg("删除文档数据成功").SetData(res).Regin(c)
}

// 测试api搜索
func (api *ZincSearch) ApiSearch(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	res, err := plugin.ZincSearch().Search().SetForm(0).SetSize(20).Highligh(gf.String(param["seachword"]), "title", "web")
	if err != nil {
		gf.Failed().SetMsg("测试api搜索失败").SetData(err).Regin(c)
		return
	}
	gf.Success().SetMsg("测试api搜索成功").SetData(res).Regin(c)
}

// 测试es搜索
func (api *ZincSearch) EsSearch(c *gf.GinCtx) {
	param, _ := gf.RequestParam(c)
	res, err := plugin.ZincSearch().EsSearch().SetSize(3).SetFields("title,content").Base(gf.String(param["seachword"]), "title,content", "web")
	if err != nil {
		gf.Failed().SetMsg("测试es搜索失败").SetData(err).Regin(c)
		return
	}
	gf.Success().SetMsg("测试es搜索成功").SetData(res).Regin(c)
}

// 测试http请求
func (api *ZincSearch) HttpZinc(c *gf.GinCtx) {
	data := `{
			"from": 0,
			"size": 10,
			"query":{
				"multi_match":{
					"query":"复仇者",
					"fields":["title","content"]
				}
			},
			"highlight": {
				"fields": {
					"title":{},
					"content":{}
				}
			}
		}`
	res, _ := gf.RequestHttp("POST", "http://localhost:4080/es/web/_search", data, gf.MapStrStr{"Content-Type": "application/json", "Authorization": "Basic YWRtaW46MTIzNDU2"})
	gf.Success().SetMsg("测试http请求").SetData(res).Regin(c)
}

如果你用的ZincSearch，但没有安装GoFly开始开发框架后台，那么你先到：GoFly全栈开发社区 下载安装框架，安装使用GoFly快速开发框架请参考框架对应文档，文档就在框架介绍那里，直接点击进出查看。好了ZincSearch搜索引擎使用就介绍到这里。