PHP 例外處理

異常用於在指定的錯誤發生時改變腳本的正常流程。


異常是什麼?

PHP 5 提供了一個新的物件導向的錯誤處理方法。

異常處理用於在指定的錯誤(異常)情況發生時改變腳本的正常流程。這種情況稱為異常。

當異常被觸發時,通常會發生:

·   當前程式碼狀態被儲存

·   程式碼執行被切換到預先定義(自定義)的異常處理器函數

·   根據情況,處理器也許會從已儲存的程式碼狀態重新開始執行程式碼,終止腳本執行,或從程式碼中另外的位置繼續執行腳本

我們將展示不同的錯誤處理方法:

·   例外的基本使用

·   建立自訂的例外處理器

·   多個例外

·   重新拋出例外

·   設定頂層例外處理器

註解:異常應該只是在錯誤情況下使用,而不應該用於在一個指定的點跳到程式碼的另一個位置。


異常的基本使用

當例外被拋出時,其後的程式碼不會繼續執行,PHP 會嘗試尋找符合的"catch" 程式碼區塊。

如果異常沒有被捕獲,而且又沒用使用set_exception_handler() 作相應的處理的話,那麼將發生一個嚴重的錯誤(致命錯誤),並且輸出"Uncaught Exception" (未捕獲

異常)的錯誤訊息。

讓我們嘗試拋出一個異常,同時不去捕獲它:

<?php
// 创建一个有异常处理的函数
function checkNum($number)
{
    if($number>1)
    {
        throw new Exception("Value must be 1 or below");
    }
    return true;
}
// 触发异常
checkNum(2);
?>

#上面的程式碼會得到類似這樣的一個錯誤:

Fatal error:  Uncaught exception 'Exception' with message 'Value must be 1 or below' in D:\WWW\11.php:7 Stack trace: #0 D:\WWW\11.php(13): checkNum(2) #1 {main}  thrown in D:\WWW\11.php on line 7


Try、throw 和 catch

要避免上面实例中出现的错误,我们需要创建适当的代码来处理异常。

适当的处理异常代码应该包括:

1.  Try - 使用异常的函数应该位于 "try" 代码块内。如果没有触发异常,则代码将照常继续执行。但是如果异常被触发,会抛出一个异常。

2.  Throw - 里规定如何触发异常。每一个 "throw" 必须对应至少一个 "catch"。

3.  Catch - "catch" 代码块会捕获异常,并创建一个包含异常信息的对象。


实例

让我们触发一个异常:

<?php
header("Content-type:text/html;charset=utf-8");
// 创建一个有异常处理的函数
function checkNum($number)
{
    if($number>1)
    {
        throw new Exception("变量值必须小于等于 1");
    }
    return true;
}
// 在 try 块 触发异常
try
{
    checkNum(2);
    // 如果抛出异常,以下文本不会输出
    echo '如果输出该内容,说明 $number 变量';
}
// 捕获异常
catch(Exception $e)
{
    echo 'Message: ' .$e->getMessage();
}
?>

上面代码将获得类似这样一个错误:

Message: 变量值必须小于等于 1

注释:throw new Exception  明确的拋出异常

实例解释:

上面的代码抛出了一个异常,并捕获了它:

1.   创建 checkNum() 函数。它检测数字是否大于 1。如果是,则抛出一个异常。

2.   在 "try" 代码块中调用 checkNum() 函数。

3.   checkNum() 函数中的异常被抛出。

4.   catch" 代码块接收到该异常,并创建一个包含异常信息的对象 ($e)。

5.   通过从这个 exception 对象调用 $e->getMessage(),输出来自该异常的错误消息。

然而,为了遵循 "每个 throw 必须对应一个 catch" 的原则,可以设置一个顶层的异常处理器来处理漏掉的错误。


建立一個自訂的Exception 類別

