如何从服务访问应用程序参数？

Question

从我的控制器中，我访问应用程序参数（/app/config 中的参数）

$this->container->getParameter('my_param')

但我不知道如何从服务访问它（我想我的服务类不应该扩展 Symfony\Bundle\FrameworkBundle\Controller\Controller）。

我是否应该像这样将所需的参数映射到我的服务注册中：

#src/Me/MyBundle/Service/my_service/service.yml
parameters:
    my_param1: %my_param1%
    my_param2: %my_param2%
    my_param3: %my_param3%

或类似的东西？我应该如何从服务访问我的应用程序参数？

---

This question 看起来是一样的，但实际上我的答案是（来自控制器的参数），我说的是从服务访问。

Answer 1

2018 年清洁方式

自 2018 年和 Symfony 3.4 以来有更简洁的方式 - 易于设置和使用。

您可以通过类的构造函数将参数传递给类，而不是使用容器和服务/参数定位器反模式。别担心，这不是耗时的工作，而是设置一次后忘记的方法。

如何分两步设置？

1。 config.yml

# config.yml
parameters:
    api_pass: 'secret_password'
    api_user: 'my_name'

services:
    _defaults:
        autowire: true
        bind:
            $apiPass: '%api_pass%'
            $apiUser: '%api_user%'

    App\:
        resource: ..

2。任何Controller

<?php declare(strict_types=1);

final class ApiController extends SymfonyController
{
    /**
     * @var string 
     */
    private $apiPass;

    /**
     * @var string
     */
    private $apiUser;

    public function __construct(string $apiPass, string $apiUser)
    {
        $this->apiPass = $apiPass;
        $this->apiUser = $apiUser;
    }

    public function registerAction(): void
    {
        var_dump($this->apiPass); // "secret_password"
        var_dump($this->apiUser); // "my_name"
    }
}

即时升级就绪！

如果您使用较旧的方法，您可以automate it with Rector。

了解更多

这称为构造函数注入服务定位器方法。

要了解更多信息，请查看我的帖子How to Get Parameter in Symfony Controller the Clean Way。

（它已经过测试，我会为新的 Symfony 主要版本（5、6...）进行更新。

Answer 2

@richsage 是正确的（对于 Symfony 3.?），但它不适用于我的 Symfony 4.x。所以这里是 Symfony 4。

在 services.yaml 文件中

parameters:
    param1: 'hello'

Services:
    App\Service\routineCheck:
            arguments:
                $toBechecked: '%param1%'  # argument must match in class constructor

在你的服务类routineCheck.php文件中做这样的构造函数

private $toBechecked;

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

public function echoSomething()
{
    echo $this->toBechecked;
}

完成。

Answer 3

在symfony 4中，我们可以通过依赖注入的方式访问参数：

服务：

   use Symfony\Component\DependencyInjection\ContainerInterface as Container;

   MyServices {

         protected $container;
         protected $path;

         public function __construct(Container $container)
         {
             $this->container = $container;
             $this->path = $this->container->getParameter('upload_directory');
         }
    }

parameters.yml：

parameters:
     upload_directory: '%kernel.project_dir%/public/uploads'

Answer 4

使用 Symfony 4.1 解决方案非常简单。

这是来自原始帖子的 sn-p：

// src/Service/MessageGenerator.php
// ...

use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;

class MessageGenerator
{
    private $params;

    public function __construct(ParameterBagInterface $params)
    {
        $this->params = $params;
    }

    public function someMethod()
    {
        $parameterValue = $this->params->get('parameter_name');
        // ...
    }
}

原帖链接： https://symfony.com/blog/new-in-symfony-4-1-getting-container-parameters-as-a-service

Answer 5

自 symfony 4.1 以来有一种非常干净的新方法来实现它

<?php
// src/Service/MessageGeneratorService.php

use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;

class MessageGeneratorService
{
 private $params;
 public function __construct(ParameterBagInterface $params)
 {
      $this->params = $params;
 }
 public function someMethod()
 {
     $parameterValue = $this->params->get('parameter_name');
...
 }
}

