主頁 > 知識庫 > yii2 開發(fā)api接口時優(yōu)雅的處理全局異常的方法

yii2 開發(fā)api接口時優(yōu)雅的處理全局異常的方法

熱門標簽:咸寧銷售電銷機器人系統(tǒng) 電銷機器人問門薩維品牌my 余姚電話機器人 百度地圖標注偏差 開發(fā)地圖標注類網(wǎng)站 外呼系統(tǒng)能給企業(yè)帶來哪些好處 百度地圖怎樣標注圖標 400電話蘭州申請請 廣東廣州在怎么申請400電話

前言:個人覺得,學習或溫習一套Web框架,在快速閱讀一遍文檔后,應從路由,控制器,請求/響應對象,數(shù)據(jù)模型(Logic,Dao,Entity),全局異常處理幾個方面下手,這幾項了解后,框架上手就游刃有余了。然后我比較喜歡在開工前整理好框架的全局異常處理,方便寫 api時錯誤的統(tǒng)一響應。

api接口的開發(fā)過程中,我們需要對用戶數(shù)據(jù)進行嚴格的校驗,防止非法輸入對服務產(chǎn)生安全問題,在開發(fā)過程中,我比較喜歡即時的以拋出異常的方式中斷請求的處理,并以全局異常處理器格式化處理后統(tǒng)一返回給客戶端。

今天就把 yii2 自帶的全局異常處理器改寫至對 api 友好(yii2yii\web\HttpException默認對 web 請求友好,都是以text/html的方式返回錯誤描述,對api不友好,api當然是json)。

注冊異常處理器

yii2也是以 controller/action 的方式定義一個異常處理器的,我們可以在 components=>errorHandler中自定義。

# config/web.php
'components' => [
  'errorHandler' => [
    'errorAction' => 'exception/handler'
  ]
]

異常處理器

定義相應的異常處理器,app\actions\ErrorApiAction 繼承 yii\web\ErrorAction,可以拿到yii2為我們整理好的全局異常。

# controllers/ExceptionController.php
?php

namespace app\controllers;

use yii\web\Controller;

class ExceptionController extends Controller
{
  /**
   * 為 actionHandler 掛載獨立的 action
   * @return array
   */
  public function actions()
  {
    return [
      'handler' => [
        'class' => 'app\actions\ErrorApiAction',
      ]
    ];
  }
}

api友好的錯誤異常處理器,這里我也只是簡單的把響應格式改了一下,異常的上下文還是用yii2自帶的處理的。

#actions/ErrorApiAction.php
?php
/**
 * @author wangzhijian@styd.com
 * @date 2019-5-13 17:20:10
 * Api 全局錯誤異常處理器
 */

namespace app\actions;

use Yii;
use yii\web\ErrorAction;
use yii\web\Response;

class ErrorApiAction extends ErrorAction
{
  public function run()
  {
    // 根據(jù)異常類型設定相應的響應碼
    Yii::$app->getResponse()->setStatusCodeByException($this->exception);
    // json 格式返回
    Yii::$app->getResponse()->format = Response::FORMAT_JSON;
    // 返回的內容數(shù)據(jù)
    return [
      'msg' => $this->exception->getMessage(),
      'err' => $this->exception->getCode()
    ];
  }
}

異常實體

主要是簡單的把狀態(tài)碼的傳遞封裝一下,用更容易理解的類名來代理傳遞。
exceptions/HttpException.php

?php
/**
 * app 異?;A類
 */

namespace app\exceptions;

class HttpException extends \yii\web\HttpException
{
  public function __construct($message = null, $code = 0, \Exception $previous = null)
  {
    parent::__construct($this->statusCode, $message, $code, $previous);
  }
}

exceptions/HttpForbiddenException.php

?php
/**
 * 400 bad request
 */

namespace app\exceptions;

class HttpBadRequestException extends HttpException
{
  public $statusCode = 400;
}

exceptions/HttpUnauthorizedException.php

?php
/**
 * 401 unauthorized
 */

namespace app\exceptions;

class HttpUnauthorizedException extends HttpException
{
  public $statusCode = 401;
}

exceptions/HttpForbiddenException.php

?php
/**
 * 403 forbidden
 */

namespace app\exceptions;

class HttpForbiddenException extends HttpException
{
  public $statusCode = 403;
}

exceptions/HttpNotFoundException.php

?php
/**
 * 404 not found
 */

namespace app\exceptions;

class HttpNotFoundException extends HttpException
{
  public $statusCode = 404;
}

使用范例

在一些 service logic model 中根據(jù)需要即時拋出異常即可,上層控制器拿到的永遠都是正常的返回數(shù)據(jù),絕對的2xx響應簇

throw new HttpBadRequestException("具體的非法描述", 4001);
throw new HttpUnauthorizedException("請認證后訪問");
throw new HttpForbiddenException("無權訪問");
throw new HttpNotFoundException("請求資源不存在");

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。

您可能感興趣的文章:
  • 實例講解如何在PHP的Yii框架中進行錯誤和異常處理
  • YII Framework教程之異常處理詳解

標簽:臨沂 麗江 鷹潭 衡陽 巴彥淖爾 十堰 重慶 銅陵

巨人網(wǎng)絡通訊聲明:本文標題《yii2 開發(fā)api接口時優(yōu)雅的處理全局異常的方法》,本文關鍵詞  yii2,開發(fā),api,接口,時,優(yōu)雅,;如發(fā)現(xiàn)本文內容存在版權問題,煩請?zhí)峁┫嚓P信息告之我們,我們將及時溝通與處理。本站內容系統(tǒng)采集于網(wǎng)絡,涉及言論、版權與本站無關。
  • 相關文章
  • 下面列出與本文章《yii2 開發(fā)api接口時優(yōu)雅的處理全局異常的方法》相關的同類信息!
  • 本頁收集關于yii2 開發(fā)api接口時優(yōu)雅的處理全局異常的方法的相關信息資訊供網(wǎng)民參考!
  • 推薦文章