NelmioCorsBundle中如何集成Monolog日志记录

在使用NelmioCorsBundle处理跨域资源共享(CORS)时，开发者可能会遇到需要记录相关日志的需求。本文将详细介绍如何在该Bundle中集成Monolog日志功能。

问题背景

NelmioCorsBundle默认提供了CORS请求处理功能，但其内置的CorsListener类虽然支持日志记录功能，却没有自动注入日志服务。这导致开发者无法直接使用Monolog来记录CORS相关的日志信息。

解决方案

要解决这个问题，我们需要手动配置服务容器，将Monolog日志服务注入到CorsListener中。以下是具体实现步骤：

1. 理解服务定义：NelmioCorsBundle的原始服务定义中，CorsListener类确实预留了logger参数，但默认没有注入。

2. 自定义服务配置：在项目的服务配置文件(通常是config/services.yaml或services.php)中，我们需要重新定义CorsListener服务。

3. 具体配置代码：以下是完整的服务配置代码示例：

services:
    nelmio_cors.cors_listener:
        class: Nelmio\CorsBundle\EventListener\CorsListener
        arguments:
            $configurationResolver: '@nelmio_cors.options_resolver'
            $logger: '@Psr\Log\LoggerInterface'
        tags:
            - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 250 }
            - { name: kernel.event_listener, event: kernel.response, method: onKernelResponse, priority: 0 }
        public: true

或者使用PHP配置方式：

use Nelmio\CorsBundle\EventListener\CorsListener;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();
    
    $services->set('nelmio_cors.cors_listener')
        ->class(CorsListener::class)
        ->arg('$configurationResolver', service('nelmio_cors.options_resolver'))
        ->arg('$logger', service(LoggerInterface::class))
        ->tag('kernel.event_listener', [
            'event' => 'kernel.request',
            'method' => 'onKernelRequest',
            'priority' => 250
        ])
        ->tag('kernel.event_listener', [
            'event' => 'kernel.response',
            'method' => 'onKernelResponse',
            'priority' => 0
        ])
        ->public();
};

实现原理

这种解决方案的核心在于：

1. 服务覆盖：通过重新定义同名服务，我们覆盖了Bundle默认的服务配置。

2. 依赖注入：明确指定了logger参数，将其绑定到PSR-3标准的LoggerInterface服务。

3. 保持原有功能：同时保留了原始配置中的所有其他参数和标签，确保CORS功能不受影响。

注意事项

1. 版本兼容性：此解决方案适用于NelmioCorsBundle 2.4及以上版本，以及Symfony 4.3+。

2. 日志级别：CorsListener内部会根据不同情况记录不同级别的日志，开发者可以在Monolog配置中设置适当的日志级别来过滤这些记录。

3. 性能考虑：在生产环境中，过多的日志记录可能会影响性能，建议根据实际需求调整日志级别。

通过以上配置，开发者现在可以在NelmioCorsBundle中充分利用Monolog的强大日志功能，更好地监控和调试CORS相关请求。