Symfony 服务容器

Symfony 服务容器是 Symfony 框架中的一个核心组件，它允许你创建可重用、可扩展且可配置的服务。本文将介绍服务容器的基本原理、使用方法以及常见的一些应用场景。

原理

服务容器依赖于依赖注入（Dependency Injection）模式。简单来说，依赖注入就是将一个对象所依赖的其他对象作为参数传递进来，而不是在对象内部去创建这些对象。这样做的好处是提高了对象之间的可重用性和可测试性。

在 Symfony 中，服务容器就是用来管理各种服务的。每一个服务都有一个唯一的标识符和配置选项，可以在应用程序的任何地方使用。在使用服务时，只需要随时从服务容器中获取即可。

使用方法

注册服务

在 Symfony 中，注册服务需要在一个配置文件中定义。通常情况下，这个配置文件是在 app/config/services.yml 文件中。下面是一个例子：

# app/config/services.yml

services:
  app.foo:
    class: AppBundle\Foo
    arguments: ['%foo.bar%']

这里我们注册了一个名为 app.foo 的服务，它的类是 AppBundle\Foo，构造函数需要一个名为 foo.bar 的参数。在获取这个服务时，服务容器会自动解析参数并且实例化一个 AppBundle\Foo 对象。如果这个服务在之后的其他地方也需要用到，只需要使用相同的标识符即可。

获取服务

使用服务时，只需要从服务容器中获取即可。在 Symfony 中，最常用的方式是在控制器中使用依赖注入来获取服务：

// src/AppBundle/Controller/DefaultController.php

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Response;

class DefaultController extends Controller
{
    public function indexAction()
    {
        $foo = $this->get('app.foo');
        $result = $foo->doSomething();

        return new Response($result);
    }
}

这里我们获取了之前注册的 app.foo 服务，并且调用了它的 doSomething() 方法。注意到服务容器是在 Controller 类中设置的，因此我们需要继承 Controller 类才能在控制器中使用 $this->get() 方法。

设置参数

在配置文件中，我们可以定义任意数量的参数并将它们注入到服务中。例如：

# app/config/services.yml

parameters:
  foo.bar: 'hello world'

services:
  app.foo:
    class: AppBundle\Foo
    arguments: ['%foo.bar%']

我们定义了一个名为 foo.bar 的参数。然后，我们在服务定义中使用了这个参数，将它注入到 AppBundle\Foo 的构造函数中。

应用场景

服务容器的应用场景非常广泛。下面列举了几个常见的例子。

数据库查询

在许多应用程序中，需要频繁地进行数据库查询。为了避免在每个控制器方法中编写相同的数据库查询代码，可以将数据库连接作为一个服务注册到服务容器中，然后在需要查询时从服务容器中获取即可。

# app/config/services.yml

services:
  app.db:
    class: PDO
    arguments:
      - 'mysql:dbname=database;host=localhost'
      - 'username'
      - 'password'

注意到这里我们使用了 PDO 类作为服务的类。当然，你也可以使用任何其他的数据库连接类。

邮件发送

类似地，在发送电子邮件时，可能需要连接到 SMTP 服务器、设置参数、构造邮件对象等。为了避免在每个控制器方法中重复这些步骤，可以将邮件发送器封装为一个服务并注册到服务容器中。

# app/config/services.yml

services:
  app.mailer:
    class: Swift_Mailer
    arguments:
      - '%mailer.transport%'
      - 'username'
      - 'password'

  app.mailer.transport:
    class: Swift_SmtpTransport
    arguments:
      - '%mailer.host%'
      - '%mailer.port%'
      - '%mailer.security%'

这里我们注册了两个服务，一个是邮件发送器，一个是 SMTP 连接。在邮件发送器的构造函数中，我们将这两个服务注入进去。

认证

在管理系统中，可能需要对用户进行认证。为了避免在每个控制器方法中编写相同的认证代码，可以将认证逻辑封装为一个服务并注册到服务容器中。当用户成功登录之后，服务容器就可以将用户信息存储起来，并且在整个请求周期内一直保持不变。

# app/config/services.yml

services:
  app.authenticator:
    class: AppBundle\Security\AppAuthenticator
    public: true
    arguments:
      - '@security.encoder_factory'
      - '@doctrine.orm.entity_manager'
      - '@router'

  app.user_provider:
    class: AppBundle\Security\UserProvider

  app.security.firewall_listener:
    class: AppBundle\Security\FirewallListener
    arguments:
      - '@security.token_storage'
      - '@security.authentication_manager'
      - '@security.entry_point.form_login'
      - '@app.authenticator'
      - '@app.user_provider'
      - '@logger'
    tags:
      - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 4 }

这里我们注册了三个服务，分别是认证器、用户提供器和防火墙监听器。在防火墙监听器中，我们将认证器和用户提供器注入进去，然后注册了一个事件监听器，用来在请求开始时进行用户认证。

总结

服务容器是 Symfony 框架中非常重要的一个组件。它允许你将应用程序中的各种功能封装为可重用的服务，并且可以在任何地方使用。通过合理地使用服务容器，可以提高应用程序的可重用性、可扩展性和可测试性。