Xunsearch (中文名:迅搜)是一套免费开源的专业中文全文检索解决方案,简单易用而且性能卓越能轻松处理海量数据的全文检索。它包含后端索引、搜索服务程序和前端脚本语言编写的开发工具包(称之为 SDK) 。本人看来,讯搜底层采用 C/C++ 编写,性能上不用怀疑,说到功能强大嘛。。恩,先保留着吧(毕竟现在有个如日中天的Elasticsearch),迅搜对比起es虽然功能上着实不够看,且分布式支持方面也不怎么样,客户端也主要面向PHP。。但凡是也有例外,在资源占用低和容易上手方面还是有一定突出优势的(es在资源使用方面就是个吃货呀),可以作为其他搜索引擎如es、solr等的补充。在此,总结一下迅搜的一些简单用法。
1。安装
建议使用centos,其他的debian类系统也行,在下也用deepin装过,被两个依赖虐了半天,记得是因为我的系统openssl软件版本高了,要卸了装个低一点的,哎,不提了。
步骤:
wget http://www.xunsearch.com/download/xunsearch-full-latest.tar.bz2
tar -xjf xunsearch-full-latest.tar.bz2
cd xunsearch-full-1.3.0/
sh setup.sh
装完后,cd 到你的安装目录里(一般是/usr/local/xunsearch) ,运行 bin/xs-ctl.sh restart 就OK了。
2.PHP-sdk
安装目录里有个叫sdk的,如下:
直接拿过来放到你的项目里吧。
如果您的搜索应用程序和 xunsearch 在同一台服务器,则无需复制任何代码,在开发的时候直接包含 入口文件 $prefix/sdk/php/lib/XS.php 即可。代码如下:
require_once '$prefix/sdk/php/lib/XS.php';
$prefix 是你的项目目录。
3.创建配置文件,导入数据
vim $prefix/sdk/php/app/demo.ini (这创建了个demo索引文件),默认连接本地的8383/8384端口并使用urf8编码,包含 id,category_id,name,content,addtime 5个字段。
索引文件代码
导入 MySQL 数据库的 dbname.tbl_post 表到 demo 项目中,并且平滑重建
Indexer.php --rebuild --source=mysql://root:s2mptBWWtpThaTR7@localhost/dbname --sql="SELECT * FROM tbl_post" --project= demo
这里屏幕会提示如下信息,表示完成数据提交:
INFO: reach end of file or error occured, total lines: 3
完成索引导入:成功 3 条,失败 0 条
刷新索引提交 ...
索引数据的提交是异步行为,所以录完数据并不是立刻就能检索到(当然,这个时间差也不会太大)。 所以为稳定起见请稍等几秒再进行下一步的搜索测试。
4. 写代码
1)添加文档
$data = array(
'id' => 234, // 此字段为主键,必须指定
‘category_id’ =》6, //可用于聚合搜索
'name' => '测试文档的标题',
'content' => '测试文档的内容部分',
'addtime' => time()
);
// 创建文档对象,
$doc = new XSDocument;
$doc->setFields($data);
// 添加到索引数据库中$index->add($doc);
2)修改文档
$data = array(
'id' => 234, // 此字段为主键,是进行文档替换的唯一标识
'name' => '测试文档的标题',
'content' => '测试文档的内容部分',
'addtime' => time());
// 创建文档对象,
$doc = new XSDocument;
$doc->setFields($data);
// 更新到索引数据库中,
$index->update($doc);
3)删除文档
$index->del('123'); // 删除主键值为 123 的记录
$index->del(array('123', '789', '456'));
// 同时删除主键值为 123, 789, 456 的记录
4)搜索
流程:
构建搜索查询语句 query,然后调用 XSSearch::setQuery 设定它,根据需要设置附加的查询条件:通过 XSSearch::addWeight 干扰排名权重; 通过 XSSearch::addRange 添加字段搜索区间或范围; 通过 XSSearch::setFuzzy 开启模糊匹配,以获取更多搜索结果;进行必要的搜索结果限定:通过 XSSearch::setLimit 设置搜索结果数量和偏移;通过 XSSearch::setSort 设置搜索结果的排序方式,等等。执行搜索,并获取搜索结果,关于搜索结果的处理详见后面的章节
代码如下:
$query = '项目测试'; // 这里的搜索语句很简单,就一个短语
$search->setQuery($query); // 设置搜索语句
$search->addWeight('subject', 'xunsearch'); // 增加附加条件:提升标题中包含 'xunsearch' 的记录的权重
$search->setLimit(5, 10); // 设置返回结果最多为 5 条,并跳过前 10 条
$docs = $search->search(); // 执行搜索,将搜索结果文档保存在 $docs 数组中$count = $search->count(); // 获取搜索结果的匹配总数估算值
搜索中的串联操作:
$docs = $search->setQuery('项目测试')->addWeight('subject', 'xunsearch')->setLimit(5, 10)->search();
构建搜索语句:
搜索语句举例如下:
$search->search('上海人民公园'); // 检索 body 型字段及混合区
$search->search('上海 人民公园'); // 用空格连接 2 个关键词, 这种情况比上面的用法更明确
$search->search('subject:上海 人民公园'); // 特别要求 subject 字段包含 "上海"
$search->setFuzzy()->search('上海公园'); // 开启模糊搜索,搜索 "上海" 或 "公园"
多个词语之间的“并且”、“或者”、“异或”关系
默认情况,系统采用“并且”关系,即您输入的多个词语(空格分开或系统自动切分以后)必须全部包含。 您也可以通过 AND 将这些关键词显式的强制要求全部出现。相应的,如果您需要只包括其中一个词即可, 那么用 OR 将它们连接起来。更有趣的是,如果有些情况您只想要其中的一个词,并且不要两者同时出现, 那么就用 XOR 连接。参看下面的例子:
Note: 表达布尔关系的关键字必须全部大写,即:XOR, OR, AND
$search->search('杭州 西湖');
$search->search('杭州 AND 西湖'); // 这两者效果是相同的
$search->setFuzzy()->search('杭州 西湖');
$search->search('杭州 OR 西湖'); // 这两者效果相同,都是只要求匹配其中一个
要求搜索结果中不含特定关键词
如果您发现搜索结果中,有某一类信息是您不希望看见的,而且这些信息都包含特定的关键词,那么请用减号或 NOT 语法,就可以去除所有这些含有特定关键词的网页。例如,搜索 “神雕侠侣”,希望是关于武侠小说方面 的内容,却发现很多关于电视剧方面的网页。这时希望排除所有包含“电视剧”的搜索结果。
Note: 前一个关键词和减号之间必须有空格分开,否则会被当连字符处理,减号和后一个关键词之间不能有空格。
$search->search('神雕侠侣 -电视剧'); // 正确用法1
$search->search('神雕侠侣 NOT 电视剧'); // 正确用法2
$search->search('神雕侠侣-电视剧'); // 不符合预期目的
$search->search('神雕侠侣 - 电视剧'); // 不符合预期目的
$search->search('杭州 XOR 西湖'); // 表示必须包含其中一个词,并且不允许同时包含这两个词。
这里就不再累述了,更多的请看
http://www.xunsearch.com/doc/php/guide/search.query
最后送上一个自己封装的小函数:
//搜索名称函数,包含分页,限制数量,排序,字段值区间搜索
function demo_xun($name ='',$limit=6,$p = 1,$sort=[],$range=[]){
// include '/usr/local/xunsearch/sdk/php/lib/XS.php'; //如果找不到迅搜对象可以打开这句
$xs = new \XS('demo');
$search = $xs->search;
$search->setCharset('UTF-8');
$search->setFuzzy();
$search->setQuery($name);
if(!empty($sort)){
$search->setMultiSort($sort);
}
if($p!=1){
$p = max(1, intval($p));
$search->setLimit($limit, ($p - 1) * $limit);
}else{
$search->setLimit($limit);
}
if(empty($range)){
$info = $search->search();
}else{
$info = $search->addRange($range[0], $range[1], $range[2])->search();
}
$data = [];
if($info){
foreach($info as $v){
$data[] = [
'id'=>$v->id,
'category_id'=>$v->category_id,
'name'=>$v->name,
'content'=>$v->content,
'addtime'=>$v->addtime
];
}
}
return $data;
}
至此,迅搜的基本操作就介绍得差不多了,以后还会有其他技术笔记分享给大家,请期待。