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

Laravel自定义异常渲染_为API请求返回JSON错误【操作】

胖婷小哥_6970

胖婷小哥_6970

发布时间:2026-05-10 15:05:36

|

684人浏览过

|

来源于php中文网

原创

关键在于用$request->expectsJson()或$request->is('api/*')判断API请求,优先复用parent::render(),再针对ModelNotFoundException、AuthenticationException等特定异常返回标准化JSON响应,并确保Content-Type正确。

laravel自定义异常渲染_为api请求返回json错误【操作】

如何在 Laravel 中区分 API 和网页请求做异常响应

关键不是重写整个 render() 方法,而是利用 Laravel 自带的 $request->expectsJson() 判断逻辑。Laravel 的 App\Exceptions\Handler 默认已对 AJAX/JSON 请求做了基础处理,但常被忽略的是:它只在 Accept: application/json 存在或请求是 XHR 时才触发,而很多 API 客户端(如 Postman、curl)不带该 header,导致走网页错误页流程。

实操建议:

  • 不要删掉父类 parent::render($request, $exception),它内部已封装了 expectsJson() + 状态码映射逻辑
  • 若需强制对某类请求返回 JSON(比如所有 /api/* 路由),可在 render() 中提前拦截:
    if ($request->is('api/*') || $request->header('X-Requested-With') === 'XMLHttpRequest') {
        return response()->json([
            'message' => $exception->getMessage(),
            'error' => class_basename($exception),
        ], $this->getStatusCode($exception));
    }
  • 注意:Laravel 9+ 中 $this->getStatusCode($exception) 是私有方法,应改用 ResponseFactory::status() 或直接查 $exception->getStatusCode()(仅限 HttpException 及子类)

自定义 404 和 401 错误的 JSON 格式

默认的 NotFoundHttpException 和 AuthenticationException 渲染结果字段不统一,前端难处理。与其全局替换,不如针对具体异常类型定制。

实操建议:

  • 在 App\Exceptions\Handler::render() 中用 instanceof 匹配:
    if ($exception instanceof NotFoundHttpException) {
        return response()->json(['error' => 'resource_not_found'], 404);
    }
    if ($exception instanceof AuthenticationException) {
        return response()->json(['error' => 'unauthenticated'], 401);
    }
  • 避免硬编码状态码,优先调用 $exception->getStatusCode()(部分异常支持),否则 fallback 到固定值
  • 别在 AuthenticationException 处理中返回敏感信息(如 message),生产环境应始终返回泛化提示

捕获模型未找到异常并转为 404 JSON

ModelNotFoundException 默认渲染成 HTML 500 页面,但 API 场景下应统一为 404 JSON。它和 NotFoundHttpException 不同,不会被 Laravel 默认 JSON 化。

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载

实操建议:

  • 在 render() 中显式判断:
    if ($exception instanceof ModelNotFoundException) {
        return response()->json(['error' => 'record_not_found'], 404);
    }
  • 更稳妥的方式是配合路由模型绑定,在控制器中用 findOrFail() 并 try-catch,但违背了“异常即流程控制”的 Laravel 风格
  • 注意:Laravel 10+ 引入了 Illuminate\Database\Eloquent\ModelNotFoundException 全限定名,确保 use 正确,否则 instanceof 不生效

开发与生产环境的 JSON 错误细节控制

本地调试需要堆栈和消息,线上必须隐藏。很多人直接在 render() 里写 app()->environment('local'),但 Laravel 已提供 $this->isDebugMode()(Laravel 9+)或更底层的 config('app.debug')。

实操建议:

  • 构造 JSON 响应时,只在 debug 模式下暴露 trace 和 exception 字段:
    $data = ['error' => $exception->getMessage()];
    if (config('app.debug')) {
        $data['trace'] = $exception->getTraceAsString();
        $data['exception'] = get_class($exception);
    }
    return response()->json($data, $status);
  • 不要把 $exception->__toString() 直接塞进 JSON,可能含 HTML 实体或换行符,破坏 JSON 结构
  • 如果用了第三方异常追踪服务(如 Sentry),记得在 report() 方法里上报,而非 render() —— 后者只管输出,不该承担日志职责

真正容易被忽略的是:API 异常响应的 Content-Type 必须是 application/json,而不仅仅是返回 JSON 字符串。Laravel 的 response()->json() 会自动设 header,但如果手写 response(json_encode(...)) 就得自己补 ->header('Content-Type', 'application/json')。

热门AI工具

更多
豆包大模型

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

DeepSeek

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

WorkBuddy

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

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

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

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

897

2024.04.09

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

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

875

2024.04.09

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

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

2528

2024.04.09

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

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

4861

2024.04.10

laravel入门教程
laravel入门教程

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

7110

2025.08.05

laravel实战教程
laravel实战教程

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

4676

2025.08.05

laravel面试题
laravel面试题

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

8749

2025.08.05

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

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

1516

2026.03.04

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

共1课时 | 224人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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