PHP 錯誤處理


在 PHP 中,默認的錯誤處理很簡單。一條錯誤消息會被發送到瀏覽器,這條消息帶有文件名、行號以及描述錯誤的消息。


PHP 錯誤處理

在創建腳本和 Web 應用程序時,錯誤處理是一個重要的部分。如果您的代碼缺少錯誤檢測編碼,那麼程序看上去很不專業,也為安全風險敞開了大門。

本教程介紹了 PHP 中一些最為重要的錯誤檢測方法。

我們將為您講解不同的錯誤處理方法:

  • 簡單的 "die()" 語句
  • 自定義錯誤和錯誤觸發器
  • 錯誤報告

基本的錯誤處理:使用 die() 函數

第一個實例展示了一個打開文本文件的簡單腳本:

<?php
$file=fopen("welcome.txt","r");
?>

如果文件不存在,您會得到類似這樣的錯誤:

Warning: fopen(welcome.txt) [function.fopen]: failed to open stream:
No such file or directory in /www/runoob/test/test.php on line 2

為了避免用戶得到類似上麵的錯誤消息,我們在訪問文件之前檢測該文件是否存在:

<?php
if(!file_exists("welcome.txt"))
{
    die("文件不存在");
}
else
{
    $file=fopen("welcome.txt","r");
}
?>

現在,如果文件不存在,您會得到類似這樣的錯誤消息:

文件不存在

相比之前的代碼,上麵的代碼更有效,這是由於它采用了一個簡單的錯誤處理機製在錯誤之後終止了腳本。

然而,簡單地終止腳本並不總是恰當的方式。讓我們研究一下用於處理錯誤的備選的 PHP 函數。


創建自定義錯誤處理器

創建一個自定義的錯誤處理器非常簡單。我們很簡單地創建了一個專用函數,可以在 PHP 中發生錯誤時調用該函數。

該函數必須有能力處理至少兩個參數 (error level 和 error message),但是可以接受最多五個參數(可選的:file, line-number 和 error context):

語法

error_function(error_level,error_message,
error_file,error_line,error_context)
參數 描述
error_level 必需。為用戶定義的錯誤規定錯誤報告級別。必須是一個數字。參見下麵的表格:錯誤報告級別。
error_message 必需。為用戶定義的錯誤規定錯誤消息。
error_file 可選。規定錯誤發生的文件名。
error_line 可選。規定錯誤發生的行號。
error_context 可選。規定一個數組,包含了當錯誤發生時在用的每個變量以及它們的值。

錯誤報告級別

這些錯誤報告級別是用戶自定義的錯誤處理程序處理的不同類型的錯誤:

常量 描述
2 E_WARNING 非致命的 run-time 錯誤。不暫停腳本執行。
8 E_NOTICE run-time 通知。在腳本發現可能有錯誤時發生,但也可能在腳本正常運行時發生。
256 E_USER_ERROR 致命的用戶生成的錯誤。這類似於程序員使用 PHP 函數 trigger_error() 設置的 E_ERROR。
512 E_USER_WARNING 非致命的用戶生成的警告。這類似於程序員使用 PHP 函數 trigger_error() 設置的 E_WARNING。
1024 E_USER_NOTICE 用戶生成的通知。這類似於程序員使用 PHP 函數 trigger_error() 設置的 E_NOTICE。
4096 E_RECOVERABLE_ERROR 可捕獲的致命錯誤。類似 E_ERROR,但可被用戶定義的處理程序捕獲。(參見 set_error_handler())
8191 E_ALL 所有錯誤和警告。(在 PHP 5.4 中,E_STRICT 成為 E_ALL 的一部分)

現在,讓我們創建一個處理錯誤的函數:

function customError($errno, $errstr)
{
    echo "<b>Error:</b> [$errno] $errstr<br>";
    echo "腳本結束";
    die();
}

上麵的代碼是一個簡單的錯誤處理函數。當它被觸發時,它會取得錯誤級別和錯誤消息。然後它會輸出錯誤級別和消息,並終止腳本。

現在,我們已經創建了一個錯誤處理函數,我們需要確定在何時觸發該函數。


設置錯誤處理程序

