WindSearch:为PHP项目零负担提速的纯PHP全文检索引擎 是否为PHP网站添加站内搜索功能而烦恼?复杂的配置与消耗内存的守护进程是否让您望而却步?这里有一个更清爽的解决方案。 本文将介绍的WindSearch,是一个基于中文分词、纯PHP开发的全文检索引擎。其核心特点是“无感集成”:无需繁
是否为PHP网站添加站内搜索功能而烦恼?复杂的配置与消耗内存的守护进程是否让您望而却步?这里有一个更清爽的解决方案。
本文将介绍的WindSearch,是一个基于中文分词、纯PHP开发的全文检索引擎。其核心特点是“无感集成”:无需繁琐安装配置,无需额外维护调优,不占用服务器常驻内存。您可以将其视为项目中的一个普通库,却能迅速获得强大的搜索能力,并与现有PHP代码无缝融合。
项目地址:github.com/rock365/windsearch
WindSearch提供了多种便捷的安装方式,以适应不同开发习惯。
最推荐的方式是使用Composer,通过一行命令即可完成:
composer require rock365/windsearch
如果习惯于Git,克隆项目仓库也同样方便:
git clone git@github.com:rock365/windsearch.git
或者,您也可以直接访问GitHub页面进行手动下载:github.com/rock365/windsearch
安装完成后如何上手?WindSearch贴心地提供了两种模式:“即用模式”和“专业模式”。“即用模式”主打开箱即用,适合快速上线的简单场景;“专业模式”则提供更精细化的控制能力,以满足复杂的搜索需求。
“即用模式”追求极致的快速启动。它允许您无需额外配置即可立即导入数据,并同时支持整型主键和UUID主键。此模式下的所有API方法名均包含fast关键字,便于识别。
其工作原理清晰直接:对文本进行ngram分词,搜索结果直接返回匹配到的主键集合。开发者随后可以基于这些主键,前往MySQL等数据库中查询完整的原始数据,相当于为数据库查询增加了高效的“导航”。
引入文件:
安装后,首先根据项目实际路径引入自动加载文件:
require_once 'yourdirname/vendor/autoload.php';
导入数据
// 实例化对象,'test'是为当前搜索内容设定的索引库名称
$Wind = new \WindSearch\Index\Wind('test');
// 如果是首次使用可跳过此步;若之前已用即用模式导入过数据,建议先清空
$Wind->deleteFastIndex();
// 批量导入数据
// 假设 $res 是从数据库查询出的数据集
foreach($res as $v){
$text = $v['title']; // $text是需要被搜索的内容,例如文章标题
$primarykey = $v['id']; // $primarykey是此条数据的主键值
$Wind->fastIndexer($text, $primarykey);
}
// 每导入完一批数据,需调用此方法保存至磁盘
$Wind->fastBatchWrite();
// 所有数据导入完成后,执行最后一步:构建索引
// 此方法也可在所有数据准备就绪后单独调用
$Wind->fastBuildIndex();
执行搜索
// 重新实例化搜索对象
$Wind = new \WindSearch\Index\Wind('test');
// 调用快速搜索方法
// $page 为页码,$listRows 为每页条数
$res = $Wind->fastSearch($text, $page, $listRows);
// $res 返回的是主键(如id)集合,可用于数据库查询详细数据
请注意以下细节:每个索引库均可独立使用即用模式,数据单独存放,不会与专业模式数据混淆。由于即用模式数据从属于特定索引库,当删除整个索引库时,其数据也将被一并清理。因此建议:一个索引库名称尽量固定使用一种模式,以避免管理混乱。
需要指出的是,即用模式在追求极简与速度的同时,在搜索精准度与功能丰富性上可能略逊于可深度定制的专业模式。具体选择需依据实际应用场景而定。
(建议结合官方文档以获取最佳使用效果)
引入文件:
第一步与即用模式相同,引入自动加载文件:
require_once 'yourdirname/vendor/autoload.php';
创建索引库:
此过程类似在MySQL中建表,通过数组定义结构,便于复制与修改:
$mapping = [
// 设置索引库名称,通常对应业务表名
'name' => 'test',
// 字段配置,此为核心部分
'field' => [
[
'name' => 'id',
'type' => 'primarykey', // 必须设置主键字段
'primarykey_type' => 'Int_Incremental', // 主键类型,此处为自增整数
],
[
'name' => 'title',
'index' => true, // 此字段需要被索引
'type' => 'text',
'analyzer' => 'segment', // 配置使用分词器
],
[
'name' => 'tags',
'index' => true,
'type' => 'keyword', // 关键字类型,适合标签等不分词数据
],
[
'name' => 'score',
'type' => 'numeric', // 数值类型,用于范围查询等
],
[
'name' => 'time',
'type' => 'date' // 日期类型
],
[
'name' => 'descr',
'type' => 'text', // 文本类型
],
]
];
// 实例化对象
$Wind = new \WindSearch\Index\Wind('test');
// 检查索引库是否已存在
$is_index = $Wind->checkIndex();
// 如果存在,可先删除旧的(请谨慎操作)
if ($is_index) {
$Wind->delIndex();
}
// 创建全新索引库
$Wind->createIndex($mapping);
导入数据:
// 实例化引擎
$Wind = new \WindSearch\Index\Wind('test');
// 初始化索引构建流程
$Wind->buildIndexInit();
// 开启分词功能,导入数据时传入true参数可提升速度
$Wind->loadAnalyzer(true);
// 如果数据量不大(例如不到一万条),可一次性查询并导入
// $result = selectAll...
foreach ($result as $v) {
$Wind->indexer($v); // 逐条添加数据
}
// 批量将数据写入文件保存
$Wind->batchWrite();
构建索引:
// 所有数据导入结束后,执行此步骤以构建最终可用索引 // 请注意:数据量极大时,此过程可能耗时较长 $Wind->buildIndex();
开始搜索:
// 实例化引擎
$Wind = new \WindSearch\Index\Wind('test');
// 搜索前请确保开启分词功能
$Wind->loadAnalyzer();
// 构造搜索查询语句,此处演示搜索单个字段
$query = [
'match' => [
'field' => [
'name' => 'title', // 指定要搜索的字段名
'query' => $text, // 搜索关键词
],
'list_rows' => $listRows, // 每页数据条数
'page' => $page, // 页码
]
];
// 调用搜索接口
$res = $Wind->search($query, $page, $listRows);
// 最终,$res['result']['_source'] 中即为可直接渲染至前台的搜索结果数据
$resArr = $res['result']['_source'];
以上便是关于使用PHP WindSearch实现站内搜索功能的详细梳理。从极速即用到专业定制,它提供了一套足够灵活且对PHP开发者极为友好的解决方案。如果您的项目正需要一种轻量、高效的搜索能力,不妨尝试一下。
侠游戏发布此文仅为了传递信息,不代表侠游戏网站认同其观点或证实其描述