如何使用范围

编辑该页面

警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 2.4,不再维护。

读这个页面的更新版本Symfob娱乐下载ony 6.3(当前的稳定版本)。

如何使用范围

这个条目都是关于作用域,有些先进的相关话题服务容器。如果你曾经得到一个错误提到“作用域”在创建服务时,那么这个条目是给你的。

请注意

如果你正试图注入请求服务,简单的解决方案是注入request_stack服务和访问当前请求通过调用getCurrentRequest ()方法(参见服务容器)。剩下的这个条目讨论范围理论和更先进的方式。如果你处理的范围请求服务,只需注射request_stack。

理解范围

服务的范围控制多久的实例使用一个服务容器。DependencyInjection组件提供了两种通用的范围:

  • 容器(默认):使用相同的实例从这个容器每次请求它。
  • 原型:每次创建一个新实例请求服务。

的ContainerAwareHttpKernel还定义了第三个范围:请求。这个范围的请求,这意味着创建一个新的实例为每个subrequest和不可用在请求(例如在CLI)。

一个例子:客户范围

以外的其他请求服务(一个简单的解决方案,见上面的注意),没有服务默认Symfony2容器属于任何以外的范围ob娱乐下载容器和原型。但对于本条目,想象有另一个范围客户端和服务client_configuration属于它。这不是一个常见的情况,但我们的想法是,你可以进入和退出多个客户端在请求作用域,每一个都有它自己的client_configuration服务。

范围添加一个约束依赖关系的服务:服务不能依赖服务从一个狭窄的范围。例如,如果您创建一个通用的my_foo服务,但试图注入client_configuration服务,您将收到一个ScopeWideningInjectionException当编译容器。读下面的侧边栏的更多细节。

范围和依赖关系

想象你已经配置了my_mailer服务。你没有配置服务的范围,所以它默认容器。换句话说,每次你问的容器my_mailer服务,您拿回相同的对象。这通常是你想要你的服务是如何工作的。

想象,然而,你需要client_configuration服务在你的my_mailer服务,也许因为你阅读一些细节,比如“发件人”地址应该是什么。你把它作为构造函数参数。这提出了一个问题:有几个原因

  • 当请求my_mailer的一个实例,my_mailer(称为MailerA和创建)client_configuration服务(称为ConfigurationA在这里)被传递给它。生活是美好的!
  • 您的应用程序与另一个客户,现在需要做些什么和你的应用程序架构以这样一种方式,你进入一个新的处理这个问题client_configuration并设置一个新的范围client_configuration服务容器。调用这个ConfigurationB。

  • 在您的应用程序,你再次询问my_mailer服务。因为你的服务容器范围,相同的实例(MailerA)是重用。但问题是:MailerA实例仍然包含旧的ConfigurationA对象,它是现在不正确的配置对象(ConfigurationB现在是当前client_configuration服务)。这是微妙的,但没别的可能会引发重大问题,这就是为什么这是不允许的。

    这就是原因为什么作用域存在,以及他们如何会导致一些问题。继续阅读,找出共同的解决方案。

请注意

服务当然可以依靠服务从一个更广泛的范围内没有任何问题。

使用服务从一个狭窄的范围

有几种解决方案的范围问题:

  • 如果依赖是A)使用setter注入同步(见如何使用范围);
  • B)把你的服务在同一范围的依赖(或一个窄)。如果你依靠client_configuration服务,这意味着把你的新服务客户端范围(见如何使用范围);
  • C)传递整个容器服务和检索你的依赖从容器每次你需要确保你有正确的实例——您的服务可以住在默认容器范围(见如何使用范围)。

下面几节详细讨论每个场景。

使用一个同步服务

2.3

在Symfony 2.3中引入了同步服务。ob娱乐下载

注入容器和设置您的服务范围较窄范围有缺点。第一个假设的client_configuration服务已被标记为同步:

1 2 3 4 5 6 7 8
# app / config / config.yml服务:client_configuration:类:Acme \ HelloBundle \ Client \ ClientConfiguration范围:客户端同步:真正的合成:真正的#……

现在,如果你使用setter注入,注入这个服务没有缺点和一切工作没有任何特殊代码在您的服务或您的定义:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日
/ / src / Acme / HelloBundle /邮件/ Mailer.php名称空间Acme\HelloBundle\邮件;使用Acme\HelloBundle\客户端\ClientConfiguration;类梅勒{受保护的美元clientConfiguration;公共函数setClientConfiguration(ClientConfiguration美元clientConfiguration= null){美元这- >clientConfiguration =美元clientConfiguration;}公共函数sendEmail(){如果(零= = =美元这- >clientConfiguration) {/ /抛出一个错误?}/ /……使用客户端配置的东西吗}}

每当客户端范围是活跃的,服务容器会自动调用setClientConfiguration ()方法时,client_configuration服务容器中设置。

您可能已经注意到,setClientConfiguration ()方法接受零作为一个有效的值client_configuration论点。这是因为当离开客户端范围,client_configuration实例可以零。当然,你应该照顾这种可能性在你的代码。这也应该考虑当宣布你的服务:

1 2 3 4 5 6
# src / Acme / HelloBundle /资源/ config / services.yml服务:my_mailer:类:Acme \ HelloBundle \邮件\梅勒电话:- - - - - -[setClientConfiguration,[" @ ? client_configuration = "]]

B)改变了您的服务的范围

改变服务的范围应该在其定义。这个例子假设梅勒类都有一个__construct函数的第一个参数ClientConfiguration对象:

1 2 3 4 5 6
# src / Acme / HelloBundle /资源/ config / services.yml服务:my_mailer:类:Acme \ HelloBundle \邮件\梅勒范围:客户端参数:[" @client_configuration "]

C)通过容器作为一个依赖你的服务

设置一个窄的范围并不总是可能的(例如,必须在树枝延伸容器范围的树枝环境需要依赖)。在这些情况下,您可以通过整个集装箱到你的服务:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/ / src / Acme / HelloBundle /邮件/ Mailer.php名称空间Acme\HelloBundle\邮件;使用ob娱乐下载\组件\DependencyInjection\ContainerInterface;类梅勒{受保护的美元容器;公共函数__construct(ContainerInterface美元容器){美元这- >容器=美元容器;}公共函数sendEmail(){美元请求=美元这- >容器- >get (“client_configuration”);/ /……使用客户端配置的东西吗}}

谨慎

注意不要将客户端配置存储在一个对象的属性为未来服务的调用,因为它会导致同样的问题描述的第一部分(除了Symfony不能检测到你错了)。ob娱乐下载

这个类的服务配置会看起来像这样:

1 2 3 4 5 6 7 8 9 10
# src / Acme / HelloBundle /资源/ config / services.yml参数:#……my_mailer.class:Acme \ HelloBundle \邮件\梅勒服务:my_mailer:类:“% my_mailer.class %”参数:[" @service_container "]#范围:容器可以省略,因为它是默认的

请注意

将整个容器注入服务通常不是一个好主意(只有注入您所需要的)。

这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。
TOC
    版本
    版本:
    考试在家里

    考试在家里

    阅读我们完整的Symfony和PHP目录ob娱乐下载为您的web开发需要的解决方案。

    阅读我们完整的Symfony和PHP目录ob娱乐下载为您的web开发需要的解决方案。