Yii框架错误格式化怎么改_Yii框架API异常返回统一标准【规范】

轻涛君_5735

轻涛君_5735

2026-05-05

284人浏览

原创

禁用 yii 默认 html 异常渲染需重写 errorhandler 组件并指定 erroraction 为 api 错误处理动作,使所有异常返回标准 json 格式 {code, message, data},并通过状态码映射表统一转换 http 状态到业务 code。

yii框架错误格式化怎么改_yii框架api异常返回统一标准【规范】

Yii 框架默认把所有异常渲染成 HTML 页面,API 请求拿到的要么是空响应、要么是混着 标签的 JSON,根本没法被客户端正常解析。必须绕过 yii\web\ErrorHandler 的 HTML 渲染链,让所有错误走纯 JSON 流程。

怎么禁用 ErrorHandler 的 HTML 渲染?

别指望靠 'responseFormat' => \yii\web\Response::FORMAT_JSON 全局配置——它只管正常返回,不管异常。关键动作是切断 yii\web\ErrorHandler 对 API 请求的接管:

  • 在 config/web.php 的 components 里移除或重写 'errorHandler' => ['errorAction' => 'site/error']
  • 更稳妥的做法:在应用启动早期(比如 bootstrap 或 beforeAction)判断请求类型:Yii::$app->request->getIsJson() || Yii::$app->request->getIsAjax()
  • 满足条件时,直接 throw new \yii\web\HttpException(400, 'Bad Request'),让自定义响应处理器捕获,而不是交给默认 handler 渲染 HTML

如何让 actionError 返回标准 {“code”, “message”, “data”}?

核心不是改 view,而是替换 renderException() 行为。最轻量方式是在 components 中注册自定义 error handler:

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
'errorHandler' => [
    'class' => 'yii\web\ErrorHandler',
    'errorAction' => 'api/error',
],

然后在 controllers/ApiController.php 实现 actionError():

public function actionError()
{
    $exception = Yii::$app->errorHandler->exception;
    if ($exception !== null) {
        Yii::$app->response->statusCode = $exception->statusCode ?: 500;
        return [
            'code' => $exception->getCode() ?: 50000,
            'message' => $exception->getMessage(),
            'data' => [],
        ];
    }
}
  • $exception->statusCode 只对 HttpException 子类有效,普通 Exception 是 null,必须兜底设为 500
  • 这个 action 必须返回数组,Yii2 会自动 JSON 化;不能 echo 或 die
  • 千万别在 actionError 里再 throw 异常,否则二次进入 error handler,可能死循环

400/401/403/404 状态码怎么映射到业务 code?

硬写 if ($exception instanceof \yii\web\BadRequestHttpException) 太脆弱。推荐用状态码查表映射:

$codeMap = [
    400 => 10001,
    401 => 10002,
    403 => 10003,
    404 => 10004,
    500 => 50000,
];
$code = $codeMap[$exception->statusCode] ?? 50000;
  • 不要依赖 $exception->getCode() 做业务区分——它常是 0,且和 HTTP 状态码语义不一致
  • 如果项目用了自定义异常类(如 ApiBadRequestException),可以在构造时显式传入业务 code,比查表更可控
  • 注意:422(验证失败)这类状态码容易被忽略,要单独加进映射表,否则前端收不到明确提示

真正难的不是格式化,而是确保所有入口(控制器、过滤器、模型验证、数据库层抛出的异常)都经过同一套响应管道。漏掉一个 try/catch 或一个未注册的 filter,就可能冒出原始堆栈或 HTML 片段。

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

相关文章

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

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

下载

相关标签:

yii框架 yii

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

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

544

16

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.18

989

5

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.25

3040

5

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

3070

22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

20

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

0

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

20

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

0

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

20

25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习