Laravel框架序列化怎么改_Laravel框架模型输出调整技巧【教程】

小涛姑娘_4273

小涛姑娘_4273

2026-05-01

577人浏览

原创

直接在模型层控制序列化行为,优先使用$hidden(黑名单)或$visible(白名单)控制字段显隐;通过访问器动态计算字段值并参与序列化;API场景推荐使用API Resource统一编排响应结构,实现模型与传输格式解耦。

laravel框架序列化怎么改_laravel框架模型输出调整技巧【教程】

直接改模型的序列化行为,不是靠 json_encode() 临时处理,而是让 toArray() 和 toJson() 从源头就按你需要的结构和字段输出。关键在模型层控制,而不是控制器里硬塞数组。

用 $hidden 和 $visible 控制字段显隐

这是最轻量、最常用的方式,适用于「始终不暴露某字段」或「只允许输出固定字段」的场景。它作用于所有序列化路径(toArray()、toJson()、API Resource 中的 resolve() 等)。

  • $hidden 是黑名单:声明后,字段在任何序列化中都自动剔除,比如 protected $hidden = ['password', 'api_token']
  • $visible 是白名单:一旦设置,**其他所有字段默认被屏蔽**,哪怕没在 $fillable 里也一样——这点容易被忽略
  • 两者不能共存;若同时定义,$visible 优先级更高,$hidden 会被忽略
  • 注意:$hidden 对关系(with() 加载的关联模型)无效,需单独在关联模型里设

用访问器(Accessors)改字段值或结构

当字段内容需要动态计算、格式转换、多语言适配时,访问器比手动在控制器里 map() 更干净、可复用。

  • 例如数据库存的是 JSON 字符串 {"en": "Morocco", "ar": "المغرب"},想通过 $country->name 直接取当前语言值:
    public function getNameAttribute() { return json_decode($this->attributes['name'], true)[app()->getLocale()] ?? $this->attributes['name']; }
  • 访问器名必须是 getXXXAttribute 格式,且 XXX 首字母大写(对应属性名 xxx)
  • 它只影响读取,不影响数据库写入;若还需写入时处理,得配对加修改器(Mutator)setNameAttribute()
  • 访问器返回值会参与序列化——所以你可以返回数组、对象,甚至 Carbon 实例,它们会被自动转成 JSON 兼容格式

用 API Resource 统一响应结构(推荐用于 API)

如果你的项目有明确前后端分离或对外提供 API,别在模型里堆逻辑。Resource 是 Laravel 官方推荐的「序列化编排层」,能解耦数据结构与业务模型。

laravel-specialist
laravel-specialist

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

下载
  • 单个资源用 new UserResource($user),集合用 UserResource::collection($users),保证结构一致
  • 可在 toArray() 方法里自由组合字段、嵌套关系、添加元信息:
    return [ 'id' => $this->id, 'name' => $this->name, 'avatar_url' => $this->when($this->relationLoaded('avatar'), fn() => $this->avatar->url) ];
  • $this->when() 和 $this->mergeWhen() 支持运行时条件判断,比静态 $hidden 更灵活
  • 不同 API 版本可用不同 Resource 类(如 V1\UserResource / V2\UserResource),避免模型污染

Laravel 9+ 后批量赋值和日期 cast 的连带影响

升级后模型序列化异常,常不是序列化本身的问题,而是前置环节出错导致模型根本没正确加载字段。

  • 没定义 $fillable 或 $guarded → 模型实例字段为空 → toArray() 输出空数组或报 MassAssignmentException(Laravel 9+ 默认严格模式)
  • casts 里写 'published_at' => 'date' → 升级后返回 string 而非 Carbon → 访问 $post->published_at->format() 报错「Call to a member function format() on string」
  • 解决方法:改用 'published_at' => 'datetime'(返回 Carbon)或显式封装 Carbon::parse($this->published_at)
  • 这些看似和「序列化」无关,但实际决定了 toArray() 里某个键的值类型——而 JSON 只认基本类型,对象若没正确转成数组/字符串,就会被丢弃或报错

真正难调的不是怎么写 Resource 或访问器,而是搞清哪一层该承担什么责任:模型管数据形态,Resource 管传输结构,控制器只负责调度。混在一起改,很快就会出现字段忽隐忽现、本地正常线上报错、API 版本混乱等问题。

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

877

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

855

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2508

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

4481

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

6510

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

4296

13

laravel面试题
laravel面试题

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

2025.08.05

8049

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1496

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

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

共1课时 | 213人学习

Composer手册
Composer手册

共0课时 | 0人学习