如何创建服务别名和标记服务为私有

编辑本页

警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 3.2,现已不再维护。

本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。

如何创建服务别名和标记服务为私有

将服务标记为公共/私有

在定义服务时,您通常希望能够在应用程序代码中访问这些定义。这些服务被称为公共.例如,学说服务是一项公共服务。方法从容器中获取它get ()方法:

1
学说容器->get (“原则”);

在某些情况下,是服务只有存在是为了被注入到另一个服务中如上所示,打算直接从容器中获取。

在这些情况下,为了获得较小的性能提升并确保服务不会直接从容器中检索,可以将服务设置为公共(即私人):

  • YAML
  • XML
  • PHP
1 2 3 4
服务:foo:类:例子\ Foo公众:

私有服务的特殊之处在于,由于容器知道该服务永远不会从外部请求,因此它可以优化是否实例化以及如何实例化。这提高了容器的性能。

既然服务是私人的,你不应该直接从容器中获取服务:

1
容器->get (“foo”);

可能有用,也可能没用,这取决于容器如何优化服务实例化,即使在它工作的情况下,也已弃用。简单地说:如果您不想从代码中直接访问服务,则可以将其标记为私有服务。

但是,如果一个服务被标记为私有,您仍然可以用别名(见下文)访问这个服务(通过别名)。

请注意

默认情况下,服务是公共的,但是将尽可能多的服务标记为私有是一个很好的实践。

混叠

有时您可能希望使用快捷方式访问某些服务。您可以通过别名来实现这一点,此外,您甚至可以别名非公共服务。

  • YAML
  • XML
  • PHP
1 2 3 4 5 6
服务:app.phpmailer:类:AppBundle \ \ PhpMailer邮件app.mailer:别名:app.phpmailer

这意味着当直接使用容器时,您可以访问app.phpmailer通过请求服务app.mailer这样的服务:

1
容器->get (“app.mailer”);//返回PhpMailer实例

提示

在YAML中,你还可以使用快捷方式来别名服务:

1 2 3
服务:#……app.mailer:“@app.phpmailer”

不以为然的服务

一旦你决定弃用某个服务(因为它已经过时或者你决定不再维护它),你可以弃用它的定义:

  • YAML
  • XML
  • PHP
1 2 3
acme.my_service:类:弃用:“% service_id %”服务弃用2.8而且删除3.0

现在,每次使用此服务时,都会触发一个弃用警告,建议您停止或更改对该服务的使用。

消息实际上是一个消息模板,用于替换出现的% service_id %服务id的占位符。你必须至少发生过一次% service_id %模板中的占位符。

请注意

弃用消息是可选的。如果没有设置,Symfoob娱乐下载ny将显示以下默认消息:“%service_id%”服务已弃用。你应该停止使用它,因为它很快就会被删除。

提示

强烈建议您定义一个自定义消息,因为默认的消息太通用了。好的消息将告知该服务何时被弃用,直到维护它以及使用替代服务(如果有的话)。

对于服务装饰器(见上文),如果定义没有修改已弃用状态,则它将从被装饰的定义继承该状态。

此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。