Laravel如何序列化模型_Laravel模型序列化方法【API】

雨强小哥_8707

雨强小哥_8707

2026-05-03

459人浏览

原创

Eloquent模型序列化需理清$hidden/$visible、toArray()触发时机及API资源冲突;toJson()返回{}多因模型为null;withoutRelations()可剥离已加载关联;加密字段推荐用Cast类脱敏。

laravel如何序列化模型_laravel模型序列化方法【api】

直接返回 Eloquent 模型或集合,Laravel 会自动调用 toJson();但若字段没按预期出现、JSON 为空、或敏感字段泄露,问题几乎都出在序列化控制逻辑没理清,而不是方法本身不会用。

toArray() 和 toJson() 什么时候真正生效

toArray() 不是“随时触发”的魔术方法,它只在明确进入序列化流程时才被调用:比如调用 toJson()、response()->json($model)、Blade 中直接 {{ $user }}(Laravel 9+ 默认启用),或者 API 资源的 toArray() 方法里显式调用它。它**不会**在 dd()、var_dump()、日志里执行——这时候你看到的是原始对象,含所有属性和关系,容易误判 $hidden 是否起作用。

常见错误现象:dd($user->toArray()) 显示了 password,但 response()->json($user) 却没返回 → 很可能漏写了模型的 $hidden 属性,仅靠手动调用 toArray() 覆盖不生效。

  • $hidden 和 $visible 是底层控制开关,必须写在模型类里才对自动序列化生效
  • 重写 toArray() 会绕过 Laravel 的缓存优化(如结果复用),高频接口慎用复杂逻辑
  • 若同时实现了 jsonSerialize(),会完全跳过 toArray(),两者不要混用

toJson() 返回 {} 空对象的真正原因

toJson() 返回 {} 几乎从不是 JSON 编码失败,而是源头模型为 null 或空实例。例如 User::find(999)->toJson(),因查不到记录返回 null,而 null 经 json_encode() 就是 {}。

  • 务必先判断存在性:if ($user) { return $user->toJson(); } 或用 optional($user)->toJson()
  • JSON_UNESCAPED_UNICODE 可避免中文被转义,但别加 JSON_PRETTY_PRINT 上生产环境,体积膨胀且无缓存优势
  • 模型未加载成功时,toArray() 也会返回空数组,本质同源

关联数据该不该序列化?用 withoutRelations() 控制输出范围

预加载了 with('posts'),但 API 只需用户基本信息?默认序列化会把整个 posts 数组嵌进去,增大响应体积、暴露无关数据。这时 withoutRelations() 是轻量级解法。

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载

它不改查询、不删关系、不触发新查询,只是在序列化前“剥离”已加载的关联副本:

  • $user->withoutRelations()->toJson() → 只含 User 自身字段
  • 可链式调用:$user->withoutRelations()->makeHidden(['password', 'remember_token'])->toJson()
  • 适用于“已加载用于业务判断,但不对外输出”的场景,不能替代合理查询设计(比如不该查的就别 with())

敏感字段隐藏失败?检查 $hidden 和 API 资源是否冲突

$hidden = ['password'] 在模型里写了,但 API 响应里还是出现了?大概率是用了 API Resource,而 Resource 的 toArray() 没继承模型的隐藏规则——Resource 完全接管了序列化逻辑。

API Resource 更推荐用于精细化控制,但它和模型层的 $hidden 是两套机制:

  • Resource 中要隐藏字段,得手动不返回:'email' => $this->email 不写,就不出现在 JSON 里
  • 想复用模型的 $hidden,可用 $this->resource->toArray() 获取基础数组再过滤,但失去 Resource 的条件字段(when())、嵌套资源等优势
  • 加密字段等特殊处理,建议用自定义 Cast 类,在 toArray() 前就完成脱敏,比藏在 $hidden 更可靠

最易被忽略的一点:模型序列化时,$appends 添加的字段(如 is_admin)会参与 $hidden 判断,但访问器方法名必须严格是 getIsAdminAttribute() 形式,少下划线或多参数都会失效。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11764

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6761

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2195

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4288

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

5014

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3931

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5677

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4442

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12362

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 218人学习

Composer手册
Composer手册

共0课时 | 0人学习