怎么在PHP的Yii框架中進行錯誤和異常處理

小編給大家分享一下怎么在PHP的Yii框架中進行錯誤和異常處理，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

Yii已經(jīng)默認已經(jīng)在CApplication上實現(xiàn)了異常和錯誤的接管，這是通過php的set_exception_handler，set_error_handler實現(xiàn)的。通過這兩個PHP內(nèi)置函數(shù)，可以對程序中未捕獲的異常以及錯誤進行接管處理，從而提高程序的可維護性。這在大型系統(tǒng)是至關(guān)重要的，當發(fā)生錯誤時，我們希望能將相關(guān)詳細信息記錄，甚至是即時發(fā)送報警，從而縮短故障修復(fù)時間，提高整個系統(tǒng)的穩(wěn)定性。
默認情況下，Yii會將異常處理分配給CApplication::handleException, 將錯誤處理分配給CApplication::handleError，但是可以通過在入口文件中定義YII_ENABLE_EXCEPTION_HANDLER, YII_ENABLE_ERROR_HANDLER兩個常量為false禁止使用Yii的異常和錯誤接管機制。
以下內(nèi)容中，將異常和錯誤統(tǒng)稱為錯誤，如有必要會進行詳細區(qū)分說明。YII_DEBUG常量（默認為false, 可以在入口文件中設(shè)置）對錯誤信息的顯示有很重要的影響，debug模式下，錯誤的輸出是最詳細的。而程序一旦投入運行，則應(yīng)將YII_DEBUG修改為false。
無論是否處于debug模式，Yii程序產(chǎn)生錯誤時均會將相關(guān)錯誤信息進行記錄(錯誤級別為error, 分類默認為application)。不同之處是debug模式時會直接在web頁上顯示詳細信息。

CApplication:: handleError($code,$message,$file,$line)

上面的方法實現(xiàn)了相關(guān)邏。特別注意restore_error_handler,restore_exception_handler兩個函數(shù)，如果沒有這兩個函數(shù)的調(diào)用，那么在后續(xù)的錯誤處理過程中，當再次產(chǎn)生異?；蚴清e誤時，又會調(diào)用CApplication:: handleError ，從而可能造成死循環(huán)，故Yii在此處臨時禁止了使用CApplication:: handleError 接管后續(xù)的錯誤和異常(使用php默認的錯誤處理機制)，這就保證了不會因之產(chǎn)生循環(huán)調(diào)用。
PHP錯誤的處理當產(chǎn)生錯誤時，PHP會在日志中記錄哪些信息？錯誤代碼（即PHP的E_ERROR E_WARNING  E_STRICT E_DEPRECATED）消息內(nèi)容（如 Undefined vaiable $input）產(chǎn)生錯誤的文件路徑產(chǎn)生錯誤的行號額外的跟蹤回溯信息（這是通過debug_backtrace實現(xiàn)的）當前URL
除了記錄相應(yīng)日志之外，Yii還會對錯誤進行后續(xù)處理（如中斷運行、顯示錯誤頁等），默認情況下錯誤的處理會交給CErrorHandler組件處理（但可以通過給CApplicaton綁定onError事件處理器而實現(xiàn)錯誤處理的二次接管，此處的設(shè)計很靈活！）。
此時將產(chǎn)生一個CErrorEvent(并包含$code,$message,$file,$line幾項關(guān)鍵參數(shù))，傳遞給CErrorHandler組件進行處理。具體是交給CErrorHandler::handleError處理之。這個流程主要是將錯誤相關(guān)信息進行整理，并以合適的方式進行顯示。
是否為debug模式（YII_DEBUG==true），對錯誤信息的顯示結(jié)果有極大影響。調(diào)試模式下我們希望能顯示詳細的錯誤跟蹤信息，而在生產(chǎn)模式下，我們希望給用戶顯示友好的頁面。所以，此處的錯誤顯示有所不同，下面區(qū)分說明之。
當處于調(diào)試模式時，將直接渲染exception視圖展示錯誤。將按以下路徑搜索：

• protected/views/system/exception.php

• YII_PATH/views/exception.php

顯然，默認情況下并沒有在應(yīng)用程序中定義views/system目錄，故會使用系統(tǒng)框架自帶的視圖文件。最終包含的文件將是Yii框架中的views/exception.php。

從以上分析中可以得知，在調(diào)試模式下如果我們要使用自定義異常頁面（一般這么做的意義可能不大），則需要配置文件protected/views/system/exception.php, 可使用的變量即$data。
當處于非調(diào)試模式下時，會作如下處理：