建立自訂的例外處理程序非常簡單。我們簡單地創建了一個專門的類,當 PHP 中發生異常時,可呼叫其函數。該類別必須是 exception 類別的一個擴充。

這個自訂的 exception 類別繼承了 PHP 的 exception 類別的所有屬性,您可以將自訂的函數新增至其。

我們開始建立exception 類別:

<?php
header("Content-type:text/html;charset=utf-8");
class customException extends Exception
{
    public function errorMessage()
    {
        // 错误信息
        $errorMsg = '错误行号 '.$this->getLine().' in '.$this->getFile()
            .': <b>'.$this->getMessage().'</b> 不是一个合法的 E-Mail 地址';
        return $errorMsg;
    }
}
$email = "someone@example...com";
try
{
    // 检测邮箱
    if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE)
    {
        // 如果是个不合法的邮箱地址,抛出异常
        throw new customException($email);
    }
}
catch (customException $e)
{
//display custom message
    echo $e->errorMessage();
}
?>

#這個新的類別是舊的exception 類別的副本,外加errorMessage() 函數。正因為它是舊類別的副本,因此它從舊類別繼承了屬性和方法,我們可以使用 exception 類別的方法,例如 getLine()、getFile() 和 getMessage()。

getLine(): 取得發生異常的程式碼在檔案中的行號

getFile():取得發生例外狀況的程式檔案名稱

getMessage(): 取得例外訊息內容


實例解釋:

上面的程式碼拋出了一個異常,並透過一個自訂的exception 類別來捕獲它:

1.   customException() 類別是作為舊的exception類別的一個擴充來創建的。這樣它就繼承了舊的 exception 類別的所有屬性和方法。

2.   建立 errorMessage() 函數。如果 e-mail 位址不合法,則函數傳回錯誤訊息。

3.   把 $email 變數設定為不合法的 e-mail 位址字串。

4.   執行 "try" 程式碼區塊,由於 e-mail 位址不合法,因此拋出一個例外。

5.   "catch" 程式碼區塊擷取異常,並顯示錯誤訊息。


多個異常

可以為一段腳本使用多個異常,來偵測多種情況。

可以使用多個 if..else 程式碼區塊,或一個 switch 程式碼區塊,或嵌套多個例外。這些異常能夠使用不同的exception 類,並傳回不同的錯誤訊息:

<?php
header("Content-type:text/html;charset=utf-8");
class customException extends Exception
{
    public function errorMessage()
    {
        // 错误信息
        $errorMsg = '错误行号 '.$this->getLine().' in '.$this->getFile()
            .': <b>'.$this->getMessage().'</b> 不是一个合法的 E-Mail 地址';
        return $errorMsg;
    }
}
$email = "someone@example.com";
try
{
    // 检测邮箱
    if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE)
    {
        // 如果是个不合法的邮箱地址,抛出异常
        throw new customException($email);
    }
    // 检测 "example" 是否在邮箱地址中
    if(strpos($email, "example") !== FALSE)
    {
        throw new Exception("$email 是 example 邮箱");
    }
}
catch (customException $e)
{
    echo $e->errorMessage();
}
catch(Exception $e)
{
    echo $e->getMessage();
}
?>


#實例解釋:

上面的程式碼測試了兩個條件,如果其中任何一個條件不成立,則拋出一個例外:

1.   customException() 類別是作為舊的exception 類別的一個擴充來創建的。這樣它就繼承了舊的 exception 類別的所有屬性和方法。

2.   建立 errorMessage() 函數。如果 e-mail 位址不合法,則函數傳回錯誤訊息。

3.   把 $email 變數設定為字串,字串是有效的 e-mail 位址,但包含字串 "example"。

4.   執行 "try" 程式碼區塊,在第一個條件下,不會拋出例外。

5.   由於 e-mail 含有字串 "example",第二個條件會觸發例外。

6.   "catch" 程式碼區塊會捕捉異常,並顯示適當的錯誤訊息。

