thinkphp7模型搜索器需在模型类中定义search+字段驼峰名+attr的public方法,如searchusernameattr,接收$query、$value、$data三参数并返回$query;必须通过withsearch(['field'], ['field'=>'value'])调用,配合select()执行,支持多字段搜索、动态排序、字段白名单校验及分页参数保留。

ThinkPHP7模型搜索器需要在模型类中定义特定命名的public方法,再通过withSearch()调用才能生效,不能直接在控制器里写where条件模拟,否则字段映射、参数传递和闭包封装全失效。
定义搜索器方法
在模型类(如app\model\User.php)中,按search + 字段驼峰名 + Attr规则声明public方法:
比如数据库字段是user_name,对应搜索器方法名为searchUserNameAttr;字段是email_verified_at,则方法名为searchEmailVerifiedAtAttr。
每个搜索器方法必须接收三个参数:$query(查询对象)、$value(用户传入的关键词值)、$data(整个搜索参数数组),且必须返回$query对象以维持链式调用。
【方法名必须严格匹配字段驼峰转换规则,拼错一个字母或大小写不符,withSearch()就完全不触发该方法】
示例代码:
public function searchUserNameAttr($query, $value, $data)
{
$query->where('user_name', 'like', '%' . $value . '%');
}
调用搜索器执行查询
控制器中不能用User::where('user_name', 'like', '%xxx%')——这是绕过搜索器的原始写法,丢失了封装逻辑和字段校验能力。
正确调用方式是使用withSearch(),它接收两个数组参数:
第一个是启用的搜索器字段列表,如['user_name', 'email'];
第二个是各字段对应的搜索值,如['user_name' => 'admin', 'email' => 'test@']。
注意:withSearch()必须配合select()或find()等终端方法才能真正执行SQL,单独调用只是构造查询条件。
完整示例:
$users = User::withSearch(['user_name'], ['user_name' => 'think'])->select();
多字段联合搜索与排序控制
方法一:启用多个搜索器
在模型中分别定义searchUserNameAttr、searchEmailAttr、searchStatusAttr等方法;
调用时传入对应字段名数组:withSearch(['user_name', 'email', 'status'], [...])。
方法二:单个搜索器内支持多字段OR逻辑
不推荐在搜索器里硬写多个whereOr(),容易污染全局查询;
应由控制器层构建闭包,把合法字段数组透传进搜索器,再在闭包内循环调用whereOr()。
方法三:在搜索器中读取$data参数实现动态排序
比如用户提交了sort=created_at|desc,可在searchUserNameAttr方法里判断:
if (!empty($data['sort'])) { $query->order($data['sort']); }
这比在控制器里重复写order()更易复用和维护。
字段白名单校验与安全过滤
第一步:获取模型真实字段列表
$schemaFields = (new User())->getSchemaFields(); // 返回数据库字段小写蛇形数组
第二步:校验用户传入的搜索字段是否在白名单内
$field = input('field', 'user_name');
if (!in_array($field, $schemaFields)) { $field = 'user_name'; }
第三步:禁止将用户输入直接拼进SQL字符串
错误写法:where("{$field}", 'like', "%{$keyword}%") —— 字段名未校验,存在SQL注入风险;
正确路径:只允许白名单字段进入withSearch()第一参数,其余一律丢弃。
【开启模型strict模式后,非法字段会直接抛出异常而非静默忽略,调试阶段务必打开】
分页时保留动态搜索参数
第一步:手动设置分页query参数
$users = User::withSearch(['user_name'], ['user_name' => $keyword])
->paginate(15, false, ['query' => ['field' => 'user_name', 'keyword' => $keyword]]);
第二步:避免使用默认分页链接生成逻辑
Paginator组件不会自动捕获withSearch()中的动态键名,field和keyword必须显式塞进query选项,否则翻页后条件清空。
第三步:前端URL需携带原始参数
生成分页HTML前,确保模板中分页链接已包含?field=user_name&keyword=admin这类参数,否则后端无法还原搜索上下文。
php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!











