讲师中心 微信公众号
AI工具推荐 视频效率加速

API资源怎么用_LaravelAPI格式化方法【详解】

风敏姑娘_1491

风敏姑娘_1491

发布时间:2026-05-12 23:22:36

|

296人浏览过

|

来源于php中文网

原创

API资源是Laravel处理模型到JSON转换的事实标准,需用php artisan make:resource生成,通过toArray()定义结构,依赖预加载防N+1,集合需调用->response()保留分页信息,字段映射优先用模型访问器,条件输出用when/whenLoaded,空值处理在控制器完成。

api资源怎么用_laravelapi格式化方法【详解】

API资源在 Laravel 中不是“可选插件”,而是处理模型到 JSON 转换的事实标准——不用它,你就得在控制器里手动 array_map、拼字段、判空、处理分页、防 N+1,最后还容易漏掉敏感字段过滤。

资源类生成和基础用法

生成资源类只需一条命令:php artisan make:resource UserResource。生成后,app/Http/Resources/UserResource.php 里的 toArray() 方法就是你定义输出结构的唯一入口。

关键点在于:$this 是模型实例,不是数组或 Collection,所有字段访问都走 Eloquent 属性读取逻辑(会触发访问器、关系延迟加载等)。

  • 日期必须显式格式化,$this->created_at 默认是 Carbon 实例,直接返回会转成 ISO 字符串,但如果你要 Y-m-d 格式,得写 $this->created_at->format('Y-m-d')
  • 不要在 toArray() 里调用 $this->load() 或 $this->relation->xxx —— 这会导致每个资源实例都触发一次查询
  • 关联数据必须靠控制器预加载,比如 User::with('posts')->get(),然后在资源里用 $this->whenLoaded('posts', fn() => PostResource::collection($this->posts))

集合返回时分页信息丢失怎么办

Laravel 10+ 默认关闭了 ResourceCollection 对分页器的自动识别,UserResource::collection($users) 返回的只是纯数据数组,links 和 meta 全没了。

这不是 bug,是设计变更:框架不再隐式包装 Paginator,要求你显式控制响应行为。

laravel-specialist
laravel-specialist

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

下载
  • 正确做法是调用 ->response():return UserResource::collection($users)->response();
  • 如果用了自定义集合类(如 UserCollection),确保它继承 ResourceCollection,且没重写 paginationInformation() 导致逻辑被覆盖
  • 别用 new UserResource($users) 处理集合——这是单资源写法,$users 是分页器时会报错 Call to a member function toArray() on null
  • 保留 URL 查询参数(如 page=2&sort=name)需手动追加:$users->appends(request()->query())

字段映射与条件输出怎么写才安全

前端要 user_name,数据库是 name;要 is_active,模型存的是 active 字段——硬编码 key 易错且难维护。

优先级顺序是:模型访问器 + $appends > 资源类内重命名 > 直接写死 key。

  • 在模型中定义访问器:protected function getUserNameAttribute() { return $this->name; },再在 $appends = ['user_name'],资源里直接用 $this->user_name
  • 用 $this->when() 控制字段可见性,比如只对管理员返回邮箱:'email' => $this->when($request->user()?->isAdmin(), $this->email)
  • $this->whenLoaded() 只取已加载的数据,不触发新查询;而 $this->when($this->relation, ...) 会触发 getter,可能引发 N+1
  • 空值兜底必须在控制器做:return new UserResource($user ?? new User()),资源类本身不处理 null 输入

为什么资源类里不能直接访问未加载的关系

因为资源类执行时,Eloquent 模型已经从数据库取出,但关联数据是否加载,取决于控制器有没有调用 with()。没预加载就写 $this->profile->avatar,Laravel 会在每个资源实例里执行一次 SQL 查询。

100 条用户数据,就会发出 100 次 SELECT * FROM profiles WHERE user_id = ? —— 这就是典型的 N+1,性能崩得比日志还快。

  • 正确姿势:控制器查的时候就加载好,User::with('profile')->paginate(20)
  • 资源里只用 $this->whenLoaded('profile', fn() => new ProfileResource($this->profile))
  • 想动态加载(比如按角色决定是否查地址),在控制器里用 when() 构建查询条件,而不是在资源里补救
  • 闭包里用 use ($companyId) 做动态关联查询虽可行,但属于高阶技巧,容易绕过预加载,应先确认是否真无法预加载

最常被忽略的一点:资源类不负责 HTTP 状态码、顶层包裹键(如 data)、错误统一格式——这些该由控制器或全局响应宏处理。把所有逻辑塞进资源类,等于把路由层职责也扛了,后期改一个字段名,得翻三处代码。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

857

2024.04.09

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

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

855

2024.04.09

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

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

2508

2024.04.09

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

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

4381

2024.04.10

laravel入门教程
laravel入门教程

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

6330

2025.08.05

laravel实战教程
laravel实战教程

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

4196

2025.08.05

laravel面试题
laravel面试题

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

7869

2025.08.05

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

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

1496

2026.03.04

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

40

2026.10.22

热门下载

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

精品课程

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

共1课时 | 213人学习

Composer手册
Composer手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn