Yii框架的数据提供者有哪些_ActiveDataProvider使用示例【汇总】

落瑶吖_5426

落瑶吖_5426

2026-03-10

586人浏览

原创

ActiveDataProvider是Yii中专为ActiveRecord设计的数据提供者,适用于列表页、GridView、API分页等场景,依赖ActiveQuery实例,自动下推分页排序至SQL层,避免内存OOM。

yii框架的数据提供者有哪些_activedataprovider使用示例【汇总】

ActiveDataProvider 是什么,什么时候该用它

ActiveDataProvider 是 Yii 中最常用的数据提供者,专为 ActiveRecord 模型设计,自动支持分页、排序、过滤。如果你在写列表页、后台表格、带搜索的网格视图,它就是默认选择——不是“可以考虑”,而是“大概率就该用它”。

它不直接查数据库,而是封装一个 Query 或 ActiveQuery,把分页/排序逻辑下推到 SQL 层,避免全量加载再内存处理。这点很关键:不用它而手写 array_chunk 或 array_slice 处理大数组,很容易 OOM。

  • 适合场景:GridView 渲染、API 分页响应、后台数据导出前的预览
  • 不适合场景:聚合统计(如 SUM/COUNT)、跨库关联、非 ActiveRecord 数据源(比如 Redis 缓存结果)
  • 注意:它依赖模型的 search() 方法返回的 ActiveQuery 实例,不是任意数组或查询构造器

初始化 ActiveDataProvider 的三个必要参数

创建实例时,query、pagination、sort 这三个配置项决定行为边界。漏掉或配错其中任何一个,都可能让分页失效、排序不生效、甚至报 Invalid Configuration 错误。

  • query 必须是 ActiveQuery 实例(比如 User::find()),不能是数组、Query 基类或已执行的 all() 结果
  • pagination 默认启用,设为 false 会禁用分页;想限制每页条数,用 ['pageSize' => 20],别直接改模型里的 defaultPageSize
  • sort 默认开启字段白名单保护,未在 attributes 中声明的字段无法被排序,防止 SQL 注入;例如:'sort' => ['attributes' => ['id', 'username', 'created_at']]

常见错误:new ActiveDataProvider(['query' => User::find()->where(['status' => 1])]) 看似没问题,但如果没配 sort,前端传 sort=-id 会静默忽略;配了但没列 id,就会 400 报错 Invalid Sort Attribute。

和 SqlDataProvider、ArrayDataProvider 的关键区别

别因为名字像就混用。三者定位完全不同:

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
  • ActiveDataProvider:绑定 ActiveRecord,自动映射属性、支持验证、能复用模型关系(with())、可直接调 save()/delete()
  • SqlDataProvider:只接受原生 SQL 字符串或 Command 对象,适合复杂视图、 UNION 查询、或非 Yii 模型数据;但没有属性规则、不能直接更新,sort 需手动映射字段别名
  • ArrayDataProvider:纯内存操作,适合小量静态数据(如配置项枚举)、测试 mock;大数据量时性能断崖式下跌,且分页是切数组,不是 SQL LIMIT

性能提示:用 ActiveDataProvider 查 10 万行?只要 SQL 走索引、count() 不触发全表扫描(比如避免 LIKE '%xxx' 在 count 中),就没问题;换成 ArrayDataProvider 反而更慢,还吃内存。

常见报错和绕过陷阱的写法

实际开发中最卡人的不是不会写,而是某些组合导致行为反直觉:

  • 报错 Calling unknown method: yii\db\ActiveQuery::search():说明你把普通 Query 当成 ActiveQuery 用了,检查是否少写了 use app\models\User; 或误用了 new Query()
  • 分页后总数不准(totalCount 偏低):大概率用了 groupBy 却没配 pagination['totalCount'] 回调,或者关联查询没加 distinct 导致重复计数
  • 排序字段不起作用:确认 sort 配置里声明了该字段,且模型中该属性可读(public 或有 getter),数据库字段名和模型属性名一致;若用别名(如 CONCAT(first_name, last_name) as full_name),必须在 sort['attributes'] 中显式映射
  • 关联字段无法排序/过滤:要用 joinWith('profile') + addSelect('profile.nickname'),再在 sort 和 filter 中引用 profile.nickname,不能只靠 with()

最易被忽略的一点:ActiveDataProvider 的 query 在第一次调用 getModels() 或 getCount() 时才真正执行。调试时别只看构造参数,要检查最终生成的 SQL —— 开启 yii\db\Command::enableLogging = true 或看 debug toolbar 的 query 面板。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

yii yii框架

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.10.12

4683

8

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

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

2023.10.27

971

4

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

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

2024.02.23

1229

5

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

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

2024.03.06

6681

10

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

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

2024.03.06

3403

4

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

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

2024.04.07

6660

11

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

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

2024.04.29

9181

6

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

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

2024.04.29

1250

5

sql中删除一列的命令是什么
sql中删除一列的命令是什么

在sql中,使用alter table语句可以删除一列,语法为:alter table table_name drop column column_name。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1092

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共22课时 | 9.3万人学习