来源：https://symfony.com/blog/new-in-symfony-4-1-getting-container-parameters-as-a-service.

Answer 6

这里是 Symfony 3.4。

经过一些研究，我认为通过其构造函数将参数传递给类/服务始终不是一个好主意。 想象一下，如果您需要向控制器/服务传递比 2 或 3 个更多的参数。然后呢？最多传递 10 个参数会很荒谬。

相反，在 yml 中声明服务时，使用 ParameterBag 类作为依赖项，然后使用任意数量的参数。

一个具体的例子，假设你有一个邮件服务，比如 PHPMailer，并且你想在 paramters.yml 文件中拥有 PHPMailer 连接参数：

#parameters.yml
parameters:
    mail_admin: abc@abc.abc
    mail_host: mail.abc.com
    mail_username: noreply@abc.com
    mail_password: pass
    mail_from: contact@abc.com
    mail_from_name: contact@abc.com
    mail_smtp_secure: 'ssl'
    mail_port: 465

#services.yml
services:
    app.php_mailer:
        class: AppBundle\Services\PHPMailerService
        arguments: ['@assetic.parameter_bag'] #here one could have other services to be injected
        public: true

# AppBundle\Services\PHPMailerService.php
...
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
...
class PHPMailerService
{
    private $parameterBag;
    private $mailAdmin;
    private $mailHost;
    private $mailUsername;
    private $mailPassword;
    private $mailFrom;
    private $mailFromName;
    private $mailSMTPSecure;
    private $mailPort;
}
public function __construct(ParameterBag $parameterBag)
{
    $this->parameterBag = $parameterBag;

    $this->mailAdmin      = $this->parameterBag->get('mail_admin');
    $this->mailHost       = $this->parameterBag->get('mail_host');
    $this->mailUsername   = $this->parameterBag->get('mail_username');
    $this->mailPassword   = $this->parameterBag->get('mail_password');
    $this->mailFrom       = $this->parameterBag->get('mail_from');
    $this->mailFromName   = $this->parameterBag->get('mail_from_name');
    $this->mailSMTPSecure = $this->parameterBag->get('mail_smtp_secure');
    $this->mailPort       = $this->parameterBag->get('mail_port');
}
public function sendEmail()
{
    //...
}

我认为这是一个更好的方法。

Answer 7

您可以像注入其他服务一样将参数传递给您的服务，方法是在服务定义中指定参数。例如，在 YAML 中：

services:
    my_service:
        class:  My\Bundle\Service\MyService
        arguments: [%my_param1%, %my_param2%]

其中%my_param1% 等对应于名为my_param1 的参数。那么你的服务类构造函数可以是：

public function __construct($myParam1, $myParam2)
{
    // ...
}

Answer 8

作为解决提到的一些问题，我定义了一个数组参数然后注入它。稍后添加新参数只需要添加到参数数组，而不需要对 service_container 参数或构造进行任何更改。

所以扩展 @richsage 答案：

parameters.yml

parameters:
    array_param_name:
        param_name_1:   "value"
        param_name_2:   "value"

services.yml

services:
    my_service:
        class:  My\Bundle\Service\MyService
        arguments: [%array_param_name%]

然后在类里面访问

public function __construct($params)
{
    $this->param1 = array_key_exists('param_name_1',$params)
        ? $params['param_name_1'] : null;
    // ...
}

Answer 9

与其一一映射你需要的参数，为什么不让你的服务直接访问容器呢？这样做，如果添加了新参数（与您的服务相关），您不必更新映射。

这样做：

对您的服务类进行以下更改

use Symfony\Component\DependencyInjection\ContainerInterface; // <- Add this

class MyServiceClass
{
    private $container; // <- Add this
    public function __construct(ContainerInterface $container) // <- Add this
    {
        $this->container = $container;
    }
    public function doSomething()
    {
        $this->container->getParameter('param_name_1'); // <- Access your param
    }
}

在你的 services.yml 中添加 @service_container 作为“参数”

services:
  my_service_id:
    class: ...\MyServiceClass
    arguments: ["@service_container"]  // <- Add this