Symfony autowiring monolog渠道

时间:2017-05-04 16:17:43

标签: symfony monolog symfony-3.2

documentation之后,我可以创建多个渠道,这些渠道将使用以下名称创建服务monolog.logger.<channel_name>

如何通过DI注入和自动装配将这些服务注入我的服务?

class FooService
{
    public function __construct(LoggerInterface $loggerInterface) {  }
}

YAML

#existing
foo_service:
    class: AppBundle\Services\FooService
    arguments: ["@monolog.logger.barchannel"]
# what I want to do
foo_service:
    autowire: true # how to inject @monolog.logger.barchannel ? 

9 个答案:

答案 0 :(得分:8)

我写了(也许更复杂)的方法。我不想标记我的自动服务,告诉symfony使用哪个频道。 使用symfony 4和php 7.1。

我使用 monolog.channels 中定义的所有其他频道构建了LoggerFactory。

我的工厂是捆绑式的,所以在 Bundle.php 添加

$container->addCompilerPass(
    new LoggerFactoryPass(), 
    PassConfig::TYPE_BEFORE_OPTIMIZATION, 
    1
); // -1 call before monolog

monolog.bundle 之前调用此编译器是很重要的,因为传递后的monolog会从容器中删除参数。

现在,LoggerFactoryPass     

namespace Bundle\DependencyInjection\Compiler;


use Bundle\Service\LoggerFactory;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

class LoggerFactoryPass implements CompilerPassInterface
{

    /**
     * You can modify the container here before it is dumped to PHP code.
     * @param ContainerBuilder $container
     * @throws \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
     * @throws \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException
     */
    public function process(ContainerBuilder $container): void
    {
        if (!$container->has(LoggerFactory::class) || !$container->hasDefinition('monolog.logger')) {
            return;
        }

        $definition = $container->findDefinition(LoggerFactory::class);
        foreach ($container->getParameter('monolog.additional_channels') as $channel) {
            $loggerId = sprintf('monolog.logger.%s', $channel);
            $definition->addMethodCall('addChannel', [
                $channel,
                new Reference($loggerId)
            ]);
        }
    }
}

和LoggerFactory     

namespace Bundle\Service;

use Psr\Log\LoggerInterface;

class LoggerFactory
{
    protected $channels = [];

    public function addChannel($name, $loggerObject): void
    {
        $this->channels[$name] = $loggerObject;
    }

    /**
     * @param string $channel
     * @return LoggerInterface
     * @throws \InvalidArgumentException
     */
    public function getLogger(string $channel): LoggerInterface
    {
        if (!array_key_exists($channel, $this->channels)) {
            throw new \InvalidArgumentException('You are trying to reach not defined logger channel');
        }

        return $this->channels[$channel];
    }
}

所以,现在你可以注入LoggerFactory,并选择你的频道

public function acmeAction(LoggerFactory $factory)
{
    $logger = $factory->getLogger('my_channel');
    $logger->log('this is awesome!');
}

答案 1 :(得分:7)

经过一些搜索后,我找到了一些使用标签的解决方法,并手动将几个参数注入到自动服务中。

我的回答与@ Thomas-Landauer类似。不同的是,我不必手动创建记录器服务,因为编译器从monolog bundle传递给我做了这个。

services:
    _defaults:
        autowire: true
        autoconfigure: true
    AppBundle\Services\FooService:
        arguments:
            $loggerInterface: '@logger'
        tags:
            - { name: monolog.logger, channel: barchannel }

答案 2 :(得分:4)

我没有找到一种方法来自动跟踪记录器频道。但是,我找到了一种在原则上使用autowire 的方法,并手动注入记录器。使用class FooService,这就是services.yml的样子(Symfony 3.3):

# services.yml

services:
    _defaults:
        autowire: true
        autoconfigure: true
    AppBundle\Services\FooService:
        arguments:
            $loggerInterface: '@monolog.logger.barchannel'

所以&#34;技巧&#34;是显式注入记录器通道,同时仍然通过自动装配注入此服务的所有其他依赖项。

答案 3 :(得分:4)

从MonologBu​​ndle 3.5开始,您可以自动连接不同的Monolog 通过以下类型来暗示您的服务参数来进行渠道 语法:Psr\Log\LoggerInterface $<channel>Logger。例如, 使用以下方法注入与应用程序记录器频道相关的服务:

public function __construct(LoggerInterface $appLogger)
{
   $this->logger = $appLogger;
}

https://symfony.com/doc/current/logging/channels_handlers.html#monolog-autowire-channels

答案 4 :(得分:3)

您可以使用bind parameter

services:
    _defaults:
        autowire: true      # Automatically injects dependencies in your services.
        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
        public: true
        bind:
            $loggerMyApi: '@monolog.logger.my_api'

然后您可以在服务的构造函数中使用它:

use Psr\Log\LoggerInterface;
...
public function __construct(LoggerInterface $loggerMyApi)
{
...
}

答案 5 :(得分:0)

基本上,您有两个选择:

首先,服务标签:

services:
App\Log\FooLogger:
    arguments: ['@logger']
    tags:
        - { name: monolog.logger, channel: foo }

然后,您可以将CustomLogger用作其他地方的依赖项

第二,您可以依靠Monolog为配置中的每个自定义渠道自动注册记录器:

# config/packages/prod/monolog.yaml
monolog:
    channels: ['foo', 'bar']

您将可以使用以下服务:monolog.logger.foo,'monolog.logger.bar'

然后您可以从服务容器中检索它们,或手动将它们连接起来,例如:

services:
App\Lib\MyService:
    $fooLogger: ['@monolog.logger.foo']

您可以阅读更多herehere

答案 6 :(得分:0)

最近,我通过MonologBu​​ndle实现了对所有注册记录器的单点访问。 而且,我尝试做一些更好的解决方案-并自动生成了记录器装饰器。每个类都装饰一个已注册的独白通道的一个对象。

链接到捆绑包adrenalinkin/monolog-autowire-bundle

答案 7 :(得分:0)

对于那些仍在为此奋斗的人。 在Symfony 4.3中,最重要的是,我为特定通道添加了一个别名,因为没有它,它只能在开发环境中工作:在构建时,单元测试全部失败,因为自定义记录器是未定义的服务

 monolog.logger.my_custom_logger:         
   alias: Psr\Log\LoggerInterface         
   public: true 

 App\Logger\MyLogger:         
   arguments:             
     $logger: '@monolog.logger.my_custom_logger'

答案 8 :(得分:0)

现在可以从documentation根据参数名称的类型提示自动接线。

// autowires monolog with "foo" channel
public function __construct(\Psr\Log\LoggerInterface $fooLogger);