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' => [...] 把分页信息包进一个顶层字段

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2519

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1598

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1493

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1416

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

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

共137课时 | 8.6万人学习

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

共6课时 | 7万人学习

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

共13课时 | 0.9万人学习

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

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