介绍

基于 BuildAdmin 的 Meilisearch 搜索引擎模块，Meilisearch 是一款开源、轻量、超快的搜索引擎，适用于多种需要高性能全文搜索、模糊匹配、过滤、排序、分面统计等场景，支持高亮匹配关键词，默认支持中文分词，无需额外配置，开箱即用，开发者友好，可用于电商类产品搜索，内容类平台（cms，新闻）的高效内容检索。

注意事项

参与搜索，排序的字段需要在索引配置中开启
参与搜索，排序的字段需要在索引配置中开启
参与搜索，排序的字段需要在索引配置中开启

功能特性

• 索引管理
  • 创建 / 编辑 / 删除索引
  • 设置索引主键（primary key）
  • 字段备注（支持中文注释，便于团队协作）
• 索引配置
  • 可搜索字段（searchableAttributes）
  • 可过滤字段（filterableAttributes）
  • 可排序字段（sortableAttributes）
  • 排名规则（rankingRules）
  • 同义词（synonyms）管理
• 文档操作
  • 文档搜索（支持高亮、分面、过滤、排序）
  • 查看单条文档详情
  • 添加 / 编辑 / 删除文档
• 异步任务管理
  • 实时查看所有异步任务（索引创建、文档更新、设置变更等）
  • 任务状态跟踪（enqueued, processing, succeeded, failed,canceled）
  • 任务类型跟踪（indexCreation, indexUpdate, indexDeletion, documentEdition,documentAdditionOrUpdate）等
  • 手动删除已完成或失败的任务记录

函数封装

全部操作查看模块源码或模块文档

• 索引相关：indexAdd(), indexList()
• 文档相关：search(),documentAdd(), documentDel(), documentEdit()
• 配置相关： updateConfig(), taskDel()

安装使用

• 安装模块后，在 .env 配置服务地址以及密钥

[MEILI] HOST = xxxxx #服务地址以及端口 KEY = xxxxx #服务密钥

• 使用示例，更多操作查看模块源码或模块文档

public function test(): void { $uid = 'demo';//索引 $q = '手机';//搜索词 $options = [ 'limit' => 10,//数量 'filter' => 'id > 10 AND (level = 2 OR level = 3)',//过滤条件 'facets' => ['category', 'city'],//分面搜索 ]; //搜索示例 $resp = \modules\meili\library\Ms::search($uid, $q, $options); var_dump($resp); $uid = 'demo';//索引 //文档数据 $data = [ ['id' => 2, 'name' => '张三', 'age' => 16], ['id' => 3, 'name' => '李四', 'age' => 19] ]; //添加文档 $resp = Ms::documentAdd($uid, $data); var_dump($resp); }