PHP 的默認錯誤處理程序是內建的錯誤處理程序。我們打算把上麵的函數改造為腳本運行期間的默認錯誤處理程序。

可以修改錯誤處理程序,使其僅應用到某些錯誤,這樣腳本就能以不同的方式來處理不同的錯誤。然而,在本例中,我們打算針對所有錯誤來使用我們自定義的錯誤處理程序:

set_error_handler("customError");

由於我們希望我們的自定義函數能處理所有錯誤,set_error_handler() 僅需要一個參數,可以添加第二個參數來規定錯誤級別。

實例

通過嚐試輸出不存在的變量,來測試這個錯誤處理程序:

<?php
// 錯誤處理函數
function customError($errno, $errstr)
{
    echo "<b>Error:</b> [$errno] $errstr";
}

// 設置錯誤處理函數
set_error_handler("customError");

// 觸發錯誤
echo($test);
?>

以上代碼的輸出如下所示:

Error: [8] Undefined variable: test


觸發錯誤

在腳本中用戶輸入數據的位置,當用戶的輸入無效時觸發錯誤是很有用的。在 PHP 中,這個任務由 trigger_error() 函數完成。

實例

在本例中,如果 "test" 變量大於 "1",就會發生錯誤:

<?php
$test=2;
if ($test>1)
{
    trigger_error("變量值必須小於等於 1");
}
?>

以上代碼的輸出如下所示:

Notice: 變量值必須小於等於 1
in /www/test/runoob.php on line 5

您可以在腳本中任何位置觸發錯誤,通過添加的第二個參數,您能夠規定所觸發的錯誤類型。

可能的錯誤類型:

  • E_USER_ERROR - 致命的用戶生成的 run-time 錯誤。錯誤無法恢複。腳本執行被中斷。
  • E_USER_WARNING - 非致命的用戶生成的 run-time 警告。腳本執行不被中斷。
  • E_USER_NOTICE - 默認。用戶生成的 run-time 通知。在腳本發現可能有錯誤時發生,但也可能在腳本正常運行時發生。

實例

在本例中,如果 "test" 變量大於 "1",則發生 E_USER_WARNING 錯誤。如果發生了 E_USER_WARNING,我們將使用我們自定義的錯誤處理程序並結束腳本:

<?php
// 錯誤處理函數
function customError($errno, $errstr)
{
    echo "<b>Error:</b> [$errno] $errstr<br>";
    echo "腳本結束";
    die();
}

// 設置錯誤處理函數
set_error_handler("customError",E_USER_WARNING);

// 觸發錯誤
$test=2;
if ($test>1)
{
    trigger_error("變量值必須小於等於 1",E_USER_WARNING);
}
?>

以上代碼的輸出如下所示:

Error: [512] 變量值必須小於等於 1
腳本結束

現在,我們已經學習了如何創建自己的 error,以及如何觸發它們,接下來我們研究一下錯誤記錄。


錯誤記錄

在默認的情況下,根據在 php.ini 中的 error_log 配置,PHP 向服務器的記錄係統或文件發送錯誤記錄。通過使用 error_log() 函數,您可以向指定的文件或遠程目的地發送錯誤記錄。

通過電子郵件向您自己發送錯誤消息,是一種獲得指定錯誤的通知的好辦法。

通過 E-Mail 發送錯誤消息

在下麵的例子中,如果特定的錯誤發生,我們將發送帶有錯誤消息的電子郵件,並結束腳本:

<?php
// 錯誤處理函數
function customError($errno, $errstr)
{
    echo "<b>Error:</b> [$errno] $errstr<br>";
    echo "已通知網站管理員";
    error_log("Error: [$errno] $errstr",1,
    "someone@example.com","From: webmaster@example.com");
}

// 設置錯誤處理函數
set_error_handler("customError",E_USER_WARNING);

// 觸發錯誤
$test=2;
if ($test>1)
{
    trigger_error("變量值必須小於等於 1",E_USER_WARNING);
}
?>

以上代碼的輸出如下所示:

Error: [512] 變量值必須小於等於 1
已通知網站管理員

接收自以上代碼的郵件如下所示:

Error: [512] 變量值必須小於等於 1

這個方法不適合所有的錯誤。常規錯誤應當通過使用默認的 PHP 記錄係統在服務器上進行記錄。