PHP 异常处理

异常(Exception)用于在指定的错误发生时改变脚本的正常流程。

什么是异常?

PHP 5 提供了一种新的面向对象的错误处理方法。

异常处理用于在指定的错误(异常)情况发生时改变脚本的正常流程。这种情况称为异常。

当异常被触发时,通常会发生:

  • 当前代码状态被保存
  • 代码执行被切换到预定义的异常处理器函数
  • 根据情况,处理器也许会从保存的代码状态重新开始执行代码,终止脚本执行,或从代码中另外的位置继续执行脚本

我们将展示不同的错误处理方法:

  • 异常的基本使用
  • 创建自定义的异常处理器
  • 多个异常
  • 重新抛出异常
  • 设置顶层异常处理器

异常的基本使用

当异常被抛出时,其后的代码不会继续执行,PHP 会尝试查找匹配的 "catch" 代码块。

如果异常没有被捕获,而且又没用使用 set_exception_handler() 作相应的处理的话,那么将发生一个严重的错误(致命错误),并且输出 "Uncaught Exception" (未捕获异常)的错误消息。

让我们尝试抛出一个异常,同时不去捕获它:

  1. <?php
  2. //create function with an exception
  3. function checkNum($number)
  4. {
  5. if($number>1)
  6. {
  7. throw new Exception("Value must be 1 or below");
  8. }
  9. return true;
  10. }
  11.  
  12. //trigger exception
  13. checkNum(2);
  14. ?>

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

  1. Fatal error: Uncaught exception 'Exception'
  2. with message 'Value must be 1 or below' in C:\webfolder\test.php:6
  3. Stack trace: #0 C:\webfolder\test.php(12):
  4. checkNum(28) #1 {main} thrown in C:\webfolder\test.php on line 6

Try, throw 和 catch

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

正确的处理程序应当包括:

  • Try - 使用异常的函数应该位于 "try" 代码块内。如果没有触发异常,则代码将照常继续执行。但是如果异常被触发,会抛出一个异常。
  • Throw - 这里规定如何触发异常。每一个 "throw" 必须对应至少一个 "catch"
  • Catch - "catch" 代码块会捕获异常,并创建一个包含异常信息的对象

让我们触发一个异常:

  1. <?php
  2. //创建可抛出一个异常的函数
  3. function checkNum($number)
  4. {
  5. if($number>1)
  6. {
  7. throw new Exception("Value must be 1 or below");
  8. }
  9. return true;
  10. }
  11.  
  12. //在 "try" 代码块中触发异常
  13. try
  14. {
  15. checkNum(2);
  16. //If the exception is thrown, this text will not be shown
  17. echo 'If you see this, the number is 1 or below';
  18. }
  19.  
  20. //捕获异常
  21. catch(Exception $e)
  22. {
  23. echo 'Message: ' .$e->getMessage();
  24. }
  25. ?>

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

  1. Message: Value must be 1 or below

例子解释:

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

  • 创建 checkNum() 函数。它检测数字是否大于 1。如果是,则抛出一个异常。
  • 在 "try" 代码块中调用 checkNum() 函数。
  • checkNum() 函数中的异常被抛出
  • "catch" 代码块接收到该异常,并创建一个包含异常信息的对象 ($e)。
  • 通过从这个 exception 对象调用 $e->getMessage(),输出来自该异常的错误消息

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

创建一个自定义的 Exception 类

创建自定义的异常处理程序非常简单。我们简单地创建了一个专门的类,当 PHP 中发生异常时,可调用其函数。该类必须是 exception 类的一个扩展。

这个自定义的 exception 类继承了 PHP 的 exception 类的所有属性,您可向其添加自定义的函数。

我们开始创建 exception 类:

  1. <?php
  2. class customException extends Exception
  3. {
  4. public function errorMessage()
  5. {
  6. //error message
  7. $errorMsg = 'Error on line '.$this->getLine().' in '.$this->getFile()
  8. .': <b>'.$this->getMessage().'</b> is not a valid E-Mail address';
  9. return $errorMsg;
  10. }
  11. }
  12.  
  13. $email = "someone@example...com";
  14.  
  15. try
  16. {
  17. //check if
  18. if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE)
  19. {
  20. //throw exception if email is not valid
  21. throw new customException($email);
  22. }
  23. }
  24.  
  25. catch (customException $e)
  26. {
  27. //display custom message
  28. echo $e->errorMessage();
  29. }
  30. ?>

这个新的类是旧的 exception 类的副本,外加 errorMessage() 函数。正因为它是旧类的副本,因此它从旧类继承了属性和方法,我们可以使用 exception 类的方法,比如 getLine() 、 getFile() 以及 getMessage()。

例子解释:

上面的代码抛出了一个异常,并通过一个自定义的 exception 类来捕获它:

  • customException() 类是作为旧的 exception 类的一个扩展来创建的。这样它就继承了旧类的所有属性和方法。
  • 创建 errorMessage() 函数。如果 e-mail 地址不合法,则该函数返回一条错误消息
  • 把 $email 变量设置为不合法的 e-mail 地址字符串
  • 执行 "try" 代码块,由于 e-mail 地址不合法,因此抛出一个异常
  • "catch" 代码块捕获异常,并显示错误消息

