0

0

Laravel响应JSON怎么写 Laravel如何自定义接口返回 【标准】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-03-06 09:50:04

|

246人浏览过

|

来源于php中文网

原创

laravel响应json怎么写 laravel如何自定义接口返回 【标准】

直接用 response()->json() 最稳妥

Laravel 默认的 JSON 响应走的就是这个函数,它自动设置 Content-Type: application/json、处理数组/对象序列化、兼容中文不乱码。别自己拼 json_encode() + header(),容易漏状态码或 MIME 类型。

常见错误现象:response()->json($data)->status(200) 写成 response()->json($data, 200) —— 后者第二个参数其实是“JSON 选项”,不是 HTTP 状态码;状态码得用 status() 链式调用或传第三个参数。

  • response()->json(['msg' => 'ok'], 200) ✅ 正确:第二个参数是状态码(仅当没用 status() 时才生效)
  • response()->json(['msg' => 'ok'], JSON_UNESCAPED_UNICODE) ❌ 错误:这会把状态码当成 JSON 选项,返回 500 或空响应
  • 如果要加 JSON 选项(比如不转义中文),写成 response()->json($data, 200, [], JSON_UNESCAPED_UNICODE)

自定义结构统一用 API Resource(别在控制器里硬编码)

接口字段经常要隐藏敏感字段、格式化时间、嵌套关联数据——这些逻辑塞进控制器会让代码越来越难维护,也违背 Laravel 的分层原则。

使用场景:用户列表接口要返回 idnamecreated_at 格式化为 “Y-m-d H:i”,且不返回 passwordemail_verified_at

  • 运行 php artisan make:resource UserResource
  • UserResourcetoArray() 方法里控制输出:return ['id' => $this->id, 'name' => $this->name, 'created_at' => $this->created_at->format('Y-m-d H:i')];
  • 控制器里直接 return new UserResource($user);UserResource::collection($users);

性能影响:Resource 是惰性求值,不会提前触发 N+1 查询;但别在 toArray() 里写 DB 查询,那会破坏它的设计意图。

全局统一响应格式建议封装到基类或中间件,而非每个接口都写

所谓“标准”响应,比如 { "code": 0, "msg": "success", "data": {} },手动在每个接口里包一层,后期改字段名或加字段会疯掉。

AI神器大全
AI神器大全

AI工具集合导航站

下载

容易踩的坑:有人用中间件统一包裹响应,结果把文件下载、重定向、视图响应也给 JSON 化了,导致 PDF 打不开或跳转失效。

  • 只对 JsonResponse 类型做处理,判断 $response instanceof \Illuminate\Http\JsonResponse
  • 更推荐方式:写一个基控制器方法,比如 success($data = null, $msg = 'success', $code = 0),内部调用 response()->json(compact('code', 'msg', 'data'))
  • 避免在中间件里修改响应体内容,尤其涉及加密、签名等逻辑——它可能被缓存或压缩,顺序难控

ApiResourceJsonResource 别混用,Laravel 9+ 已弃用后者

Laravel 9 开始,JsonResource 被标记为废弃,官方文档和源码都指向 ApiResource(即 Illuminate\Http\Resources\Json\JsonResource 的别名)。虽然现在还能用,但升级后会报 E_USER_DEPRECATED。

参数差异很小,但命名和继承路径不同:

  • 旧写法:class UserResource extends JsonResource —— Laravel 8 及以前
  • 新写法:class UserResource extends ApiResource —— Laravel 9+ 推荐,且 IDE 支持更好
  • 两者都支持 withoutWrapping()preserveKeys() 等方法,行为一致

兼容性影响:如果你项目还在 Laravel 8,暂时不用急着改;但新项目或准备升级的,直接用 ApiResource 更省心。别等到升级时报一堆 deprecated warning 才回头翻。

真正复杂的是错误响应的统一处理——比如 404、422、500 怎么也套进你的标准结构里,这部分没法靠 Resource 解决,得配合异常渲染器或 render() 方法定制,而且要小心别把框架原生错误信息暴露出去。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

339

2024.04.09

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

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

291

2024.04.09

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

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

728

2024.04.09

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

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

384

2024.04.10

laravel入门教程
laravel入门教程

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

135

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

76

2025.08.05

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

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

113

2026.03.04

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

1

2026.03.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

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

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