Yii2 模型实现 Arrayable 接口后 toArray 行为有什么变化

夜丽小哥_3697

夜丽小哥_3697

2026-10-20

459人浏览

原创

yii2模型默认实现arrayable接口,可通过重写fields()和extrafields()定制toarray()输出:字段白名单/黑名单、关联数据显式展开、嵌套路径与回调处理;asarray()则绕过模型直接映射数据库字段,两者路径不同。

yii2 模型实现 arrayable 接口后 toarray 行为有什么变化

Yii2 模型默认就实现了 Arrayable 接口(因为 yii\base\Model 和 yii\db\ActiveRecord 都已实现),所以你不需要手动实现它,但你可以重写 toArray() 的行为来精确控制哪些字段、如何嵌套、是否包含关联数据、是否应用过滤逻辑等。

关键点不是“实现接口后行为变化”,而是“重写 toArray() 或相关 Arrayable 方法后,输出结构可被定制”。

以下是实际影响你 API 输出的几个核心变化方向:

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
  • 字段白名单/黑名单控制
    重写 fields() 返回允许导出的字段列表;重写 extraFields() 定义可选扩展字段(如关联模型、计算属性)。

    public function fields()
    {
        return ['id', 'name', 'email']; // 只暴露这三个字段
    }
    public function extraFields()
    {
        return ['profile', 'posts']; // 关联对象需定义 getter 或 relation
    }

    调用 $model->toArray(['id', 'name'], ['profile']) 时,才会包含 profile 数据。

  • 关联数据自动展开需显式声明
    toArray() 默认不递归展开关联对象。即使 profile 是一个 ActiveRecord 对象,不进 extraFields() + 显式请求,就不会转成数组。
    若 profile 是 hasOne() 关系,且你在 extraFields() 中定义了它,toArray() 会自动调用其 toArray() —— 前提是该关联对象也支持 Arrayable(它天然支持)。

  • 支持嵌套路径与回调处理
    toArray() 内部使用 ArrayHelper::toArray() 处理嵌套结构,因此支持点语法路径(如 'profile.name')、闭包转换:

    public function fields()
    {
        return [
            'id',
            'full_name' => function ($model) {
                return $model->firstName . ' ' . $model->lastName;
            },
        ];
    }
  • 自动跳过敏感字段或未设置值
    如果某个字段在 fields() 中声明,但模型属性为 null 且未设默认值,toArray() 默认不会输出该键(除非你覆盖 toArray() 并传入 $keepNulls = true)。
    你也可以在 fields() 中用 isset() 或 !empty() 过滤动态字段。

  • 与 asArray() 查询模式无关
    注意:ActiveRecord::find()->asArray()->one() 返回的是原生数组,绕过模型实例,完全不走 toArray()。它只做数据库字段到数组的直映射,无字段过滤、无关联展开、无类型转换。这是两条不同路径。

本质上,toArray() 是面向资源表达层(如 REST API 响应) 的可控序列化入口;而 asArray() 是面向查询性能优化的底层数据获取方式。

相关文章

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

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

下载

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

相关专题

更多
go语言 面向对象
go语言 面向对象

本专题整合了go语言面向对象相关内容,阅读专题下面的文章了解更多详细内容。

2025.09.05

6495

14

java面向对象
java面向对象

本专题整合了java面向对象相关内容,阅读专题下面的文章了解更多详细内容。

2025.11.27

342

13

C++ 面向对象编程与设计模式实践
C++ 面向对象编程与设计模式实践

本专题整合了 C++ 面向对象编程的核心机制,涵盖类的定义与访问控制、构造函数与析构函数、拷贝语义与移动语义、继承与虚函数多态、抽象类与接口、运算符重载、友元函数等关键知识点,同时结合单例模式、工厂模式、观察者模式、策略模式等常用设计模式的 C++ 实现,帮助开发者写出结构清晰、易于维护的面向对象代码。

2026.04.09

344

30

Java 面向对象与核心编程机制
Java 面向对象与核心编程机制

系统讲解 Java 面向对象编程的核心知识体系,涵盖类的定义与封装、构造方法与 this/super 关键字、继承与方法重写、多态与向上向下转型、抽象类与接口的区别与设计原则、异常处理机制(try-catch-finally / 自定义异常)、泛型的类型参数与通配符、集合框架(List/Set/Map)的使用与遍历方式,帮助开发者全面掌握 Java 程序设计的核心机制与面向对象思维。

2026.04.17

223

15

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

3030

22

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

60

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

40

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

40

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

20

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii2中文手册
Yii2中文手册

共0课时 | 0.6万人学习