多个异常

可以为一段脚本使用多个异常,来检测多种情况。

可以使用多个 if..else 代码块,或一个 switch 代码块,或者嵌套多个异常。这些异常能够使用不同的 exception 类,并返回不同的错误消息:

  1. <?php
  2. class customException extends Exception
  3. {
  4. public function errorMessage()
  5. {
  6. //error message
  7. $errorMsg = 'Error on line '.$this->getLine().' in '.$this->getFile()
  8. .': <b>'.$this->getMessage().'</b> is not a valid E-Mail address';
  9. return $errorMsg;
  10. }
  11. }
  12.  
  13. $email = "someone@example.com";
  14.  
  15. try
  16. {
  17. //check if
  18. if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE)
  19. {
  20. //throw exception if email is not valid
  21. throw new customException($email);
  22. }
  23. //check for "example" in mail address
  24. if(strpos($email, "example") !== FALSE)
  25. {
  26. throw new Exception("$email is an example e-mail");
  27. }
  28. }
  29.  
  30. catch (customException $e)
  31. {
  32. echo $e->errorMessage();
  33. }
  34.  
  35. catch(Exception $e)
  36. {
  37. echo $e->getMessage();
  38. }
  39. ?>

例子解释:

上面的代码测试了两种条件,如何任何条件不成立,则抛出一个异常:

  • customException() 类是作为旧的 exception 类的一个扩展来创建的。这样它就继承了旧类的所有属性和方法。
  • 创建 errorMessage() 函数。如果 e-mail 地址不合法,则该函数返回一个错误消息。
  • 执行 "try" 代码块,在第一个条件下,不会抛出异常。
  • 由于 e-mail 含有字符串 "example",第二个条件会触发异常。
  • "catch" 代码块会捕获异常,并显示恰当的错误消息

如果没有捕获 customException,紧紧捕获了 base exception,则在那里处理异常。

重新抛出异常

有时,当异常被抛出时,您也许希望以不同于标准的方式对它进行处理。可以在一个 "catch" 代码块中再次抛出异常。

脚本应该对用户隐藏系统错误。对程序员来说,系统错误也许很重要,但是用户对它们并不感兴趣。为了让用户更容易使用,您可以再次抛出带有对用户比较友好的消息的异常:

  1. <?php
  2. class customException extends Exception
  3. {
  4. public function errorMessage()
  5. {
  6. //error message
  7. $errorMsg = $this->getMessage().' is not a valid E-Mail address.';
  8. return $errorMsg;
  9. }
  10. }
  11.  
  12. $email = "someone@example.com";
  13.  
  14. try
  15. {
  16. try
  17. {
  18. //check for "example" in mail address
  19. if(strpos($email, "example") !== FALSE)
  20. {
  21. //throw exception if email is not valid
  22. throw new Exception($email);
  23. }
  24. }
  25. catch(Exception $e)
  26. {
  27. //re-throw exception
  28. throw new customException($email);
  29. }
  30. }
  31.  
  32. catch (customException $e)
  33. {
  34. //display custom message
  35. echo $e->errorMessage();
  36. }
  37. ?>

例子解释:

上面的代码检测在邮件地址中是否含有字符串 "example"。如果有,则再次抛出异常:

  • customException() 类是作为旧的 exception 类的一个扩展来创建的。这样它就继承了旧类的所有属性和方法。
  • 创建 errorMessage() 函数。如果 e-mail 地址不合法,则该函数返回一个错误消息。
  • 把 $email 变量设置为一个有效的邮件地址,但含有字符串 "example"。
  • "try" 代码块包含另一个 "try" 代码块,这样就可以再次抛出异常。
  • 由于 e-mail 包含字符串 "example",因此触发异常。
  • "catch" 捕获到该异常,并重新抛出 "customException"。
  • 捕获到 "customException",并显示一条错误消息。

如果在其目前的 "try" 代码块中异常没有被捕获,则它将在更高层级上查找 catch 代码块。

设置顶层异常处理器 (Top Level Exception Handler)

set_exception_handler() 函数可设置处理所有未捕获异常的用户定义函数。

  1. <?php
  2. function myException($exception)
  3. {
  4. echo "<b>Exception:</b> " , $exception->getMessage();
  5. }
  6.  
  7. set_exception_handler('myException');
  8.  
  9. throw new Exception('Uncaught Exception occurred');
  10. ?>

以上代码的输出应该类似这样:

  1. Exception: Uncaught Exception occurred

在上面的代码中,不存在 "catch" 代码块,而是触发顶层的异常处理程序。应该使用此函数来捕获所有未被捕获的异常。

异常的规则

  • 需要进行异常处理的代码应该放入 try 代码块内,以便捕获潜在的异常。
  • 每个 try 或 throw 代码块必须至少拥有一个对应的 catch 代码块。
  • 使用多个 catch 代码块可以捕获不同种类的异常。
  • 可以在 try 代码块内的 catch 代码块中再次抛出(re-thrown)异常。

简而言之:如果抛出了异常,就必须捕获它。