如何布置服务

编辑本页

如何布置服务

当覆盖现有定义时,原始服务将丢失:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8
#配置/ services.yaml服务:App \梅勒:#这将用新的App\Mailer定义替换旧的App\Mailer定义#旧定义丢失App \梅勒:类:App \ NewMailer

大多数时候,这正是你想要做的。但有时,你可能想要装饰旧的(即应用装饰器模式).在这种情况下,应该保留旧服务,以便能够在新服务中引用它。这个配置替换了App \梅勒用一个新的,但把旧的作为参考

  • 属性
  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8 9 10 11
/ / src / DecoratingMailer.php名称空间应用程序/ /……使用ob娱乐下载组件DependencyInjection属性AsDecorator# (AsDecorator(装修:梅勒::类))DecoratingMailer/ /……

6.1

# (AsDecorator)属性在Symfony 6.1中引入。ob娱乐下载

装修选项告诉容器App \ DecoratingMailer服务替换App \梅勒服务。如果你在用默认的服务。yaml的配置,当装饰服务的构造函数使用装饰服务类暗示一个参数类型时,就会自动注入装饰服务。

如果你没有使用自动装配,或者装饰服务有多个构造函数参数类型暗示了装饰服务类,你必须显式地注入装饰服务(装饰服务的ID会自动更改为“。”):

  • 属性
  • YAML
  • XML
  • PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/ / src / DecoratingMailer.php名称空间应用程序/ /……使用ob娱乐下载组件DependencyInjection属性AsDecorator使用ob娱乐下载组件DependencyInjection属性MapDecorated# (AsDecorator(装修:梅勒::类))DecoratingMailer私人内心的公共函数__construct(# (MapDecorated)内心的->内心的=内心的;}/ /……

提示

装饰的可见性App \梅勒服务(这是新服务的别名)将仍然与原始服务相同App \梅勒可见性。

请注意

生成的内部id基于装饰器服务的id (App \ DecoratingMailer这里),而不是装饰的服务(App \梅勒这里)。控件控制内部服务名decoration_inner_name选择:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6
#配置/ services.yaml服务:App \ DecoratingMailer:#……decoration_inner_name:App \ DecoratingMailer.wooz参数:(“@App \ DecoratingMailer.wooz”)

装饰的优先级

类对服务应用多个装饰器时,可以控制它们的顺序decoration_priority选择。取值为整数,默认为0更高的优先级意味着更早地应用装饰器。

  • 属性
  • YAML
  • XML
  • PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/ /……使用ob娱乐下载组件DependencyInjection属性AsDecorator使用ob娱乐下载组件DependencyInjection属性MapDecorated#[AsDecorator(装饰:Foo::class,优先级:5)]酒吧私人内心的公共函数__construct(# (MapDecorated)内心的->内心的=内心的;}/ /……#[AsDecorator(装饰:Foo::class,优先级:1)]巴兹私人内心的公共函数__construct(# (MapDecorated)内心的->内心的=内心的;}/ /……

生成的代码如下所示:

1
->服务(Foo::类]=巴兹(栏(Foo ()));

叠加修饰符

使用装饰优先级的另一种选择是创建一个堆栈订购的服务,一个接一个

  • YAML
  • XML
  • PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
#配置/ services.yaml服务:decorated_foo_stack:栈:-类:巴兹参数:(“@.inner”)-类:酒吧参数:(“@.inner”)-类:喷火使用简短的语法:decorated_foo_stack:栈:-记者:(“@.inner”)-栏:(“@.inner”)-Foo:#可以在启用autowiring时简化:decorated_foo_stack:栈:-记者:-栏:-Foo:

结果将与前一节相同:

1
->服务(“decorated_foo_stack”] =巴兹(栏(Foo ()));

比如别名,a堆栈只能使用公共而且弃用属性。

每一帧堆栈可以是内联服务、引用或子定义。后者允许嵌入堆栈定义相互转换,这里有一个合成的高级示例:

  • YAML
  • XML
  • PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16
#配置/ services.yaml服务:some_decorator:类:App \装饰embedded_stack:栈:-别名:some_decorator-App \装饰:decorated_foo_stack:栈:-家长:embedded_stack-记者:-栏:-Foo:

结果将是:

1
->服务(“decorated_foo_stack”] =App \装饰(App \装饰(巴兹(栏(Foo ()))));

请注意

要改变现有的堆栈(即从编译器传递),你可以通过它生成的id访问每一帧,其结构如下:.stack_id.frame_key.从上面的例子中,.decorated_foo_stack.1将是一个内联的引用巴兹服务和.decorated_foo_stack.0到嵌入式堆栈。为了获得更明确的id,你可以给每一帧命名:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8
#……decorated_foo_stack:栈:第一:家长:embedded_stack第二:记者:#……

巴兹帧id现在是.decorated_foo_stack.second

当被装饰的服务不存在时控制行为

当您装饰一个不存在的服务时,decoration_on_invalid选项允许你选择要采取的行为。

有三种不同的行为:

  • 异常:一个ServiceNotFoundException将抛出,告诉该装饰器的依赖项丢失。(默认)
  • 忽略:容器将移除装饰器。
  • :容器将保持decorator服务,并将被装饰的服务设置为
  • 属性
  • YAML
  • XML
  • PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ /……使用ob娱乐下载组件DependencyInjection属性AsDecorator使用ob娱乐下载组件DependencyInjection属性MapDecorated使用ob娱乐下载组件DependencyInjectionContainerInterface#[AsDecorator(decorator: Mailer::class, onInvalid: ContainerInterface::IGNORE_ON_INVALID_REFERENCE)]酒吧私人内心的公共函数__construct(# (MapDecorated)内心的->内心的=内心的;}/ /……

谨慎

当使用,你可能需要更新装饰器的构造函数,以使装饰依赖为空:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/ / src /服务/ DecoratorService.php名称空间应用程序服务使用AcmeOptionalBundle服务OptionalServiceDecoratorService私人装饰公共函数__construct(?OptionalService装饰->装饰=装饰;}公共函数tellInterestingStuff()字符串如果(!->装饰){返回“只有一件有趣的事”;}返回->装饰->tellInterestingStuff()。“+一个更有趣的事情”;}}

请注意

有时,您可能希望添加一个编译器通道,以便动态地创建服务定义。如果您想装饰这样一个服务,请确保您的编译器通道已注册PassConfig: TYPE_BEFORE_OPTIMIZATION键入,以便装饰通道能够找到创建的服务。

此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。
ob娱乐下载Symfony 6.2支持通过苏禄人
ob娱乐下载Symfony 6.2支持通过Les-Tilleuls.coop