通用错误处理程序

开发通用错误处理程序的过程与前面的配方非常相似。但是有一些不同之处。首先,在 PHP 7 中,有些错误是被抛出的,并且可以被捕获,而其他错误则会让你的应用程序停止运行。更加让人困惑的是,有些错误被当作异常处理,而其他错误则是由新的 PHP 7 Error 类衍生出来的。幸运的是,在 PHP 7 中,ErrorException 都实现了一个叫做 Throwable 的新接口。因此,如果你不确定你的代码会抛出Exception还是Error,只需捕获一个Throwable的实例,就可以同时捕获这两种情况。

如何做…

1.修改前面事例中定义的Application\Error\Handler类。在构造函数中,设置一个新的errorHandler()方法作为默认的错误处理程序。

  1. public function __construct($logFileDir = NULL, $logFile = NULL)
  2. {
  3. $logFile = $logFile ?? date('Ymd') . '.log';
  4. $logFileDir = $logFileDir ?? __DIR__;
  5. $this->logFile = $logFileDir . '/' . $logFile;
  6. $this->logFile = str_replace('//', '/', $this->logFile);
  7. set_exception_handler([$this,'exceptionHandler']);
  8. set_error_handler([$this, 'errorHandler']);
  9. }
  1. 然后我们使用文档中的参数定义新方法。就像我们的异常处理程序一样,我们将信息记录到一个日志文件中。
  1. public function errorHandler($errno, $errstr, $errfile, $errline)
  2. {
  3. $message = sprintf('ERROR: %s : %d : %s : %s : %s' . PHP_EOL,
  4. date('Y-m-d H:i:s'), $errno, $errstr, $errfile, $errline);
  5. file_put_contents($this->logFile, $message, FILE_APPEND);
  6. }
  1. 另外,为了能够区分错误和异常,在exceptionHandler()方法中向日志文件发送的消息中加入exception
  1. public function exceptionHandler($ex)
  2. {
  3. $message = sprintf('EXCEPTION: %19s : %20s : %s' . PHP_EOL,
  4. date('Y-m-d H:i:s'), get_class($ex), $ex->getMessage());
  5. file_put_contents($this->logFile, $message, FILE_APPEND);
  6. }

如何运行…

首先,对前面定义的Application\Error\Handler进行修改。接下来,创建一个抛出错误的类,在这个例子中,可以定义为Application\Error\ThrowsError。例如,你可以有一个方法试图进行除以零的操作,另一个方法试图使用eval()来解析非PHP代码。

  1. <?php
  2. namespace Application\Error;
  3. class ThrowsError
  4. {
  5. const NOT_PARSE = 'this will not parse';
  6. public function divideByZero()
  7. {
  8. $this->zero = 1 / 0;
  9. }
  10. public function willNotParse()
  11. {
  12. eval(self::NOT_PARSE);
  13. }
  14. }

然后你可以定义一个名为chap_13_error_throwable.php的调用程序,设置自动加载,使用相应的类,并创建ThrowsError的实例。

  1. <?php
  2. require __DIR__ . '/../Application/Autoload/Loader.php';
  3. Application\Autoload\Loader::init(__DIR__ . '/..');
  4. use Application\Error\ { Handler, ThrowsError };
  5. $error = new ThrowsError();

如果你再调用这两个方法,没有try/catch块,也没有定义通用错误处理程序,那么第一个方法会产生一个Warning,而第二个方法会抛出一个ParseError

  1. $error->divideByZero();
  2. $error->willNotParse();
  3. echo 'Application continues ... ' . PHP_EOL;

因为这是一个错误,程序执行停止,你不会看到应用程序继续。

通用错误处理程序 - 图1

如果将方法调用包裹在try/catch块中,并抓取Throwable,则代码会继续执行。

  1. try {
  2. $error->divideByZero();
  3. } catch (Throwable $e) {
  4. echo 'Error Caught: ' . get_class($e) . ':'
  5. . $e->getMessage() . PHP_EOL;
  6. }
  7. try {
  8. $error->willNotParse();
  9. } catch (Throwable $e) {
  10. echo 'Error Caught: ' . get_class($e) . ':'
  11. . $e->getMessage() . PHP_EOL;
  12. }
  13. echo 'Application continues ... ' . PHP_EOL;

从下面的输出中,你还会注意到,程序退出时,代码为0,这说明一切正常。

通用错误处理程序 - 图2

最后,在try/catch块之后,再次运行错误,将echo语句移到最后。你将在输出中看到错误被捕获,但在日志文件中,注意到DivisionByZeroError是由异常处理程序捕获的,而ParseError是由错误处理程序捕获的。

  1. $handler = new Handler(__DIR__ . '/logs');
  2. $error->divideByZero();
  3. $error->willNotParse();
  4. echo 'Application continues ... ' . PHP_EOL;

通用错误处理程序 - 图3

更多…

PHP 7.1 允许在 catch()子句中指定多个类,因此,可以用 catch (Exception | Error $e) { xxx }代替单个 Throwable