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

第yii2開(kāi)發(fā)api接口時(shí)優(yōu)雅的處理全局異常的方法前言：個(gè)人覺(jué)得，學(xué)習(xí)或溫習(xí)一套Web框架，在快速閱讀一遍文檔后，應(yīng)從路由，控制器，請(qǐng)求/響應(yīng)對(duì)象，數(shù)據(jù)模型（Logic，Dao，Entity），全局異常處理幾個(gè)方面下手，這幾項(xiàng)了解后，框架上手就游刃有余了。然后我比較喜歡在開(kāi)工前整理好框架的全局異常處理，方便寫(xiě)api時(shí)錯(cuò)誤的統(tǒng)一響應(yīng)。

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

今天就把yii2自帶的全局異常處理器改寫(xiě)至對(duì)api友好（yii2的yii\web\HttpException默認(rèn)對(duì)web請(qǐng)求友好，都是以text/html的方式返回錯(cuò)誤描述，對(duì)api不友好，api當(dāng)然是json）。

注冊(cè)異常處理器

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

#config/web.php

'components'=[

'errorHandler'=[

'errorAction'='exception/handler'

]

異常處理器

定義相應(yīng)的異常處理器，app\actions\ErrorApiAction繼承yii\web\ErrorAction，可以拿到y(tǒng)ii2為我們整理好的全局異常。

#controllers/ExceptionController.php

namespaceapp\controllers;

useyii\web\Controller;

classExceptionControllerextendsController

*為actionHandler掛載獨(dú)立的action

*@returnarray

publicfunctionactions()

return[

'handler'=[

'class'='app\actions\ErrorApiAction',

}

對(duì)api友好的錯(cuò)誤異常處理器，這里我也只是簡(jiǎn)單的把響應(yīng)格式改了一下，異常的上下文還是用yii2自帶的處理的。

#actions/ErrorApiAction.php

*@authorwangzhijian@

*@date2025-5-1317:20:10

*Api全局錯(cuò)誤異常處理器

namespaceapp\actions;

useYii;

useyii\web\ErrorAction;

useyii\web\Response;

classErrorApiActionextendsErrorAction

publicfunctionrun()

//根據(jù)異常類(lèi)型設(shè)定相應(yīng)的響應(yīng)碼

Yii::$app-getResponse()-setStatusCodeByException($this-exception);

//json格式返回

Yii::$app-getResponse()-format=Response::FORMAT_JSON;

//返回的內(nèi)容數(shù)據(jù)

return[

'msg'=$this-exception-getMessage(),

'err'=$this-exception-getCode()

}

異常實(shí)體

主要是簡(jiǎn)單的把狀態(tài)碼的傳遞封裝一下，用更容易理解的類(lèi)名來(lái)代理傳遞。

exceptions/HttpException.php

*app異常基礎(chǔ)類(lèi)

namespaceapp\exceptions;

classHttpExceptionextends\yii\web\HttpException

publicfunction__construct($message=null,$code=0,\Exception$previous=null)

parent::__construct($this-statusCode,$message,$code,$previous);

}

exceptions/HttpForbiddenException.php

*400badrequest

namespaceapp\exceptions;

classHttpBadRequestExceptionextendsHttpException

public$statusCode=400;

}

exceptions/HttpUnauthorizedException.php

*401unauthorized

namespaceapp\exceptions;

classHttpUnauthorizedExceptionextendsHttpException

public$statusCode=401;

}

exceptions/HttpForbiddenException.php

*403forbidden

namespaceapp\exceptions;

classHttpForbiddenExceptionextendsHttpException

public$statusCode=403;

}

exceptions/HttpNotFoundException.php

*404notfound

namespaceapp\exceptions;

classHttpNotFoundExceptionextendsHttpException

public$statusCode=404;

}

使用范例

在一些servicelogicmodel中根據(jù)需要即時(shí)拋出異常即可，上層控制器拿到的永遠(yuǎn)都是正常的返回?cái)?shù)據(jù)，絕對(duì)的2xx響應(yīng)簇

thrownewHttpBadRequestException("具體的非法描述",4001);

thrownewHttpUnauthorizedExcep