Laravel资源Resource_Api资源转换数据格式【说明】

阿杰同学_5127

阿杰同学_5127

2026-04-30

228人浏览

原创

必须用 resource 类做 api 数据格式转换,它是数据出口的强制闸门,统一管控字段、关联、安全与格式化;toarray() 是唯一可信入口,需显式定义所有输出字段,配合 whenloaded() 防 n+1,集合资源须用 collection() 方法并单独建集合类。

laravel资源resource_api资源转换数据格式【说明】

必须用 Resource 类做 API 数据格式转换,而不是直接 toArray() 或手动构造数组——否则字段控制、关联加载、条件输出、安全性(如隐藏密码)全得在控制器里硬写,很快失控。

Resource 类的 toArray() 是唯一可信的数据出口

所有字段定义、格式化、条件判断都必须收口到 toArray() 方法里。它不是“可选装饰”,而是数据流的强制闸门。

  • 模型属性访问($this->name)会自动触发访问器,但仅当该属性被显式写入 toArray() 返回数组时才生效;漏写就等于不输出
  • 关联数据必须用 $this->relation 访问,不能依赖预加载后直接读 $this->posts->first() —— 集合资源里这会报错或返回空
  • 日期字段别直接 $this->created_at->format('Y-m-d'),优先用 $this->created_at?->toDateString() 防 null
  • 不要在 toArray() 里调用模型方法做复杂查询(比如 $this->getLatestOrder()),那会破坏资源的无状态性,改用闭包 + whenLoaded()

UserResource::collection() 不是语法糖,它绕过了单个资源的构造逻辑

集合资源不是“把每个模型 new 一遍再塞进数组”,而是批量处理、跳过中间实例化,性能更好,也避免了 __construct() 中可能存在的副作用。

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载
  • 传入空集合(collect([]))时,UserResource::collection() 返回空数组 [],而 new UserResource($user) 传 null 会直接报错
  • 如果你重写了 UserResource 的构造函数(比如加日志或缓存),collection() 完全不走它——这点常被忽略
  • 想给集合加额外字段(如分页元信息),必须单独建集合类(php artisan make:resource UserCollection),不能只靠 collection() 静态方法

whenLoaded() 是防止 N+1 的关键开关,不是可有可无的优化

它只在关联已被预加载(with('posts'))时才执行内部逻辑,否则跳过。没它,$this->posts 在未预加载时会触发懒加载,一次请求查出几十次数据库。

  • 错误写法:'posts' => $this->posts —— 看似简洁,实则危险
  • 正确写法:'posts' => $this->whenLoaded('posts', fn() => PostResource::collection($this->posts))
  • 如果关联名是嵌套的(如 company.address),whenLoaded() 只支持一级,得拆成两层判断
  • whenLoaded() 内部仍可嵌套 when() 做业务逻辑过滤,但别放耗时操作

真正容易被忽略的点:资源类里没有 $request 上下文时,when() 和 whenLoaded() 的判断依据全靠模型当前状态和已加载关系——这意味着你无法在资源里做“根据用户权限动态决定是否显示字段”这类事,得提前在控制器里把权限结果作为属性塞进模型,或改用策略资源(Policy-based Resource)。

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

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2989

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2248

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1138

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2078

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3300

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14735

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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

共1课时 | 201人学习

Composer手册
Composer手册

共0课时 | 0人学习