配置文件中若為errorHandler組件定義了errorAction路由信息，則直接運行之，否則執(zhí)行第2步流程。
嘗試加載error視圖，按以下路徑搜索（第一個搜索到的文件將被使用）

• protected/views/system/zh_cn/error500.php

• protected/views/system/error500.php

• protected/views/system/zh_cn/error.php

• protected/views/system/error.php

• YII_PATH/views/zh_cn/error500.php

• YII_PATH/views/error500.php

• YII_PATH/views/zh_cn/error.php

• Y II_PATH/views/error.php

異常的處理根據(jù)前面的分析，異常的處理機制與錯誤處理機制類似，也會記錄日志，級別是error, 分類為"exception.$EXCEPTIONCLASS", 若是CHttpException類異常，分類名稱則為exception.CHttpException.$STATUS_CODE。如數(shù)據(jù)的異常分類稱為exception.CDbException。

接下來將錯誤事件CExceptionEvent交由errorHandler處理，所有錯誤信息都由CExceptionEvent對象傳遞而來。處理方法如下：

如果是調(diào)試模式，則按以下順序搜索視圖文件，第一個搜索到的文件將被使用

• protected/views/system/exception.php

• YII_PATH/views/exception.php

如果是非調(diào)試模式，并在配置文件中為errorHandler組件定義了errorAction屬性路由，則運行之，否則進入第3步。
按以下順序嘗試加載視圖文件，第一個搜索到的文件將被使用
protected/views/system/zh_cn/error500.phpprotected/views/system/error500.phpprotected/views/system/zh_cn/error.phpprotected/views/system/error.phpYII_PATH/views/zh_cn/error500.phpYII_PATH/views/error500.phpYII_PATH/views/zh_cn/error.phpY II_PATH/views/error.php

使用流程圖描述，會更清楚一些：搜尋視圖文件流程比較重要，因為它關(guān)系到我們?nèi)绾巫远x錯誤頁面的細節(jié)問題，后續(xù)的流程圖詳細描述其過程。

從圖中可以看出，最容易的方式還是給errorHandler組件設(shè)置errorAction屬性指定錯誤發(fā)生的路由

一般而言，我們最關(guān)心的是生產(chǎn)模式下錯誤頁面的顯示問題，經(jīng)過以上分析，有兩種方法可用：

配置文件中為errorHandler組件定義errorAction路由屬性（應(yīng)該優(yōu)先使用這個方式，以達到靈活配置目的）
定義以下文件中的任意一個，實現(xiàn)自定義錯誤頁(不推薦)

• Protected/views/system/zh_cn/error500.php

• protected/views/system/error500.php

• protected/views/system/zh_cn/error.php

• protected/views/system/error.php

第1種方式靈活可控，可以在控制器中指定視圖文件，靈活可控。

使用錯誤處理器示例

yii\web\ErrorHandler 注冊成一個名稱為errorHandler應(yīng)用組件， 可以在應(yīng)用配置中配置它類似如下：

return [
  'components' => [
    'errorHandler' => [
      'maxSourceLines' => 20,
    ],
  ],
];

使用如上代碼，異常頁面最多顯示20條源代碼。

如前所述，錯誤處理器將所有非致命PHP錯誤轉(zhuǎn)換成可獲取異常，也就是說可以使用如下代碼處理PHP錯誤：

use Yii;
use yii\base\ErrorException;

try {
  10/0;
} catch (ErrorException $e) {
  Yii::warning("Division by zero.");
}

// execution continues...

如果你想顯示一個錯誤頁面告訴用戶請求是無效的或無法處理的，可簡單地拋出一個 yii\web\HttpException異常， 如 yii\web\NotFoundHttpException。錯誤處理器會正確地設(shè)置響應(yīng)的HTTP狀態(tài)碼并使用合適的錯誤視圖頁面來顯示錯誤信息。

use yii\web\NotFoundHttpException;

throw new NotFoundHttpException();

自定義錯誤顯示

yii\web\ErrorHandler錯誤處理器根據(jù)常量YII_DEBUG的值來調(diào)整錯誤顯示， 當YII_DEBUG 為 true (表示在調(diào)試模式)，錯誤處理器會顯示異常以及詳細的函數(shù)調(diào)用棧和源代碼行數(shù)來幫助調(diào)試， 當YII_DEBUG 為 false，只有錯誤信息會被顯示以防止應(yīng)用的敏感信息泄漏。

