Laravel模型资源(Resource)与API资源转换教程

千敏吖_3843

千敏吖_3843

2026-05-19

617人浏览

原创

必须用 resource 类做 api 数据格式转换,它是数据流强制闸门;字段需显式声明,关联须预加载+whenloaded,分页需链式 response() 或自定义集合类,openapi 文档须手动注解。

laravel模型资源(resource)与api资源转换教程

必须用 Resource 类做 API 数据格式转换,直接 toArray() 或手动构造数组会失控——字段漏写、N+1、敏感信息暴露、分页结构丢失,全在控制器里硬拼时埋下。

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

它不是“美化层”,而是数据流强制闸门。返回什么,JSON 就长什么样;没写的字段,前端永远收不到;写错逻辑,就直接暴露密码或 null 引用。

  • $this->name 会触发模型访问器,但前提是这一行被显式写进 toArray() 返回数组里
  • 日期别依赖模型 $casts 或全局设置:$this->created_at?->toISOString() 才可靠,?-> 防 null
  • 关联字段不能直接写 'posts' => $this->posts——未预加载时会懒加载,一次请求变几十次查询
  • 要嵌套关联,必须配合 $this->whenLoaded('posts', fn() => PostResource::collection($this->posts))

UserResource::collection() 不等于循环 new

它跳过单个资源构造函数,批量处理,性能更好,也避免了你在 __construct() 里加日志、缓存等副作用被意外执行。

Laravel Creem Agent
Laravel Creem Agent

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

下载
  • 传 collect([]) 返回空数组 [];传 null 给 new UserResource($user) 直接报错
  • 如果用了分页(如 User::paginate(10)),UserResource::collection($users) 只返回 data 数组,links 和 meta 全丢——必须链式调用 ->response()
  • 想加 data 包裹或自定义分页字段,得单独建集合类:php artisan make:resource UserCollection --collection,并在 toArray() 里手动组织结构

条件字段和敏感字段靠显式控制,不靠“默认过滤”

Resource 没有自动白名单或隐藏规则。漏写 = 安全,写错 = 泄露。所有判断都得你亲手写进 toArray()。

  • 用 $this->when($this->can('admin'), 'is_admin') 替代 if 分支,兼容 collection 场景
  • 批量加调试字段:mergeWhen($request->user()->isSuperAdmin(), ['sql_log' => []])
  • 永远不要在 toArray() 里调用 $this->load() 或复杂模型方法——资源应无状态,查询必须由控制器预加载完成
  • 字段映射别硬编码:数据库存 active,前端要 is_active,就在 toArray() 里写 'is_active' => (bool) $this->active

OpenAPI 文档不会自动读取 Resource 类

无论你把 toArray() 写得多规范,scribe 或 laravel-openapi 都不会去解析它。它们只认控制器方法上的注解。

  • 返回集合时,必须写 @responseCollection App\Http\Resources\UserResource,不能只写 @response
  • 用了 when() 动态字段?得用 @responseField nullable 显式标注可选性
  • 嵌套了 $this->whenLoaded('profile')?文档里不会自动展开 profile.id,得手写 @responseField profile.id
  • 自定义响应包装(如 return response()->json(['items' => $resource]))?必须用 @response 贴 JSON 示例,否则文档为空

真正容易被忽略的点是:资源类里没有“魔法”,只有你写的每一行 PHP 逻辑;而最危险的疏忽,往往发生在你认为“这个字段肯定有值”“那个关联肯定已加载”的时候。

大量免费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

2929

3

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

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

2023.07.25

2208

9

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

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

2023.08.02

1180

5

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

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

2023.08.09

1118

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

1316

5

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

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

2023.09.20

2058

7

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

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

2023.09.20

3240

8

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

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

2023.09.22

14475

6

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

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

2023.09.22

529

3

热门下载

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

精品课程

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

共1课时 | 200人学习

Composer手册
Composer手册

共0课时 | 0人学习