浅谈PHP库之Whoops‌

一、Whoops‌的介绍

Whoops是一个开源的PHP错误处理库，以其优雅的界面和强大的功能深受开发者喜爱。它能够捕获并展示各种类型的错误，包括致命错误、警告、异常等，并以友好的方式呈现给开发者，极大提升了错误排查的效率。

二、Whoops的核心特性

优雅的错误展示：Whoops提供了美观的错误展示页面，包括错误类型、错误信息、文件位置、堆栈跟踪等详细信息。
强大的调试功能：支持代码高亮、变量查看等调试功能，帮助开发者快速定位问题。
灵活的扩展性：Whoops支持自定义处理器和页面模板，开发者可以根据需求进行扩展。
支持多种输出格式：Whoops支持将详细的调试信息以HTML、JSON、XML等多种格式输出，方便开发者根据需要选择输出方式。
轻量级：Whoops只有1200行代码，相较于其他异常处理库，它是非常轻量级的，这意味着在应用程序中引入它时，不会对项目产生太多的额外负担。

三、Whoops的简单使用

使用Whoops需要通过Composer安装Whoops扩展包，安装命令如下：

composer require filp/whoops

安装完成后，在应用程序中添加以下代码来注册Whoops的错误处理：

$whoops = new \Whoops\Run;
$whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler);
$whoops->register();

四、Whoops的详细使用

自定义异常页面

你可以创建一个自定义的异常页面处理器，来控制错误信息的展示方式：

use Whoops\Handler\HandlerInterface;
use Whoops\Handler\JsonResponseHandler;
use Whoops\Run;
use Whoops\Util\Misc;class CustomJsonResponseHandler extends JsonResponseHandler
{public function handle(){$exception = $this->getException();$inspector = Misc::inspectionFactory($exception);$response = new \stdClass();$response->error = ['type'    => get_class($exception),'message' => $exception->getMessage(),'file'    => $exception->getFile(),'line'    => $exception->getLine(),];// Add more details if neededhttp_response_code(500);header('Content-Type: application/json');echo json_encode($response);}
}$whoops = new Run();
$whoops->pushHandler(new CustomJsonResponseHandler());
$whoops->register();

条件性显示错误

在开发环境中显示详细的错误信息，在生产环境中只记录错误信息：

use Whoops\Handler\PrettyPageHandler;
use Whoops\Handler\HandlerInterface;
use Whoops\Run;$whoops = new Run();if ($_SERVER['ENVIRONMENT'] === 'development') {$whoops->pushHandler(new PrettyPageHandler());
} else {$whoops->pushHandler(new \Whoops\Handler\PlainTextHandler(function () {// 在这里添加你的日志记录逻辑error_log('An error occurred');}));
}$whoops->register();

异常处理中间件

如果你使用的是现代的PHP框架，如Laravel或Symfony，Whoops可以作为中间件集成到请求处理流程中：

// 对于Laravel
$app->error(function (Exception $e) {$whoops = new Run;$whoops->pushHandler(new PrettyPageHandler());$whoops->handleException($e);
});// 对于Symfony
$app->get('/', function (Request $request) use ($app) {try {// Your code here} catch (Exception $e) {$whoops = new Run;$whoops->pushHandler(new PrettyPageHandler());$whoops->handleException($e);}
});

忽略某些异常

有时候你可能想要忽略某些特定的异常，不显示错误页面：

use Whoops\Handler\HandlerInterface;
use Whoops\Handler\PrettyPageHandler;
use Whoops\Run;$whoops = new Run();$whoops->pushHandler(new HandlerInterface(function () {$exception = $this->getException();if ($exception instanceof \MyApp\IgnoredException) {// Do nothing, or handle it in a custom wayreturn HandlerInterface::QUIT;}// Fallback to pretty page handlerreturn new PrettyPageHandler();
}));$whoops->register();