拦截PHP各种异常和错误,发生致命错误时进行报警,万事防患于未然
在日常開發(fā)中,大多數(shù)人的做法是在開發(fā)環(huán)境時開啟調(diào)試模式,在產(chǎn)品環(huán)境關(guān)閉調(diào)試模式。在開發(fā)的時候可以查看各種錯誤、異常,但是在線上就把錯誤顯示的關(guān)閉。
上面的情形看似很科學,有人解釋為這樣很安全,別人看不到錯誤,以免泄露重要信息...
但是你有沒有遇到這種情況,線下好好的,一上線卻運行不起來也找不到原因...
一個腳本,跑了好長一段時間,一直沒有問題,有一天突然中斷了,然后了也沒有任何記錄都不造啥原因...
線上一個付款,別人明明付了款,但是我們卻沒有記錄到,自己親自去實驗,卻是好的...
?
種種以上,都是因為大家關(guān)閉了錯誤信息,并且未將錯誤、異常記錄到日志,導致那些隨機發(fā)生的錯誤很難追蹤。這樣矛盾就來了,即不要顯示錯誤,又要追蹤錯誤,這如何實現(xiàn)了?
以上問題都可以通過PHP的錯誤、異常機制及其內(nèi)建函數(shù)'set_exception_handler','set_error_handler','register_shutdown_function' 來實現(xiàn)
?
'set_exception_handler' 函數(shù) 用于攔截各種未捕獲的異常,然后將這些交給用戶自定義的方式進行處理
'set_error_handler' 函數(shù)可以攔截各種錯誤,然后交給用戶自定義的方式進行處理
'register_shutdown_function' 函數(shù)是在PHP腳本結(jié)束時調(diào)用的函數(shù),配合'error_get_last'可以獲取最后的致命性錯誤
?
這個思路大體就是把錯誤、異常、致命性錯誤攔截下來,交給我們自定義的方法進行處理,我們辨別這些錯誤、異常是否致命,如果是則記錄的數(shù)據(jù)庫或者文件系統(tǒng),然后使用腳本不停的掃描這些日志,發(fā)現(xiàn)嚴重錯誤立即發(fā)送郵件或發(fā)送短信進行報警
?
首先我們定義錯誤攔截類,該類用于將錯誤、異常攔截下來,用我們自己定義的處理方式進行處理,該類放在文件名為'errorHandler.class.php'中,代碼如下
/*** 文件名稱:baseErrorHandler.class.php* 摘 要:錯誤攔截器父類*/ require 'errorHandlerException.class.php';//異常類 class errorHandler {public $argvs = array();public $memoryReserveSize = 262144;//備用內(nèi)存大小private $_memoryReserve;//備用內(nèi)存/*** 方 法:注冊自定義錯誤、異常攔截器* 參 數(shù):void* 返 回:void*/public function register(){ini_set('display_errors', 0);set_exception_handler(array($this, 'handleException'));//截獲未捕獲的異常set_error_handler(array($this, 'handleError'));//截獲各種錯誤 此處切不可掉換位置//留下備用內(nèi)存 供后面攔截致命錯誤使用$this->memoryReserveSize > 0 && $this->_memoryReserve = str_repeat('x', $this->memoryReserveSize);register_shutdown_function(array($this, 'handleFatalError'));//截獲致命性錯誤 }/*** 方 法:取消自定義錯誤、異常攔截器* 參 數(shù):void* 返 回:void*/public function unregister(){restore_error_handler();restore_exception_handler();}/*** 方 法:處理截獲的未捕獲的異常* 參 數(shù):Exception $exception* 返 回:void*/public function handleException($exception){$this->unregister();try{$this->logException($exception);exit(1);}catch(Exception $e){exit(1);}}/*** 方 法:處理截獲的錯誤* 參 數(shù):int $code 錯誤代碼* 參 數(shù):string $message 錯誤信息* 參 數(shù):string $file 錯誤文件* 參 數(shù):int $line 錯誤的行數(shù)* 返 回:boolean*/public function handleError($code, $message, $file, $line){//該處思想是將錯誤變成異常拋出 統(tǒng)一交給異常處理函數(shù)進行處理if((error_reporting() & $code) && !in_array($code, array(E_NOTICE, E_WARNING, E_USER_NOTICE, E_USER_WARNING, E_DEPRECATED))){//此處只記錄嚴重的錯誤 對于各種WARNING NOTICE不作處理$exception = new errorHandlerException($message, $code, $code, $file, $line);$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);array_shift($trace);//trace的第一個元素為當前對象 移除foreach($trace as $frame) {if($frame['function'] == '__toString') {//如果錯誤出現(xiàn)在 __toString 方法中 不拋出任何異常$this->handleException($exception);exit(1);}}throw $exception;}return false;}/*** 方 法:截獲致命性錯誤* 參 數(shù):void* 返 回:void*/public function handleFatalError(){unset($this->_memoryReserve);//釋放內(nèi)存供下面處理程序使用$error = error_get_last();//最后一條錯誤信息if(errorHandlerException::isFatalError($error)){//如果是致命錯誤進行處理$exception = new errorHandlerException($error['message'], $error['type'], $error['type'], $error['file'], $error['line']);$this->logException($exception);exit(1);}}/*** 方 法:獲取服務器IP* 參 數(shù):void* 返 回:string*/final public function getServerIp(){$serverIp = '';if(isset($_SERVER['SERVER_ADDR'])){$serverIp = $_SERVER['SERVER_ADDR'];}elseif(isset($_SERVER['LOCAL_ADDR'])){$serverIp = $_SERVER['LOCAL_ADDR'];}elseif(isset($_SERVER['HOSTNAME'])){$serverIp = gethostbyname($_SERVER['HOSTNAME']);}else{$serverIp = getenv('SERVER_ADDR');} return $serverIp; }/*** 方 法:獲取當前URI信息* 參 數(shù):void* 返 回:string $url*/public function getCurrentUri(){$uri = '';if($_SERVER ["REMOTE_ADDR"]){//瀏覽器瀏覽模式$uri = 'http://' . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI'];}else{//命令行模式$params = $this->argvs;$uri = $params[0];array_shift($params);for($i = 0, $len = count($params); $i < $len; $i++){$uri .= ' ' . $params[$i];}}return $uri;}/*** 方 法:記錄異常信息* 參 數(shù):errorHandlerException $e 錯誤異常* 返 回:boolean 是否保存成功*/final public function logException($e){$error = array('add_time' => time(),'title' => errorHandlerException::getName($e->getCode()),//這里獲取用戶友好型名稱'message' => array(),'server_ip' => $this->getServerIp(),'code' => errorHandlerException::getLocalCode($e->getCode()),//這里為各種錯誤定義一個編號以便查找'file' => $e->getFile(),'line' => $e->getLine(),'url' => $this->getCurrentUri(),);do{//$e->getFile() . ':' . $e->getLine() . ' ' . $e->getMessage() . '(' . $e->getCode() . ')'$message = (string)$e;$error['message'][] = $message;} while($e = $e->getPrevious());$error['message'] = implode("\r\n", $error['message']);$this->logError($error);}/*** 方 法:記錄異常信息* 參 數(shù):array $error = array(* 'time' => int, * 'title' => 'string', * 'message' => 'string', * 'code' => int,* 'server_ip' => 'string'* 'file' => 'string',* 'line' => int,* 'url' => 'string',* );* 返 回:boolean 是否保存成功*/public function logError($error){/*這里去實現(xiàn)如何將錯誤信息記錄到日志*/} }上述代碼中,有個'errorHandlerException'類,該類放在文件'errorHandlerException.class.php'中,該類用于將錯誤轉(zhuǎn)換為異常,以便記錄錯誤發(fā)生的文件、行號、錯誤代碼、錯誤信息等信息,同時其方法'isFatalError'用于辨別該錯誤是否是致命性錯誤。這里我們?yōu)榱朔奖愎芾?#xff0c;將錯誤進行編號并命名。該類的代碼如下
/*** 文件名稱:errorHandlerException.class.php* 摘 要:自定義錯誤異常類 該類繼承至PHP內(nèi)置的錯誤異常類*/ class errorHandlerException extends ErrorException {public static $localCode = array(E_COMPILE_ERROR => 4001,E_COMPILE_WARNING => 4002,E_CORE_ERROR => 4003,E_CORE_WARNING => 4004,E_DEPRECATED => 4005,E_ERROR => 4006,E_NOTICE => 4007,E_PARSE => 4008,E_RECOVERABLE_ERROR => 4009,E_STRICT => 4010,E_USER_DEPRECATED => 4011,E_USER_ERROR => 4012,E_USER_NOTICE => 4013,E_USER_WARNING => 4014,E_WARNING => 4015,4016 => 4016,);public static $localName = array(E_COMPILE_ERROR => 'PHP Compile Error',E_COMPILE_WARNING => 'PHP Compile Warning',E_CORE_ERROR => 'PHP Core Error',E_CORE_WARNING => 'PHP Core Warning',E_DEPRECATED => 'PHP Deprecated Warning',E_ERROR => 'PHP Fatal Error',E_NOTICE => 'PHP Notice',E_PARSE => 'PHP Parse Error',E_RECOVERABLE_ERROR => 'PHP Recoverable Error',E_STRICT => 'PHP Strict Warning',E_USER_DEPRECATED => 'PHP User Deprecated Warning',E_USER_ERROR => 'PHP User Error',E_USER_NOTICE => 'PHP User Notice',E_USER_WARNING => 'PHP User Warning',E_WARNING => 'PHP Warning',4016 => 'Customer`s Error',);/*** 方 法:構(gòu)造函數(shù)* 摘 要:相關(guān)知識請查看 http://php.net/manual/en/errorexception.construct.php* * 參 數(shù):string $message 異常信息(可選)* int $code 異常代碼(可選)* int $severity* string $filename 異常文件(可選)* int $line 異常的行數(shù)(可選)* Exception $previous 上一個異常(可選)** 返 回:void*/public function __construct($message = '', $code = 0, $severity = 1, $filename = __FILE__, $line = __LINE__, Exception $previous = null){parent::__construct($message, $code, $severity, $filename, $line, $previous);}/*** 方 法:是否是致命性錯誤* 參 數(shù):array $error* 返 回:boolean*/public static function isFatalError($error){$fatalErrors = array(E_ERROR, E_PARSE, E_CORE_ERROR,E_CORE_WARNING, E_COMPILE_ERROR, E_COMPILE_WARNING);return isset($error['type']) && in_array($error['type'], $fatalErrors);}/*** 方 法:根據(jù)原始的錯誤代碼得到本地的錯誤代碼* 參 數(shù):int $code* 返 回:int $localCode*/public static function getLocalCode($code){return isset(self::$localCode[$code]) ? self::$localCode[$code] : self::$localCode[4016];}/*** 方 法:根據(jù)原始的錯誤代碼獲取用戶友好型名稱* 參 數(shù):int * 返 回:string $name*/public static function getName($code){return isset(self::$localName[$code]) ? self::$localName[$code] : self::$localName[4016];}在錯誤攔截類中,需要用戶自己定義實現(xiàn)錯誤記錄的方法('logException'),這個地方需要注意,有些錯誤可能在一段時間內(nèi)不斷發(fā)生,因此只需記錄一次即可,你可以使用錯誤代碼、文件、行號、錯誤詳情 生成一個MD5值用于記錄該錯誤是否已經(jīng)被記錄,如果在規(guī)定時間內(nèi)(一個小時)已經(jīng)被記錄過則不需要再進行記錄
?
然后我們定義一個文件,用于實例化以上類,捕獲各種錯誤、異常,該文件命名為'registerErrorHandler.php', 內(nèi)如如下
/* * 使用方法介紹: * 在入口處引入該文件即可,然后可以在該文件中定義調(diào)試模式常量'DEBUG_ERROR' * * <?php * * require 'registerErrorHandler.php'; * * ?> *//** * 調(diào)試錯誤模式: * 0 => 非調(diào)試模式,不顯示異常、錯誤信息但記錄異常、錯誤信息 * 1 => 調(diào)試模式,顯示異常、錯誤信息但不記錄異常、錯誤信息 */ define('DEBUG_ERROR', 0); require 'errorHandler.class.php';class registerErrorHandler {/*** 方 法:注冊異常、錯誤攔截* 參 數(shù):void* 返 回:void*/public static function register(){global $argv;if(DEBUG_ERROR){//如果開啟調(diào)試模式ini_set('display_errors', 1);return;}//如果不開啟調(diào)試模式ini_set('error_reporting', -1);ini_set('display_errors', 0);$handler = new errorHandler();$handler->argvs = $argv;//此處主要兼容命令行模式下獲取參數(shù)$handler->register();} } registerErrorHandler::register();剩下的就是需要你在你的入口文件引入該文件,定義調(diào)試模式,然后實現(xiàn)你自己記錄錯誤的方法即可
需要注意的是,有些錯誤在你進行注冊之前已經(jīng)發(fā)生并且導致腳本中斷是無法記錄下來的,因為此時'registerErrorHandler::register()' 尚未執(zhí)行已經(jīng)中斷了
還有就是'set_error_handler'這個函數(shù)不能捕獲下面類型的錯誤?E_ERROR、?E_PARSE、?E_CORE_ERROR、?E_CORE_WARNING、E_COMPILE_ERROR、?E_COMPILE_WARNING, 這個可以在官方文檔中看到,但是本處無妨,因為以上錯誤是解析、編譯錯誤,這些都沒有通過,你是不可能發(fā)布上線的
?
以上代碼經(jīng)過嚴格測試,并且已經(jīng)應用在線上環(huán)境,大家可以根據(jù)自己需要進行更改使用
?
總結(jié)
以上是生活随笔為你收集整理的拦截PHP各种异常和错误,发生致命错误时进行报警,万事防患于未然的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 2008R2文件服务器迁移到2012R2
- 下一篇: java重复造轮子系列篇-----时间d