0

0

Laravel如何实现API资源集合?(Resource Collection教程)

冰火之心

冰火之心

发布时间:2025-12-20 17:09:47

|

738人浏览过

|

来源于php中文网

原创

Laravel API资源集合用于统一格式化模型集合并返回JSON响应,需通过UserCollection封装分页或普通查询结果,自动处理字段、关系与分页结构。

laravel如何实现api资源集合?(resource collection教程)

在 Laravel 中,API 资源集合(Resource Collection)是用来统一格式化一组模型数据(比如 Eloquent 集合)并返回 JSON 响应的核心机制。它不是简单地循环输出数组,而是让批量数据的结构、字段、关系、分页等都保持与单个资源(Resource)一致的可控性和可维护性。

定义资源集合类

当你已有单个资源类(如 UserResource),可通过 Artisan 命令快速生成对应的集合类:

php artisan make:resource UserCollection

生成的 UserCollection.php 默认继承 ResourceCollection,并重写了 toArray() 方法。注意:它不自动调用每个模型的 UserResource,你需要显式委托:

  • 推荐写法:直接返回 $this->collection,Laravel 会自动为每个模型实例调用对应资源类(前提是集合中每个项都是模型且资源类命名规范)
  • 手动控制:也可用 $this->collection->mapInto(UserResource::class)$this->collection->map(fn ($user) => new UserResource($user))

配合 API 路由和控制器使用

在控制器方法中,不要直接 return $users->toArray() 或 response()->json(),而是用资源封装:

  • 返回普通集合:return new UserCollection(User::all());
  • 返回分页结果(最常见):return new UserCollection(User::paginate(10)); —— Laravel 自动识别分页器,并把 datalinksmeta 等结构注入响应
  • 需要额外字段?重写集合的 toArray(),例如添加总数量:
    public function toArray($request) { return [ 'data' => $this->collection, 'total' => $this->total(), ]; }

处理嵌套关系和条件字段

资源集合本身不直接处理关系,逻辑仍放在单个资源类里。比如 UserResource 中写了 'posts' => PostCollection::make($this->whenLoaded('posts')),那么在集合中每条用户数据都会按需加载并格式化 posts 关系。

若想在集合层统一加字段(如统计信息),可在集合的 toArray() 中添加:

  • 'summary' => ['active_users' => $this->collection->where('status', 'active')->count()]
  • 避免在集合里做 N+1 查询,关系预加载应在查询时完成:User::with('posts')->paginate(10)

自定义分页响应结构(可选进阶)

默认分页响应包含 datafirst_page_urllast_page 等。如需精简或改名,可创建继承 ResourceCollection 的子类,并重写 paginationInformation() 方法:

  • 返回空数组可去除所有分页字段(仅保留 data)
  • 返回自定义键值对,比如 'pagination' => [...] 把分页信息包进一个顶层字段

基本上就这些。资源集合本质是“批量版资源”,核心就两点:用对类、交由框架自动处理映射,别绕过它手动遍历。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

340

2024.04.09

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

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

293

2024.04.09

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

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

772

2024.04.09

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

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

385

2024.04.10

laravel入门教程
laravel入门教程

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

141

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

80

2025.08.05

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

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

467

2026.03.04

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 13.4万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.3万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 1.0万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号