補充: 如果異常是繼承 yii\base\UserException，不管YII_DEBUG為何值，函數(shù)調(diào)用棧信息都不會顯示， 這是因為這種錯誤會被認為是用戶產(chǎn)生的錯誤，開發(fā)人員不需要去修正。
yii\web\ErrorHandler 錯誤處理器默認使用兩個視圖顯示錯誤:

• @yii/views/errorHandler/error.php: 顯示不包含函數(shù)調(diào)用棧信息的錯誤信息是使用， 當YII_DEBUG 為 false時，所有錯誤都使用該視圖。

• @yii/views/errorHandler/exception.php: 顯示包含函數(shù)調(diào)用棧信息的錯誤信息時使用。

可以配置錯誤處理器的 yii\web\ErrorHandler::errorView 和 yii\web\ErrorHandler::exceptionView 屬性 使用自定義的錯誤顯示視圖。

使用錯誤操作

使用指定的錯誤操作 來自定義錯誤顯示更方便， 為此，首先配置errorHandler組件的 yii\web\ErrorHandler::errorAction 屬性，類似如下：

return [
  'components' => [
    'errorHandler' => [
      'errorAction' => 'site/error',
    ],
  ]
];

yii\web\ErrorHandler::errorAction 屬性使用路由到一個操作， 上述配置表示不用顯示函數(shù)調(diào)用棧信息的錯誤會通過執(zhí)行site/error操作來顯示。

可以創(chuàng)建site/error 操作如下所示：

namespace app\controllers;

use Yii;
use yii\web\Controller;

class SiteController extends Controller
{
  public function actions()
  {
    return [
      'error' => [
        'class' => 'yii\web\ErrorAction',
      ],
    ];
  }
}

上述代碼定義error 操作使用yii\web\ErrorAction 類，該類渲染名為error視圖來顯示錯誤。

除了使用yii\web\ErrorAction, 可定義error 操作使用類似如下的操作方法：

public function actionError()
{
  $exception = Yii::$app->errorHandler->exception;
  if ($exception !== null) {
    return $this->render('error', ['exception' => $exception]);
  }
}

現(xiàn)在應(yīng)創(chuàng)建一個視圖文件為views/site/error.php，在該視圖文件中，如果錯誤操作定義為yii\web\ErrorAction， 可以訪問該操作中定義的如下變量：

• name: 錯誤名稱

• message: 錯誤信息

• exception: 更多詳細信息的異常對象，如HTTP 狀態(tài)碼，錯誤碼，錯誤調(diào)用棧等。

補充: 如果你使用 基礎(chǔ)應(yīng)用模板 或 高級應(yīng)用模板, 錯誤操作和錯誤視圖已經(jīng)定義好了。

自定義錯誤格式

錯誤處理器根據(jù)響應(yīng)設(shè)置的格式來顯示錯誤， 如果yii\web\Response::format 響應(yīng)格式為html, 會使用錯誤或異常視圖來顯示錯誤信息，如上一小節(jié)所述。 對于其他的響應(yīng)格式，錯誤處理器會錯誤信息作為數(shù)組賦值給yii\web\Response::data屬性，然后轉(zhuǎn)換到對應(yīng)的格式， 例如，如果響應(yīng)格式為json，可以看到如下響應(yīng)信息：

HTTP/1.1 404 Not Found
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
  "name": "Not Found Exception",
  "message": "The requested resource was not found.",
  "code": 0,
  "status": 404
}

可在應(yīng)用配置中響應(yīng)response組件的beforeSend事件來自定義錯誤響應(yīng)格式。

return [
  // ...
  'components' => [
    'response' => [
      'class' => 'yii\web\Response',
      'on beforeSend' => function ($event) {
        $response = $event->sender;
        if ($response->data !== null) {
          $response->data = [
            'success' => $response->isSuccessful,
            'data' => $response->data,
          ];
          $response->statusCode = 200;
        }
      },
    ],
  ],
];

上述代碼會重新格式化錯誤響應(yīng)，類似如下：

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
  "success": false,
  "data": {
    "name": "Not Found Exception",
    "message": "The requested resource was not found.",
    "code": 0,
    "status": 404
  }
}

以上是“怎么在PHP的Yii框架中進行錯誤和異常處理”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對大家有所幫助，如果還想學習更多知識，歡迎關(guān)注億速云行業(yè)資訊頻道！