Latest web development tutorials

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 /www/w3big/test/test.php:7 Stack trace: #0 /www/w3big/test/test.php(13): checkNum(2) #1 {main} thrown in /www/w3big/test/test.php on line 7

Try、throw 和catch

要避免上面實例中出現的錯誤，我們需要創建適當的代碼來處理異常。

適當的處理異常代碼應該包括：

  1. Try - 使用異常的函數應該位於"try" 代碼塊內。 如果沒有觸發異常，則代碼將照常繼續執行。 但是如果異常被觸發，會拋出一個異常。
  2. Throw - 裡規定如何觸發異常。 每一個"throw" 必須對應至少一個"catch"。
  3. Catch - "catch" 代碼塊會捕獲異常，並創建一個包含異常信息的對象。

讓我們觸發一個異常： 

<?php
// 创建一个有异常处理的函数
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

實例解釋：

上面的代碼拋出了一個異常，並捕獲了它：

  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
class customException extends Exception
{
	public function errorMessage()
	{
		// 错误信息
		$errorMsg = '错误行号 '.$this->getLine().' in '.$this->getFile()
		.': <b>'.$this->getMessage().'</b> 不是一个合法的 E-Mail 地址';
		return $errorMsg;
	}
}

$email = "[email protected]";

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()。

實例解釋：

上面的代碼拋出了一個異常，並通過一個自定義的exception 類來捕獲它：

  1. customException() 類是作為舊的exception 類的一個擴展來創建的。 這樣它就繼承了舊的exception 類的所有屬性和方法。
  2. 創建errorMessage() 函數。 如果e-mail 地址不合法，則該函數返回一條錯誤消息。
  3. 把$email 變量設置為不合法的e-mail 地址字符串。
  4. 執行"try" 代碼塊，由於e-mail 地址不合法，因此拋出一個異常。
  5. "catch" 代碼塊捕獲異常，並顯示錯誤消息。

多個異常

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

可以使用多個if..else 代碼塊，或一個switch 代碼塊，或者嵌套多個異常。 這些異常能夠使用不同的exception 類，並返回不同的錯誤消息： 

<?php
class customException extends Exception
{
	public function errorMessage()
	{
		// 错误信息
		$errorMsg = '错误行号 '.$this->getLine().' in '.$this->getFile()
		.': <b>'.$this->getMessage().'</b> 不是一个合法的 E-Mail 地址';
		return $errorMsg;
	}
}

$email = "[email protected]";

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
class customException extends Exception
{
	public function errorMessage()
	{
		// 错误信息
		$errorMsg = $this->getMessage().' 不是一个合法的 E-Mail 地址。';
		return $errorMsg;
	}
}

$email = "[email protected]";

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
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 代碼塊中拋出（再次拋出）異常。

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