讲师中心 微信公众号
AI工具推荐 视频效率加速

Yii2的API搜索过滤怎么实现_扩展ActiveController的index操作【教程】

落敏大大_4004

落敏大大_4004

发布时间:2026-03-18 08:23:03

|

925人浏览过

|

来源于php中文网

原创

Yii2中ActiveController的index方法默认不支持搜索过滤,需手动重写actionIndex并接入SearchModel;SearchModel::search()须用andFilterWhere、显式joinWith、避免SQL注入。

yii2的api搜索过滤怎么实现_扩展activecontroller的index操作【教程】

Yii2中ActiveController的index方法默认不支持搜索过滤

直接继承 ActiveController 并调用 index,它只做基础分页和字段投影,filter 参数会被忽略——这不是bug,是设计如此。Yii2的RESTful控制器默认把过滤逻辑交给客户端或自定义行为,不是开箱即用的。

常见错误现象:GET /api/users?name=foo 返回全部用户,name 参数完全没生效;调试发现 $this->searchModel 根本没被创建或没被应用。

  • 必须显式覆盖 index 方法,或挂载 DataFilter 行为(但后者需额外配置)
  • 不能依赖 ActiveController::actions() 里默认的 index 配置
  • 如果用了 yii\rest\IndexAction 类,它本身不解析查询参数做模型过滤,只处理 sort 和 page

重写index方法时如何安全接入SearchModel

最直接、可控的方式是复制 IndexAction 的逻辑,但在控制器里手动构建 ActiveDataProvider,并注入 SearchModel 实例。关键不是“怎么写”,而是“谁来负责验证和转换参数”。

使用场景:需要按字符串模糊匹配、范围查询(如 created_at 大于某时间)、关联字段筛选(如 user.profile.status)。

  • 在控制器里 new 一个 SearchModel(比如 UserSearch),别用 new static —— 它可能不是 ActiveRecord 子类
  • 调用 $searchModel->load(\Yii::$app->request->get(), ''),第二个参数传空字符串,否则默认前缀会导致参数名对不上
  • 务必检查 $searchModel->validate(),失败时应返回 400 和具体错误,而不是静默忽略
  • ActiveDataProvider 的 query 必须是 $searchModel->search() 返回的 Query 对象,不能直接用 User::find()
public function actionIndex()
{
    $searchModel = new UserSearch();
    $params = \Yii::$app->request->get();
    if (!$searchModel->load($params, '')) {
        throw new BadRequestHttpException('Invalid search parameters');
    }
    $dataProvider = $searchModel->search($params);
    return $dataProvider;
}

SearchModel::search() 方法里容易漏掉的三件事

很多同学写了 search() 却发现关联字段查不到、排序失效、或者 SQL 报错,问题常出在 Query 构建阶段,而不是控制器。

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载

性能影响明显:没加 asArray() 或没选必要字段,会拖慢接口;没用 andFilterWhere() 而用 andWhere(),会导致空值参数生成 WHERE name = NULL 这种永远不成立的条件。

  • 关联查询必须显式 joinWith('profile'),不能只在 andFilterWhere(['profile.status' => $this->status]) 里提字段名
  • 字符串搜索要用 andFilterWhere(['like', 'name', $this->name]),不是 ['like', 'name', "%{$this->name}%"] —— 后者有 SQL 注入风险且不兼容 Oracle
  • 日期范围要拆成两个 andFilterWhere,例如 ['>=', 'created_at', $this->start_date] 和 ['end_date],别塞进一个数组

为什么不要在ActiveController里直接改$searchModel的属性

有人图省事,在控制器里写 $searchModel->name = \Yii::$app->request->get('name'),绕过 load()。这看似简单,实则埋雷。

兼容性影响大:一旦 SearchModel 加了规则(比如 required、safe)、事件(beforeValidate)或属性类型转换(integer 字段自动 cast),手动赋值就失效或出错。

  • load() 触发验证规则和属性过滤,safe 属性才允许被批量赋值
  • 前端传 name=(空字符串)或 name=null,load() + validate() 能统一处理;手动赋值后直接进 query,可能生成 WHERE name = '' 或更糟
  • 如果 SearchModel 继承自 Model 而非 ActiveRecord,它根本没有 attributes() 元数据,手动赋值等于裸写魔法字符串

复杂点在于:搜索逻辑天然耦合验证、查询构建、权限控制(比如用户只能搜自己部门的数据)。这些没法靠一个“扩展 index 操作”的小技巧兜住,得在 SearchModel 里提前想清楚数据边界和字段白名单。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

3823

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

811

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

989

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

5641

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2603

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

5620

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

7401

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

1010

2024.04.29

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习

Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn