laravel中Dingo api如何Custom ExceptionHandler

背景

• 在近期使用Dingo api處理接口時，發現laravel自己appExceptionsHandler中沒法捕獲異常。
• 後來查閱資料發現，Dingo api接管了api請求的異常處理。致使沒法自定義錯誤返回，非常頭疼。
• 最後在dingo的issues找到了處理方法。

方法

• 建立一個自定義異常處理

  繼承自Dingo\Api\Exception\Handler，重寫handle方法
    app/Exceptions/ApiHandler.php

  <?php
  
  namespace App\Exceptions;
  
  use Exception;
  use Dingo\Api\Exception\Handler as DingoHandler;
  
  class ApiHandler extends DingoHandler
  {
      public function handle(Exception $exception)
      {
          if ($exception instanceof \Illuminate\Auth\AuthenticationException) {
              return response()->json(['message' => 'Unauthorized', 'status_code' => 401], 401);
          }
          return parent::handle($exception);
      }
  }

• 建立一個服務容器

  app/Providers/DingoServiceProvider.php

  <?php
  
  namespace App\Providers;
  
  use Dingo\Api\Provider\DingoServiceProvider as DingoServiceProviders;
  use App\Exceptions\ApiHandler as ExceptionHandler;
  
  class DingoServiceProvider extends DingoServiceProviders
  {
  
      protected function registerExceptionHandler()
      {
          $this->app->singleton('api.exception', function ($app) {
              return new ExceptionHandler($app['Illuminate\Contracts\Debug\ExceptionHandler'], $this->config('errorFormat'), $this->config('debug'));
          });
      }
  }

• 將服務容器添加到config/app.php中

  ...
  'providers' => [
  ...
      App\Providers\DingoServiceProvider::class,
  ...
  ];

結語

• 參考issues連接：https://github.com/dingo/api/... @shanginn 提供的方法會存在接口返回500，且沒有任何數據返回。