Yii2框架的API错误处理_自定义错误响应格式【指南】

梦芳姑娘_8821

梦芳姑娘_8821

2026-03-24

881人浏览

原创

必须替换 yii2 默认 errorhandler 的 renderexception 行为,在 components 中配置自定义 erroraction 并在 actionerror 中统一返回 json 格式 {“code”:xxx, “message”:”xxx”},同时映射 http 状态码到业务码、截取堆栈、记录日志。

yii2框架的api错误处理_自定义错误响应格式【指南】

Yii2 API 错误响应被截断或格式混乱

默认情况下,Yii2 的 yii\web\ErrorHandler 会把异常渲染成 HTML 页面——这对 API 来说完全不可用。你看到的可能是空响应、500 页面源码、或者 JSON 里混着 HTML 标签。

  • 必须禁用 HTML 渲染:在 config/web.php 中确保 'errorHandler' => ['errorAction' => 'site/error'] 被移除或重定向到纯 JSON action
  • 更稳妥的做法是直接关闭 yii\web\ErrorHandler 对 API 请求的接管:在 bootstrap 阶段或 beforeAction 中判断 Yii::$app->request->getIsAjax() || Yii::$app->request->getIsJson(),手动 throw HttpException 并由自定义响应处理器捕获
  • 别依赖 responseFormat = Response::FORMAT_JSON 全局设置——它只影响正常返回,不接管错误流

如何让所有异常统一输出为 {“code”:xxx, “message”:”xxx”}

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

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

然后在 controllers/ApiController.php 里写一个 actionError():

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
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' => [],
        ];
    }
}
  • 注意:这个 action 必须返回数组(Yii2 会自动 JSON 化),不能 echo 或 die
  • $exception->statusCode 对 HttpException 有效,但对 Exception 是 null,得兜底
  • 别在 actionError 里再 throw 异常,否则二次进入 error handler,可能死循环

400/401/403/404 这些状态码怎么精准映射到自定义字段

靠人工 if-else 判断 $exception instanceof 太脆弱。推荐用 yii\web\HttpException 子类 + 自定义 code 映射表:

// 在 actionError 里
$codeMap = [
    400 => 10001,
    401 => 10002,
    403 => 10003,
    404 => 10004,
    500 => 50000,
];
$statusCode = $exception->statusCode ?: 500;
$apiCode = $codeMap[$statusCode] ?? 50000;
  • 401 和 403 容易混淆:认证失败(token 过期)用 401,权限不足(有 token 但没权限)用 403
  • 不要把数据库唯一约束失败硬塞进 400 —— 更合适的是捕获 IntegrityConstraintViolationException,转成 400 + code=20001
  • Yii2 默认的 NotFoundHttpException 是 404,但前端可能需要区分“资源不存在”和“接口不存在”,这时得自定义子类

调试时看不到真实错误堆栈,只看到“Internal Server Error”

生产环境关闭 YII_DEBUG 后,yii\web\ErrorHandler 会隐藏堆栈信息。但 API 调试阶段需要它,又不能暴露给前端。

  • 加个开关逻辑:检查请求头 Authorization 或 IP 白名单,白名单内才返回 trace 字段
  • 别把 $exception->getTraceAsString() 直接塞进响应——太长且含敏感路径,用 array_slice($exception->getTrace(), 0, 5) 截取前 5 层即可
  • 日志必须记全量:Yii::error($exception, 'api'),否则线上出问题根本没法回溯

真正麻烦的不是格式统一,而是异常源头分散:验证规则抛的、DB 层抛的、第三方 SDK 抛的……每个都得有对应转换逻辑,漏一个,API 就崩一次静默错误。

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

相关文章

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

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

下载

相关标签:

yii

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2135

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3282

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1116

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

3759

7

bootstrap框架介绍
bootstrap框架介绍

本专题整合了bootstrap框架相关介绍,阅读专题下面的文章了解更多详细内容。

2026.03.18

705

21

bootstrap安装教程
bootstrap安装教程

本专题整合了bootstrap安装相关教程,阅读专题下面的文章了解更多详细操作教程。

2026.03.18

199

9

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

2024.03.01

1678

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习

Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习