PHP WindSearch实现站内搜索功能

WindSearch：一个能为PHP项目“零负担”提速的纯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', // 文本类型，可能不像title那样需要强分词
        ],
    ]
];

// 实例化对象
$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开发者非常友好的解决方案。如果你的项目正需要一个轻量、高效的搜索能力，不妨试试看。