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)生異常或是錯誤時滔韵,又會調(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.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
使用流程圖描述,會更清楚一些:
搜尋視圖文件流程比較重要瓶颠,因為它關(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種方式靈活可控谴轮,可以在控制器中指定視圖文件炒瘟,靈活可控吹埠。