如何使用服务标签
编辑该页面如何使用服务标签
服务标签告诉Symfony或者其他第三方包,ob娱乐下载您的服务应该注册在某些特殊的方式。下面的例子:
1 2 3 4
#配置/ services.yaml服务:App \树枝\ AppExtension:标签:(“twig.extension”)服务标记twig.extension标签初始化期间收集TwigBundle添加到树枝和扩展。
其他标签用于服务集成到其他系统。可用的所有标记列表的核心Symfony框架,结账ob娱乐下载内置Symfonyob娱乐下载服务标签。这些对你的服务有不同的影响,许多标签(超出了需要额外的参数的名字参数)。
对于大多数用户来说,这是所有你需要知道的。如果你想更进一步,学习如何创建自己的自定义标签,继续阅读。
可以使用autoconfigure标签
如果你使可以使用autoconfigure,然后有些标签自动申请你。这是真实的twig.extension标签:容器看到您的类扩展AbstractExtension(或更准确地说,它实现了ExtensionInterface)并添加标签。
如果你想标记自动申请自己的服务,使用_instanceof选择:
1 2 3 4 5 6 7 8
#配置/ services.yaml服务:#这配置只适用于由该文件的服务_instanceof:#服务的类的实例CustomInterface将被自动标记App \安全\ CustomInterface:标签:(“app.custom_tag”)#……也可以使用# (AutoconfigureTag)属性直接基类或接口:
1 2 3 4 5 6 7 8 9 10
/ / src /安全/ CustomInterface.php名称空间应用程序\安全;使用ob娱乐下载\组件\DependencyInjection\属性\AutoconfigureTag;# (AutoconfigureTag (app.custom_tag)]接口CustomInterface{/ /……}提示
如果你需要更多的功能可以使用autoconfigure实例基类像他们懒惰、绑定和调用为例,你可以依靠可以使用Autoconfigure属性。
对于更高级的需求,您可以定义自动标签使用registerForAutoconfiguration ()方法。
在Symfob娱乐下载ony应用程序中,您的内核类中调用这个方法:
1 2 3 4 5 6 7 8 9 10 11 12
/ / src / Kernel.php类内核扩展BaseKernel{/ /……受保护的函数构建(ContainerBuilder美元containerBuilder):无效{美元containerBuilder- >registerForAutoconfiguration (CustomInterface::类)- >addTag (“app.custom_tag”);}}在Symfob娱乐下载ony包,调用这个方法load ()的方法束扩展类:
1 2 3 4 5 6 7 8 9 10 11 12
/ / src / DependencyInjection / MyBundleExtension.php类MyBundleExtension扩展扩展{/ /……公共函数负载(数组美元配置,ContainerBuilder美元containerBuilder):无效{美元containerBuilder- >registerForAutoconfiguration (CustomInterface::类)- >addTag (“app.custom_tag”);}}自动配置注册并不局限于接口。可以使用PHP 8属性使用autoconfigure服务registerAttributeForAutoconfiguration ()方法:
1 2 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 29 30 31 32 33 34 35 36 37
/ / src /属性/ SensitiveElement.php名称空间应用程序\属性;# \[属性(\属性::TARGET_CLASS)]类SensitiveElement{私人字符串美元令牌;公共函数__construct(字符串美元令牌){美元这- >令牌=美元令牌;}公共函数getToken():字符串{返回美元这- >令牌;}}/ / src / Kernel.php使用应用程序\属性\SensitiveElement;类内核扩展BaseKernel{/ /……受保护的函数构建(ContainerBuilder美元containerBuilder):无效{/ /……美元containerBuilder- >registerAttributeForAutoconfiguration (SensitiveElement::类,静态函数(ChildDefinition美元定义,SensitiveElement美元属性,\ ReflectionClass美元反射器):无效{/ /应用“app.sensitive_element”标签与SensitiveElement所有类/ /属性,把令牌值标签美元定义- >addTag (“app.sensitive_element”,(“令牌”= >美元属性- >getToken ()));});}}创建自定义标签
标记自己实际上并不以任何方式改变您的服务的功能。但是如果你选择,你可以问一个容器建造者的所有服务的列表和一些特定的标签标记。这是有用的在编译器,您可以找到这些服务和在一些特定的方式使用或修改它们。
例如,如果您正在使用Symfony梅勒组件您可能想要实现一个“传递链ob娱乐下载”,这是一个集合类实现\ MailerTransport。用链式,你要梅勒尝试多种方式运输到一个成功的消息。
首先,定义TransportChain类:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src /邮件/ TransportChain.php名称空间应用程序\邮件;类TransportChain{私人美元传输;公共函数__construct(){美元这- >传输= [];}公共函数addTransport(\ MailerTransport美元运输):无效{美元这- >传输[]=美元运输;}}然后,定义链作为一个服务:
1 2 3
#配置/ services.yaml服务:邮件\ App \ TransportChain:~定义服务的定制标记
现在你可能会想要一些的\ MailerTransport类实例化并使用自动添加到链addTransport ()方法。例如,您可以添加以下运输服务:
1 2 3 4 5 6 7 8
#配置/ services.yaml服务:MailerSmtpTransport:参数:[' % mailer_host % ')标签:(“app.mail_transport”)MailerSendmailTransport:标签:(“app.mail_transport”)注意,每个服务被标签命名app.mail_transport。这是自定义标签,您将使用在你的编译器通过。编译器通过使这个标记“的意思是”什么。
创建一个编译器通过
您现在可以使用编译器通过向容器的任何服务app.mail_transport标签:
1 2 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
/ / src / DependencyInjection /编译器/ MailTransportPass.php名称空间应用程序\DependencyInjection\编译器;使用应用程序\邮件\TransportChain;使用ob娱乐下载\组件\DependencyInjection\编译器\CompilerPassInterface;使用ob娱乐下载\组件\DependencyInjection\ContainerBuilder;使用ob娱乐下载\组件\DependencyInjection\参考;类MailTransportPass实现了CompilerPassInterface{公共函数过程(ContainerBuilder美元containerBuilder):无效{/ /总首先检查如果主服务定义如果(!美元containerBuilder- >(TransportChain::类)){返回;}美元定义=美元containerBuilder- >findDefinition (TransportChain::类);/ /查找所有服务id app.mail_transport标签美元taggedServices=美元containerBuilder- >findTaggedServiceIds (“app.mail_transport”);foreach(美元taggedServices作为美元id= >美元标签){/ /添加TransportChain服务的运输服务美元定义- >addMethodCall (“addTransport”,(新引用(美元id)));}}}注册通过的容器
为了运行编译器编译通过当容器,你必须编译器通过添加到容器中包的扩展或从你的内核:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/ / src / Kernel.php名称空间应用程序;使用应用程序\DependencyInjection\编译器\MailTransportPass;使用ob娱乐下载\组件\HttpKernel\内核作为BaseKernel;/ /……类内核扩展BaseKernel{/ /……受保护的函数构建(ContainerBuilder美元containerBuilder):无效{美元containerBuilder- >addCompilerPass (新MailTransportPass ());}}提示
当实现CompilerPassInterface在服务的扩展,您不需要注册。看到组件的文档欧宝官网下载app为更多的信息。
添加额外的属性标签
有时你需要额外信息的每个服务标记你的标签。例如,您可能想添加别名来传递链的每个成员。
首先,改变TransportChain类:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
类TransportChain{私人美元传输;公共函数__construct(){美元这- >传输= [];}公共函数addTransport(\ MailerTransport美元运输,美元别名):无效{美元这- >传输(美元别名]=美元运输;}公共函数getTransport(美元别名):? \MailerTransport{返回美元这- >传输(美元别名)? ?零;}}正如您可以看到的,什么时候addTransport ()被调用时,不仅需要一个吗MailerTransport对象,也是一个字符串别名运输。所以,你怎么能让每个标记运输服务也提供一个别名吗?
要回答这个问题,改变服务宣言:
1 2 3 4 5 6 7 8 9 10
#配置/ services.yaml服务:MailerSmtpTransport:参数:[' % mailer_host % ')标签:- - - - - -{名称:“app.mail_transport”,别名:“smtp”}MailerSendmailTransport:标签:- - - - - -{名称:“app.mail_transport”,别名:“发送邮件”}提示
在YAML格式,您可以提供标签作为一个简单的字符串,只要你不需要指定附加属性。下面的定义是等价的。
1 2 3 4 5 6 7 8 9 10 11 12
#配置/ services.yaml服务:#紧凑语法MailerSendmailTransport:类:\ MailerSendmailTransport标签:(“app.mail_transport”)#详细的语法MailerSendmailTransport:类:\ MailerSendmailTransport标签:- - - - - -{名称:“app.mail_transport”}注意到你已经添加了一个通用的别名标签的关键。使用这个,更新编译器:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
使用ob娱乐下载\组件\DependencyInjection\编译器\CompilerPassInterface;使用ob娱乐下载\组件\DependencyInjection\ContainerBuilder;使用ob娱乐下载\组件\DependencyInjection\参考;类TransportCompilerPass实现了CompilerPassInterface{公共函数过程(ContainerBuilder美元containerBuilder):无效{/ /……foreach(美元taggedServices作为美元id= >美元标签){/ /服务可能有相同的标签的两倍foreach(美元标签作为美元属性){美元定义- >addMethodCall (“addTransport”,(新引用(美元id),美元属性(“别名”)));}}}}双圈可能会让人困惑。这是因为一个服务可以有多个标签。你标记两次或更多的服务app.mail_transport标签。第二个foreach循环遍历app.mail_transport标签设置为当前服务和给你的属性。
参考标记服务
ob娱乐下载Symfony提供了一个快捷方式将所有服务标记与一个特定的标签,这是一种常见的需要在某些应用程序中,所以你不必编写编译器通过。
考虑以下HandlerCollection类,你想注入所有服务标记app.handler它的构造函数参数:
1 2 3 4 5 6 7 8 9
/ / src / HandlerCollection.php名称空间应用程序;类HandlerCollection{公共函数__construct(iterable美元处理程序){}}ob娱乐下载Symfony允许您使用YAML注入服务/ XML / PHP配置或直接通过PHP属性:
1 2 3 4 5 6 7 8 9 10 11 12 13
/ / src / HandlerCollection.php名称空间应用程序;使用ob娱乐下载\组件\DependencyInjection\属性\TaggedIterator;类HandlerCollection{公共函数__construct(/ /属性必须直接用于自动装配的参数#【TaggedIterator(“app.handler”)]iterable美元处理程序){}}如果由于某种原因你需要排除一个或多个服务使用一个迭代器标记时,添加的排除选择:
1 2 3 4 5 6 7 8 9 10 11 12
/ / src / HandlerCollection.php名称空间应用程序;使用ob娱乐下载\组件\DependencyInjection\属性\TaggedIterator;类HandlerCollection{公共函数__construct(# (TaggedIterator(“app.handler”排除:[“App \处理器\三”])]iterable美元处理程序){}}6.1
的排除选项是在Symfony 6.1中引入的。ob娱乐下载
另请参阅
另请参阅标记定位服务
标记服务与优先级
标记服务可以优先使用优先级属性。默认的优先级是一个积极或消极的整数0。数越高,越早标记服务将位于集合:
1 2 3 4 5
#配置/ services.yaml服务:应用\ \处理程序:标签:- - - - - -{名称:“app.handler”,优先级:20.}另一个选择,这是特别有用,当使用autoconfigure标签,是实现静态getDefaultPriority ()服务本身上的方法:
1 2 3 4 5 6 7 8 9 10
/ / src /处理/ One.php名称空间应用程序\处理程序;类一个{公共静态函数getDefaultPriority():int{返回3;}}如果你想要另一个方法定义优先级(如。getPriority ()而不是getDefaultPriority ()),您可以定义它的配置收集服务:
1 2 3 4 5 6 7 8 9 10 11 12 13
/ / src / HandlerCollection.php名称空间应用程序;使用ob娱乐下载\组件\DependencyInjection\属性\TaggedIterator;类HandlerCollection{公共函数__construct(# (TaggedIterator(“app.handler”defaultPriorityMethod:“getPriority”)]iterable美元处理程序){}}标记服务指数
如果你想在注入集合中检索一个特定的服务可以使用index_by和default_index_method选项的参数结合tagged_iterator !。
使用前面的例子,这个服务配置创建一个索引的集合关键属性:
1 2 3 4 5 6 7 8 9 10 11 12 13
/ / src / HandlerCollection.php名称空间应用程序;使用ob娱乐下载\组件\DependencyInjection\属性\TaggedIterator;类HandlerCollection{公共函数__construct(# (TaggedIterator(“app.handler”indexAttribute:“关键”)]iterable美元处理程序){}}编译后HandlerCollection可以遍历应用程序处理程序。从迭代器来检索一个特定的服务,调用iterator_to_array ()函数,然后使用关键属性的数组元素。例如,检索handler_two处理程序:
1 2 3 4 5 6 7 8 9 10 11 12
/ / src /处理/ HandlerCollection.php名称空间应用程序\处理程序;类HandlerCollection{公共函数__construct(iterable美元处理程序){美元处理程序=美元处理程序运算符\可反驳的?iterator_to_array (美元处理程序):美元处理程序;美元handlerTwo=美元处理程序(“handler_two”];}}提示
优先级一样,你也可以实现一个静态的getDefaultIndexName ()方法处理程序和省略索引属性(关键):
1 2 3 4 5 6 7 8 9 10 11
/ / src /处理/ One.php名称空间应用程序\处理程序;类一个{/ /……公共静态函数getDefaultIndexName():字符串{返回“handler_one”;}}您还可以定义静态方法的名称来实现在每个服务default_index_method属性标记的论点:
1 2 3 4 5 6 7 8 9 10 11 12 13
/ / src / HandlerCollection.php名称空间应用程序;使用ob娱乐下载\组件\DependencyInjection\属性\TaggedIterator;类HandlerCollection{公共函数__construct(# (TaggedIterator(“app.handler”defaultIndexMethod:“getIndex”)]iterable美元处理程序){}}的# (AsTaggedItem)属性
可以定义的优先级和索引项由于标记# (AsTaggedItem)属性。这个属性必须直接使用类的服务要配置:
1 2 3 4 5 6 7 8 9 10
/ / src /处理/ One.php名称空间应用程序\处理程序;使用ob娱乐下载\组件\DependencyInjection\属性\AsTaggedItem;#【AsTaggedItem(指数:“handler_one”,优先级:10))类一个{/ /……}
