异常处理器

在 Hyperf 里，业务代码都运行在 Worker进程 上，也就意味着一旦任意一个请求的业务存在没有捕获处理的异常的话，都会导致对应的 Worker进程 被中断退出，虽然被中断的 Worker进程 仍会被重新拉起，但对服务而言也是不能接受的，且捕获异常并输出合理的报错内容给客户端也是更加友好的。我们可以通过对各个 server 定义不同的 异常处理器(ExceptionHandler)，一旦业务流程存在没有捕获的异常，都会被传递到已注册的 异常处理器(ExceptionHandler) 去处理。

自定义一个异常处理

注册异常处理器

目前仅支持配置文件的形式注册 异常处理器(ExceptionHandler)，配置文件位于 config/autoload/exceptions.php，将您的自定义异常处理器配置在对应的 server 下即可：

  1. <?php
  2. // config/autoload/exceptions.php
  3. return [
  4.     'handler' => [
  5.         // 这里的 http 对应 config/autoload/server.php 内的 server 所对应的 name 值
  6.         'http' => [
  7.             // 这里配置完整的类命名空间地址已完成对该异常处理器的注册
  8.             \App\Exception\Handler\FooExceptionHandler::class,
  9.         ],    
  10.     ],
  11. ];

每个异常处理器配置数组的顺序决定了异常在处理器间传递的顺序。

定义异常处理器

我们可以在任意位置定义一个 类(Class) 并继承抽象类 Hyperf\ExceptionHandler\ExceptionHandler 并实现其中的抽象方法，如下：

  1. <?php
  2. namespace App\Exception\Handler;
  4. use Hyperf\ExceptionHandler\ExceptionHandler;
  5. use Hyperf\HttpMessage\Stream\SwooleStream;
  6. use Psr\Http\Message\ResponseInterface;
  7. use App\Exception\FooException;
  8. use Throwable;
  10. class FooExceptionHandler extends  ExceptionHandler
  11. {
  12.     public function handle(Throwable $throwable, ResponseInterface $response)
  13.     {
  14.         // 判断被捕获到的异常是希望被捕获的异常
  15.         if ($throwable instanceof FooException) {
  16.             // 格式化输出
  17.             $data = json_encode([
  18.                 'code' => $throwable->getCode(),
  19.                 'message' => $throwable->getMessage(),
  20.             ], JSON_UNESCAPED_UNICODE);
  22.             // 阻止异常冒泡
  23.             $this->stopPropagation();
  24.             return $response->withStatus(500)->withBody(new SwooleStream($data));
  25.         }
  27.         // 交给下一个异常处理器
  28.         return $response;
  30.         // 或者不做处理直接屏蔽异常
  31.     }
  33.     /**
  34.      * 判断该异常处理器是否要对该异常进行处理
  35.      */
  36.     public function isValid(Throwable $throwable): bool
  37.     {
  38.         return true;
  39.     }
  40. }

定义异常类

  1. <?php
  2. namespace App\Exception;
  4. use App\Constants\ErrorCode;
  5. use Hyperf\Server\Exception\ServerException;
  6. use Throwable;
  8. class FooException extends ServerException
  9. {
  10. }

触发异常


namespace App\Controller;

use App\Exception\FooException;

class IndexController extends Controller
{
    public function index()
    {
        throw new FooException('Foo Exception...', 800);
    }
}

在上面这个例子，我们先假设 FooException 是存在的一个异常，以及假设已经完成了该处理器的配置，那么当业务抛出一个没有被捕获处理的异常时，就会根据配置的顺序依次传递，整一个处理流程可以理解为一个管道，若前一个异常处理器调用 $this->stopPropagation() 则不再往后传递，若最后一个配置的异常处理器仍不对该异常进行捕获处理，那么就会交由 Hyperf 的默认异常处理器处理了。