Laravel框架资源怎么用_Laravel框架API查询转换技巧【解答】

风萱君_8864

风萱君_8864

2026-04-20

495人浏览

原创

laravel中将eloquent模型转为api响应数据必须使用资源机制,包括:一、api资源类标准转换;二、模型访问器动态格式化;三、资源内闭包查询关联数据;四、可见性控制字段输出;五、模型作用域封装查询逻辑。

laravel框架资源怎么用_laravel框架api查询转换技巧【解答】

如果您在Laravel项目中需要将Eloquent模型转换为结构清晰、安全可控的API响应数据,则必须借助框架内置的资源(Resources)机制。以下是实际可用的多种实现方式:

一、使用API资源类进行标准转换

API资源类是Laravel官方推荐的数据格式化层,它将模型实例封装并定义其JSON输出结构,避免控制器中混杂数据组装逻辑。该方式适用于单个模型或集合的标准化输出。

1、执行Artisan命令生成资源类:php artisan make:resource UserResource

2、编辑app/Http/Resources/UserResource.php文件,在toArray()方法中定义字段映射:

3、在控制器中返回资源实例:return new UserResource($user);

4、若需返回多个模型,使用集合资源:return UserResource::collection($users);

二、利用模型访问器动态转换字段

访问器在模型属性被读取时自动触发,适合对原始字段做轻量级、通用性格式化(如价格单位换算、状态码转文字),无需额外资源类即可生效,且对调用方完全透明。

1、在模型中定义访问器方法,命名格式为get{CamelCase}Attribute:

2、例如将数据库中以“分”存储的价格转为带符号的“元”:protected function getPriceAttribute($value) { return '¥' . number_format($value / 100, 2); }

3、在控制器中直接访问:$user->price 即获得格式化后结果

4、如需同时暴露原始值与加工值,配合$appends声明附加属性:

三、在资源类中嵌套闭包查询获取关联数据

当关联数据需按当前模型属性动态过滤(如仅查本公司的地址),不能依赖预加载的静态关系时,可在资源类toArray()中使用闭包查询,并通过use捕获模型属性值,确保上下文隔离与类型安全。

1、在UserResource的toArray()中提前提取关键字段:$companyId = $this->company_id ?? null;

laravel-specialist
laravel-specialist

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

下载

2、构建带条件的关联查询:

3、使用when()方法处理空值情形:->when($companyId, fn($q) => $q->where('company_id', $companyId))

4、将查询结果传入嵌套资源:AddressResource::collection(Address::query()->...->get())

四、通过模型可见性控制字段输出

不依赖资源类时,可直接操作模型实例的可见字段集合,适用于快速调试、临时接口或简单场景。该方式绕过资源层,但缺乏复用性与结构约束。

1、调用makeVisible()显式声明需暴露的字段:$user->makeVisible(['id', 'name', 'email']);

2、调用makeHidden()屏蔽敏感字段:$user->makeHidden(['password', 'remember_token']);

3、调用toArray()生成精简数组:$user->toArray();

4、最终转为JSON响应:$user->toJson(JSON_UNESCAPED_UNICODE);

五、结合模型作用域封装复杂查询逻辑

将资源内重复出现的查询条件抽象为模型作用域,提升可读性、可测试性与复用性。作用域定义在模型中,资源类仅负责调用,职责分离明确。

1、在Address模型中定义作用域方法:public function scopeForCompanyAndContactType($query, $companyId)

2、作用域内部组合条件:return $query->where('company_id', $companyId)->where(function ($q) { $q->where('is_shipping', 1)->orWhere('is_billing', 1); });

3、在资源类中调用该作用域:Address::forCompanyAndContactType($this->company_id)->get()

4、将结果交由对应资源类处理:AddressResource::collection(...)

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

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

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

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

2024.04.09

857

10

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

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

2024.04.09

835

9

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

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

2024.04.09

2488

10

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

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

2024.04.10

4281

7

laravel入门教程
laravel入门教程

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

2025.08.05

6170

22

laravel实战教程
laravel实战教程

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

2025.08.05

4076

13

laravel面试题
laravel面试题

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

2025.08.05

7669

7

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

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

2026.03.04

1476

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

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

共1课时 | 210人学习

Composer手册
Composer手册

共0课时 | 0人学习