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

Hyperf自定义异常类输出接口报错详情

老明吖_6577

老明吖_6577

发布时间:2026-08-15 16:25:36

|

700人浏览过

|

来源于php中文网

原创

Hyperf自定义异常需三者协同:定义继承RuntimeException的业务异常类(含code/message)、编写精准匹配并调用stopPropagation()的异常处理器、按优先级在exceptions.php中注册;否则默认返回500或空响应。

hyperf自定义异常类输出接口报错详情

Hyperf 自定义异常类输出接口报错详情,核心在于异常类 + 异常处理器 + 响应格式三者协同,不能只抛一个异常就指望自动返回结构化错误信息。默认情况下,Hyperf 会把未捕获异常转为 500 页面或空响应,必须主动干预。

1. 定义业务异常类(带 code 和 message)

继承 RuntimeException 即可,无需特殊接口。重点是构造时传入业务码和提示,方便后续提取:

  • code 用于 JSON body 中的业务错误码(如 1001、2002),不是 HTTP 状态码
  • message 是面向前端或日志的简明提示,比如“用户不存在”
  • 不要重写 getCode() 方法——它默认返回构造参数,够用

示例:/app/Exception/UserNotFoundException.php

<?php
namespace App\Exception;

class UserNotFoundException extends \RuntimeException
{
}
// 使用:throw new UserNotFoundException('用户不存在', 1001);

2. 编写专用异常处理器(精准匹配 + 终止传播)

处理器必须实现 isValid() 严格判断类型,并在 handle() 中手动设置状态码、构造 JSON、调用 stopPropagation():

  • HTTP status 固定用 4xx/5xx(如 404),别把业务码 1001 当 status 传给 withStatus()
  • JSON body 包含 code(业务码)、message(提示)、trace_id(可选,便于查日志)
  • 漏掉 $this->stopPropagation() 会导致异常继续传递,可能被后续兜底处理器覆盖成 500

示例:/app/Exception/Handler/UserNotFoundHandler.php

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载
<?php
namespace App\Exception\Handler;

use App\Exception\UserNotFoundException;
use Hyperf\ExceptionHandler\ExceptionHandler;
use Hyperf\HttpMessage\Stream\SwooleStream;
use Psr\Http\Message\ResponseInterface;
use Throwable;

class UserNotFoundHandler extends ExceptionHandler
{
    public function handle(Throwable $throwable, ResponseInterface $response)
    {
        $this->stopPropagation();

        $data = json_encode([
            'code' => $throwable->getCode(),
            'message' => $throwable->getMessage(),
            'trace_id' => $this->container->get(\Hyperf\Tracer\Tracer::class)->getTraceId() ?? '',
        ], JSON_UNESCAPED_UNICODE);

        return $response->withStatus(404)->withBody(new SwooleStream($data));
    }

    public function isValid(Throwable $throwable): bool
    {
        return $throwable instanceof UserNotFoundException;
    }
}

3. 注册到配置并注意顺序

在 config/autoload/exceptions.php 的 http 数组中注册,且必须放在 HttpExceptionHandler 之后:

  • 如果放太前,连 404、405 这类框架原生异常也会被你拦截,导致前端收不到正确 status
  • 数组顺序 = 匹配优先级,越靠前越先试 isValid()

正确配置示例:

return [
    'handler' => [
        'http' => [
            // 框架内置兜底,处理所有 HttpException 子类(含 404/405)
            Hyperf\HttpServer\Exception\Handler\HttpExceptionHandler::class,
            // 自定义处理器,仅处理特定业务异常
            App\Exception\Handler\UserNotFoundHandler::class,
            App\Exception\Handler\AppExceptionHandler::class,
        ],
    ],
];

4. 触发验证与调试技巧

在控制器中直接抛出测试,用 curl 或 Postman 请求,观察响应:

  • 响应 status 应为 404,body 是标准 JSON,含 code 和 message
  • 查看 runtime/logs/hyperf.log,确认是否只有一条该异常的日志(若重复出现,说明 stopPropagation() 没生效)
  • 开启调试模式(SWOOLE_LOG_LEVEL=5)可看到异常传递链路

不复杂但容易忽略。

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

DeepSeek

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

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

Seko
Seko Hot

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

9324

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

5621

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2035

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

3508

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

4174

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

3271

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

4657

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

3642

2023.11.13

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

60

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.2万人学习

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

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