如果 customException 類別拋出了異常,但沒有捕獲 customException,僅捕獲了 base exception,則在那裡處理異常。


重新拋出例外

 有時,當例外被拋出時,您也許希望以不同於標準的方式對它進行處理。可以在一個 "catch" 程式碼區塊中再次拋出異常。

腳本應該對使用者隱藏系統錯誤。對程式設計師來說,系統錯誤也許很重要,但是使用者對它們並不感興趣。為了讓使用者更容易使用,您可以再次拋出帶有對使用者比較友善的訊息的異

常:

<?php
 header("Content-type:text/html;charset=utf-8");
 class customException extends Exception
 {
     public function errorMessage()
     {
         // 错误信息
         $errorMsg = $this->getMessage().' 不是一个合法的 E-Mail 地址。';
         return $errorMsg;
     }
 }
 
 $email = "someone@example.com";
 
 try
 {
     try
     {
         // 检测 "example" 是否在邮箱地址中
         if(strpos($email, "example") !== FALSE)
         {
             // 如果是个不合法的邮箱地址,抛出异常
             throw new Exception($email);
         }
     }
     catch(Exception $e)
     {
         // 重新抛出异常
         throw new customException($email);
     }
 }
 catch (customException $e)
 {
     // 显示自定义信息
     echo $e->errorMessage();
 }
 ?>

實例解釋:

上面的程式碼會偵測在郵件地址中是否含有字串 "example"。如果有,則再次拋出異常:

1.   customException() 類別是作為舊的 exception 類別的一個擴展來創建的。這樣它就繼承了舊的 exception 類別的所有屬性和方法。

2.   建立 errorMessage() 函數。如果 e-mail 位址不合法,則函數傳回錯誤訊息。

3.   把 $email 變數設定為字串,字串是有效的 e-mail 位址,但包含字串 "example"。

4.   "try" 程式碼區塊包含另一個 "try" 程式碼區塊,這樣就可以再次拋出例外。

5.   由於 e-mail 包含字串 "example",因此觸發異常。

6.   "catch" 程式碼區塊捕獲到該異常,並重新拋出 "customException"。

7.   捕獲到 "customException",並顯示一條錯誤訊息。

如果在目前的 "try" 程式碼區塊中異常沒有被捕獲,則它將在更高層級上尋找 catch 程式碼區塊。


設定頂層異常處理器

#set_exception_handler() 函數可設定處理所有未捕獲異常的使用者定義函數。

<?php
header("Content-type:text/html;charset=utf-8");
function myException($exception)
{
    echo "<b>Exception:</b> " , $exception->getMessage();
}
set_exception_handler('myException');
throw new Exception('Uncaught Exception occurred');
?>

以上程式碼的輸出如下:

Exception: Uncaught Exception occurred

在上面的程式碼中,不存在"catch" 程式碼區塊,而是觸發頂層的例外處理程序。應該使用此函數來捕獲所有未被捕獲的異常。


異常的規則

·    需要異常處理的程式碼應該放入try 程式碼區塊內,以便擷取潛在的例外。

·    每個 try 或 throw 程式碼區塊必須至少擁有一個對應的 catch 程式碼區塊。

·    使用多個 catch 程式碼區塊可以捕捉不同種類的例外。

·    可以在 try 程式碼區塊內的 catch 程式碼區塊中拋出(再次拋出)例外。

簡而言之:如果拋出了異常,就必須捕獲它。


#
繼續學習
||
<?php header("Content-type:text/html;charset=utf-8"); // 创建一个有异常处理的函数 function checkNum($number) { if($number>1) { throw new Exception("变量值必须小于等于 1"); } return true; } // 在 try 块 触发异常 try { checkNum(2); // 如果抛出异常,以下文本不会输出 echo '如果输出该内容,说明 $number 变量'; } // 捕获异常 catch(Exception $e) { echo 'Message: ' .$e->getMessage(); } ?>