错误异常处理

当程序出现错误或者异常时，我们一般会希望在开发时输出报错信息，在生产环境时隐藏详细的信息。

在 IMI 中，提供了 Http 服务的错误异常默认处理器支持。

默认 Http 错误处理器：Imi\Server\Http\Error\JsonErrorHandler

指定默认处理器

配置文件中：

  1. return [
  2.     'beans'    =>    [
  3.         'HttpErrorHandler'    =>    [
  4.             // 指定默认处理器
  5.             'handler'    =>    \Imi\Server\Http\Error\JsonErrorHandler::class,
  6.         ],
  7.     ],
  8. ];

处理器参数设置

  1. return [
  2.     'beans'    =>    [
  3.         \Imi\Server\Http\Error\JsonErrorHandler::class    =>    [
  4.             // debug 为 false时也显示错误信息
  5.             'releaseShow'    =>    false,
  6.             // 取消继续抛出异常
  7.             'cancelThrow'    =>    true,
  8.         ],
  9.     ],
  10. ];

编写处理器

如下代码所示，实现IErrorHandler接口，handle()方法返回值为true时则取消继续抛出异常。

  1. <?php
  2. namespace Imi\Server\Http\Error;
  4. use Imi\App;
  5. use Imi\RequestContext;
  6. use Imi\Util\Format\Json;
  7. use Imi\Util\Http\Consts\MediaType;
  8. use Imi\Util\Http\Consts\RequestHeader;
  10. class JsonErrorHandler implements IErrorHandler
  11. {
  12.     /**
  13.      * debug 为 false时也显示错误信息
  14.      * @var boolean
  15.      */
  16.     protected $releaseShow = false;
  18.     /**
  19.      * 取消继续抛出异常
  20.      * @var boolean
  21.      */
  22.     protected $cancelThrow = true;
  24.     public function handle(\Throwable $throwable): bool
  25.     {
  26.         if($this->releaseShow || App::isDebug())
  27.         {
  28.             $data = [
  29.                 'message'    =>    $throwable->getMessage(),
  30.                 'code'        =>    $throwable->getCode(),
  31.                 'file'        =>    $throwable->getFile(),
  32.                 'line'        =>    $throwable->getLine(),
  33.                 'trace'        =>    explode(PHP_EOL, $throwable->getTraceAsString()),
  34.             ];
  35.         }
  36.         else
  37.         {
  38.             $data = [
  39.                 'success'    =>    false,
  40.                 'message'    =>    'error',
  41.             ];
  42.         }
  43.         RequestContext::get('response')
  44.         ->withAddedHeader(RequestHeader::CONTENT_TYPE, MediaType::APPLICATION_JSON)
  45.         ->write(Json::encode($data))
  46.         ->send();
  47.         return $this->cancelThrow;
  48.     }
  49. }