本文目的
PHP的全局錯誤處理,在開發項目的時候很有用,可以幫助開發者快速定位一些問題,提高工作效率。默認情況下,全局錯誤會直接輸出,但是最近開發時使用的一個框架庫對全局錯誤處理進行了設定,導致很多錯誤信息沒有輸出,在定位問題上有一定的耗時。所以,研究了一下此庫的實現,發現它設定了error_reporting和set_error_handler,導致此現象。現在記錄一下這兩個函數的用法,作為備忘錄。
背景
PHP沒有類型檢測,開發人員比較容易輸入錯誤單詞,引起致命錯誤,最終導致腳本停止執行。如果這個時候,沒有得到任何錯誤消息,那麼會是一件很痛苦的事情。你不得不從腳本的第一行代碼開始調試,在成千上萬行的代碼中不斷的print或者echo,直到定位到這個輸錯的單詞。然後,有不得不原路返回,將先前添加的print或echo全部刪除。這時一件及其枯燥乏味的工作。
一般情況
正常情況下,php會將致命錯誤直接輸出,會將錯誤的出處(文件地址,行號)和原因等輸出,這樣,開發著可以很方便的定位到問題。
但是有些時候,可能由於php.ini的設置問題,可能是第三方框架配置的問題,導致這些信息沒有輸出,那麼此時,必須學會自己設置相關參數,輸出這些錯誤信息,幫助快速定位問題。
error_reporting
error_reporting是一個php的全局配置參數,在php.ini中。用於配置錯誤輸出級別,參數是比特位,可以用來設置錯誤輸出的級別,下面是從php.ini中copy出來的信息:
; error_reporting is a bit-field. Or each number up to get desired error ; reporting level ; E_ALL - All errors and warnings (doesn't include E_STRICT) ; E_ERROR - fatal run-time errors ; E_RECOVERABLE_ERROR - almost fatal run-time errors ; E_WARNING - run-time warnings (non-fatal errors) ; E_PARSE - compile-time parse errors ; E_NOTICE - run-time notices (these are warnings which often result ; from a bug in your code, but it's possible that it was ; intentional (e.g., using an uninitialized variable and ; relying on the fact it's automatically initialized to an ; empty string) ; E_STRICT - run-time notices, enable to have PHP suggest changes ; to your code which will ensure the best interoperability ; and forward compatibility of your code ; E_CORE_ERROR - fatal errors that occur during PHP's initial startup ; E_CORE_WARNING - warnings (non-fatal errors) that occur during PHP's ; initial startup ; E_COMPILE_ERROR - fatal compile-time errors ; E_COMPILE_WARNING - compile-time warnings (non-fatal errors) ; E_USER_ERROR - user-generated error message ; E_USER_WARNING - user-generated warning message ; E_USER_NOTICE - user-generated notice message ; ; Examples: ; ; - Show all errors, except for notices and coding standards warnings ; ;error_reporting = E_ALL & ~E_NOTICE ; ; - Show all errors, except for notices ; ;error_reporting = E_ALL & ~E_NOTICE | E_STRICT ; ; - Show only errors ; ;error_reporting = E_COMPILE_ERROR|E_RECOVERABLE_ERROR|E_ERROR|E_CORE_ERROR ; ; - Show all errors except for notices and coding standards warnings ; error_reporting = E_ALL & ~E_NOTICE
默認情況下,php會輸出所有錯誤信息,除了notice。同樣,php標准函數中提供了名稱相同的函數error_reporting(int $level),用於在php腳本中,完成同樣的功能。這樣將不會影響其他程序。值得注意的是,$level為0的時候是關閉錯誤輸出,也就是任何錯誤都不會輸出。
set_error_handler
php的默認錯誤處理是將消息輸出。但是,有時候需要定義一些其他操作,這時就需要自定義錯誤處理函數。php提供內置函數set_error_handler可以幫助我們注冊自己的錯誤處理函數。函數原型如下:
mixed set_error_handler ( callback $error_handler [, int $error_types = E_ALL | E_STRICT ] )
值得注意的是,即使注冊了錯誤處理函數,默認的行為仍然會執行,也就是錯誤出現時,仍然會輸出錯誤信息,所以需要在程序中顯示的將錯誤級別設置為0,然後在注冊自己的的錯誤處理函數。這種方式,在生產環境下,尤其重要,因為即時出錯,敏感內部錯誤信息也不會暴露給潛在的惡意用戶。還有很重要的一點需要指出,自定義錯誤處理函數不能處理fatal error(比如編譯錯誤)。下面是一個使用自定義錯誤處理函數的列子:
<?php error_reporting (0); function error_handler ($error_level, $error_message, $file, $line) { $EXIT = FALSE; switch ($error_level) { case E_NOTICE: case E_USER_NOTICE: $error_type = 'Notice'; break; case E_WARNING: case E_USER_WARNING: $error_type = 'Warning'; break; case E_ERROR: case E_USER_ERROR: $error_type = 'Fatal Error'; $EXIT = TRUE; break; default: $error_type = 'Unknown'; $EXIT = TRUE; break; } printf ("%s: %s in %s on line %d\n", $error_type, $error_message, $file, $line); if ($EXIT) { die(); } } set_error_handler ('error_handler'); //new NonExist(); echo $novar; echo 3/0; trigger_error ('Trigger a fatal error', E_USER_ERROR); new NonExist(); ?>
執行此腳本可以得到下面的輸出:
Notice: Undefined variable: novar in /your/php_demo_file.php on line 40 Warning: Division by zero in /your/php_demo_file.php on line 41 Fatal Error: Trigger a fatal error in /your/php_demo_file.php on line 42
可以看到,最後的“new NoExistClass()”的異常,沒有被自定義的錯誤處理函數捕獲。
最後,捎帶提一下,set_exception_handler注冊頂層的異常處理,在web一用中,可以設定一下,然後統一的跳轉到錯誤處理頁面。