像 Symfony 一样“重新利用”原始的 ErrorListener 来记录异常

2024-03-03 16:58:05

在 Symfony 中如何巧妙地利用 ErrorListener 记录异常

在 Symfony 应用中，ErrorListener 就像一位尽职尽责的记录员，默默地记录着发生的各种异常情况。它不仅能记录 WithErrorLevel 属性和状态代码，还能以一种清晰易懂的格式呈现错误信息。但在实际开发中，我们常常需要根据业务逻辑进行定制化的异常处理，这时，如果能像 Symfony 核心机制一样，优雅地复用 ErrorListener 的记录功能，无疑会提升代码的简洁性和可维护性。

那么，如何实现这个目标呢？我们可以借助自定义异常处理器，巧妙地将 ErrorListener 的能力融入到我们自己的异常处理流程中。

构建自定义异常处理器

首先，我们需要创建一个自定义的异常处理器，它的主要职责是判断异常是否已经被系统识别处理。如果异常尚未被处理，那么就将接力棒传递给 ErrorListener，让它完成记录工作。

自定义异常处理器示例：

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\Exception\HttpException;

class CustomExceptionHandler implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return [
            'kernel.exception' => 'handleException',
        ];
    }

    public function handleException(ExceptionEvent $event): void
    {
        $exception = $event->getThrowable();

        // 判断异常是否已被识别处理
        if (!$this->isRecognizedException($exception)) {
            // 若未被处理，则调用 ErrorListener 进行记录
            $this->logException($exception);
        }
    }

    private function isRecognizedException($exception): bool
    {
        // 根据实际业务逻辑判断异常是否已被识别
        // 此处可根据异常类型、消息等进行判断
        return false; 
    }

    private function logException($exception): void
    {
        // 获取 ErrorListener 服务并调用其 log 方法
        $errorListener = $this->errorListener; 
        $errorListener->log($exception);
    }
}

注册自定义异常处理器

创建好自定义异常处理器后，我们需要将其注册到 Symfony 的事件调度机制中，让它能够监听 kernel.exception 事件，并在异常发生时被触发。

服务配置示例 (config/services.yaml)：

services:
    # ... 其他服务配置

    app.custom_exception_handler:
        class: App\EventListener\CustomExceptionHandler
        tags:
            - { name: kernel.event_listener, event: kernel.exception, method: handleException }

注入 ErrorListener 服务

为了能够在自定义异常处理器中调用 ErrorListener 的 log 方法，我们需要将 ErrorListener 服务注入到处理器中。

自动注入示例：

use Symfony\Component\HttpKernel\EventListener\ErrorListener;

class CustomExceptionHandler implements EventSubscriberInterface
{
    public function __construct(private ErrorListener $errorListener) {}

    // ... 其他方法
}

服务定位器示例：

use Symfony\Component\DependencyInjection\ContainerInterface;

class CustomExceptionHandler implements EventSubscriberInterface
{
    private $container;

    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    // ... 其他方法

    private function logException($exception): void
    {
        $errorListener = $this->container->get('error_listener');
        $errorListener->log($exception);
    }
}

总结

通过以上步骤，我们成功地构建了一个自定义异常处理器，并将其集成到 Symfony 的事件调度机制中，实现了像 Symfony 核心机制一样复用 ErrorListener 记录异常的功能。这种方法既保留了 ErrorListener 强大的记录能力，又赋予了开发者处理异常的灵活性，使代码更加简洁优雅。