Symfony 如何将服务标签配置转数组

在symfony中将服务标签配置转为数组的标准方式是使用编译器pass,在容器编译阶段收集带有指定标签的服务并注入目标服务;2. 通过定义标签(如app.formatter)、创建实现compilerpassinterface的类(如formatterpass),在process方法中调用findtaggedserviceids获取标记服务,利用reference对象构建引用数组,并按标签属性(如priority)排序后通过setargument注入;3. 编译器pass需在bundle扩展类或kernel的build方法中通过addcompilerpass注册;4. 服务标签解决了硬编码和紧耦合问题,实现松散耦合、零配置扩展和插件化架构;5. 标签属性处理通过遍历findtaggedserviceids返回的二维数组,提取每个标签实例的属性(如priority),并用于排序或条件判断;6. 排序常用krsort对优先级分组后扁平化为有序数组;7. 现代替代方案是使用taggediteratorargument,可在构造函数中直接注入iterable $formatters,配合services.yaml中!tagged_iterator app.formatter实现零代码聚合,适用于无需编译时处理的场景;8. taggediteratorargument不支持基于标签属性的自动排序,复杂排序仍需编译器pass。最终,symfony通过标签机制实现了服务的声明式聚合,兼顾灵活性与扩展性,完整解决了服务发现与集合注入问题。

Symfony 如何将服务标签配置转数组

Symfony中将服务标签配置“转”为数组,通常不是一个直接的数据类型转换操作,而更像是一种收集和聚合的过程。核心机制在于通过Dependency Injection组件的编译器Pass(Compiler Pass),在容器编译阶段识别并收集所有带有特定标签的服务,然后将这些服务的引用或定义组织成一个可用的集合(通常在代码中表现为数组或迭代器),供其他服务使用或进一步处理。

解决方案

要将Symfony的服务标签配置收集成一个数组,最标准且灵活的方式是利用编译器Pass(Compiler Pass)。这允许你在容器编译阶段对服务定义进行修改和聚合。

定义你的服务和标签:

config/services.yaml

中,为你的服务添加自定义标签。例如,我们有一个

app.formatter

标签:

# config/services.yamlservices:    _defaults:        autowire: true        autoconfigure: true    App:        resource: '../src/'        exclude:            - '../src/DependencyInjection/'            - '../src/Entity/'            - '../src/Kernel.php'    AppFormatterHtmlFormatter:        tags: ['app.formatter', { priority: 10 }]    AppFormatterMarkdownFormatter:        tags: ['app.formatter', { priority: 20 }]    AppServiceFormatterManager:        # 这个服务将接收所有标记为 'app.formatter' 的服务        arguments:            $formatters: [] # 初始占位符,将在Compiler Pass中填充

创建自定义编译器Pass:创建一个类,实现

SymfonyComponentDependencyInjectionCompilerCompilerPassInterface

接口。这个Pass将在容器构建过程中被执行。

// src/DependencyInjection/Compiler/FormatterPass.phpnamespace AppDependencyInjectionCompiler;use SymfonyComponentDependencyInjectionCompilerCompilerPassInterface;use SymfonyComponentDependencyInjectionContainerBuilder;use SymfonyComponentDependencyencyInjectionReference;class FormatterPass implements CompilerPassInterface{    public function process(ContainerBuilder $container): void    {        // 检查 FormatterManager 服务是否存在        if (!$container->has('AppServiceFormatterManager')) {            return;        }        $definition = $container->findDefinition('AppServiceFormatterManager');        $taggedServices = $container->findTaggedServiceIds('app.formatter');        $formatters = [];        foreach ($taggedServices as $id => $tags) {            // $tags 是一个数组,包含这个服务的所有 'app.formatter' 标签实例            // 每个标签实例也是一个数组,包含其属性(如 priority)            foreach ($tags as $attributes) {                $priority = $attributes['priority'] ?? 0;                $formatters[$priority][] = new Reference($id); // 使用Reference避免循环依赖            }        }        // 按优先级排序(高优先级在前)        krsort($formatters);        $sortedFormatters = [];        foreach ($formatters as $priorityGroup) {            foreach ($priorityGroup as $formatterReference) {                $sortedFormatters[] = $formatterReference;            }        }        // 将收集到的服务引用数组注入到 FormatterManager 服务的构造函数中        // 假设 FormatterManager 的构造函数第一个参数是 $formatters        $definition->setArgument('$formatters', $sortedFormatters);    }}

注册编译器Pass:在你的Bundle扩展类(通常是

src/DependencyInjection/AppExtension.php

)中注册这个Pass。

// src/DependencyInjection/AppExtension.phpnamespace AppDependencyInjection;use AppDependencyInjectionCompilerFormatterPass;use SymfonyComponentDependencyInjectionContainerBuilder;use SymfonyComponentDependencyInjectionExtensionExtension;class AppExtension extends Extension{    public function load(array $configs, ContainerBuilder $container): void    {        // 你可以加载服务配置文件        // $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config'));        // $loader->load('services.yaml');    }    public function prepend(ContainerBuilder $container): void    {        // 这个方法在所有Bundle的load()方法之前执行,适合添加Compiler Pass        $container->addCompilerPass(new FormatterPass());    }}

或者,如果你的应用没有自定义Bundle,可以直接在

src/Kernel.php

build

方法中注册:

// src/Kernel.phpnamespace App;use AppDependencyInjectionCompilerFormatterPass; // 引入你的Compiler Passuse SymfonyBundleFrameworkBundleKernelMicroKernelTrait;use SymfonyComponentHttpKernelKernel as BaseKernel;use SymfonyComponentDependencyInjectionContainerBuilder; // 引入ContainerBuilderclass Kernel extends BaseKernel{    use MicroKernelTrait;    // ... 其他方法    protected function build(ContainerBuilder $container): void    {        $container->addCompilerPass(new FormatterPass());    }}

这样,

FormatterManager

服务在被实例化时,其构造函数就会接收到一个包含所有标记为

app.formatter

服务的

Reference

数组,并且这些服务是按照优先级排序的。

为什么在Symfony中使用服务标签?它们解决了什么实际问题?

我个人觉得,服务标签是Symfony DI容器设计中最优雅也最强大的特性之一。它解决的核心问题是解耦和可扩展性

想象一下,如果你要构建一个插件系统,或者一个需要收集多种实现(比如不同的数据导出器、支付网关、日志处理器)的组件。没有标签的话,你可能需要:

硬编码: 在一个中央服务里,手动列出所有相关的服务ID,这显然不灵活,每增加一个新实现都要修改核心代码。服务查找器: 注入整个服务容器,然后通过遍历或者某种命名约定来查找,这既不推荐(因为打破了依赖注入的原则),效率也低。

服务标签就像给你的服务贴上了一个“分类标签”。它允许:

松散耦合: 一个服务(比如我们的

FormatterManager

)不需要知道它具体管理哪些格式化器,它只知道去“找所有贴有

app.formatter

标签的服务”。零配置扩展: 当你新增一个

PdfFormatter

时,你只需要给它加上

app.formatter

标签,容器编译时它就会自动被

FormatterManager

发现并纳入管理,而无需修改

FormatterManager

本身的代码。模块化和插件化: 在大型应用或公共Bundle中,其他开发者可以通过简单地定义带有你指定标签的服务,来“注册”他们自己的实现,从而扩展你的系统功能。这在构建可插拔的架构时简直是神来之笔。

本质上,服务标签提供了一种声明式的方式来组织和发现相关的服务集合,极大地提升了应用程序的灵活性、可维护性和可扩展性。

除了基本的收集,如何处理服务标签的属性和排序?

在实际应用中,仅仅收集服务往往是不够的。我们经常需要对这些收集到的服务进行更精细的控制,比如按某种顺序排列它们,或者根据标签上的额外信息来决定如何使用它们。这正是服务标签属性的用武之地。

当你通过

$container->findTaggedServiceIds('your_tag')

获取标记服务时,返回的结构是这样的:

[    'service_id_1' => [        ['attribute_name_1' => 'value_1', 'attribute_name_2' => 'value_2'], // 第一个标签实例        ['attribute_name_3' => 'value_3'] // 第二个标签实例 (如果同一个服务有多个同名标签)    ],    'service_id_2' => [        ['attribute_name_1' => 'value_4']    ],    // ...]

可以看到,每个服务ID对应一个数组,这个数组里包含了该服务所有特定标签的实例。每个实例又是一个关联数组,存储了你定义在

services.yaml

中的属性。

处理属性:在我们的

FormatterPass

示例中,我们使用了

priority

属性。在

foreach ($taggedServices as $id => $tags)

循环内部,我们又加了一个

foreach ($tags as $attributes)

。这个内层循环就是用来遍历每个标签实例及其属性的。通过

$attributes['priority'] ?? 0

,我们安全地获取了优先级,即使标签没有定义

priority

属性,也能给一个默认值。

实现排序:拿到优先级后,关键在于如何利用它来排序。一个常见的做法是创建一个临时数组,以优先级作为键,将服务引用放入对应优先级的数组中。

$formatters = [];foreach ($taggedServices as $id => $tags) {    foreach ($tags as $attributes) {        $priority = $attributes['priority'] ?? 0;        // 注意:这里我们使用 $priority 作为键,值是一个数组,        // 以防有多个服务具有相同的优先级。        $formatters[$priority][] = new Reference($id);    }}// 使用 krsort() 对键(优先级)进行降序排序,这样高优先级的组就在前面。krsort($formatters);$sortedFormatters = [];foreach ($formatters as $priorityGroup) {    // 遍历每个优先级组,将服务引用按顺序添加到最终数组中。    foreach ($priorityGroup as $formatterReference) {        $sortedFormatters[] = $formatterReference;    }}

这种双层循环和

krsort

的组合,是我在处理需要排序的标记服务时最常用的模式。它既能处理单个服务有多个标签的情况,也能优雅地处理相同优先级下的多个服务。通过这种方式,你可以非常灵活地控制收集到的服务集合的顺序和行为。

除了编译器Pass,还有哪些现代方法可以便捷地获取标记服务?

虽然编译器Pass是处理标记服务最强大和灵活的方式,因为它允许你在容器编译阶段进行复杂的逻辑处理和容器修改,但在很多简单场景下,你可能只是想把所有标记服务作为数组或迭代器直接注入到另一个服务中,而不需要在编译时进行复杂的处理。对于这种情况,Symfony提供了更现代、更简洁的解决方案:

TaggedIteratorArgument

TaggedIteratorArgument:直接注入标记服务集合

从Symfony 4.3开始,

TaggedIteratorArgument

提供了一种非常方便的方式,可以直接将所有带有特定标签的服务作为

iterable

可迭代对象)或

array

注入到服务的构造函数或方法中,而无需编写自定义的编译器Pass。这极大地简化了代码,并且是推荐的现代用法,尤其当你不需要在编译时对这些服务进行额外处理时。

使用示例:

定义服务和标签: 和前面一样,定义你的服务并加上标签。

# config/services.yamlservices:    AppFormatterHtmlFormatter:        tags: ['app.formatter']    AppFormatterMarkdownFormatter:        tags: ['app.formatter']    # 注意:这里不需要手动指定 $formatters 参数了    AppServiceFormatterManager:        # autowire 会自动识别 TaggedIteratorArgument

修改接收服务的类:

FormatterManager

的构造函数中,使用

iterable

类型提示,并结合

TaggedIteratorArgument

// src/Service/FormatterManager.phpnamespace AppService;use AppFormatterFormatterInterface; // 假设你的格式化器都实现了这个接口use SymfonyComponentDependencyInjectionArgumentTaggedIteratorArgument;class FormatterManager{    private iterable $formatters;    // 使用 TaggedIteratorArgument 作为类型提示,或者在 services.yaml 中配置    public function __construct(        // 如果你希望在构造函数中直接使用 TaggedIteratorArgument,        // 确保你已经安装了 symfony/dependency-injection 组件。        // Symfony 6+ 默认支持这种写法。        // For Symfony 4.3+ & 5, you might need to configure it in services.yaml        iterable $formatters // 这是最简洁的写法,只要autowire开启,Symfony能自动识别    ) {        // 在 services.yaml 中配置 $formatters 参数        // $formatters: !tagged_iterator app.formatter        $this->formatters = $formatters;        // 如果你需要排序,你可以在这里对 $this->formatters 进行排序        // 但 TaggedIteratorArgument 本身不直接支持标签属性的排序,需要手动实现        // 或者使用 Compiler Pass 来实现更复杂的排序逻辑    }    public function format(string $type, string $data): string    {        foreach ($this->formatters as $formatter) {            if ($formatter->supports($type)) {                return $formatter->format($data);            }        }        throw new InvalidArgumentException(sprintf('No formatter found for type "%s".', $type));    }}

重要提示:

类型提示:

iterable

是关键,因为

TaggedIteratorArgument

会返回一个迭代器,而不是一个立即加载的数组。这有助于延迟加载,提高性能。如果你确实需要一个数组,可以在构造函数内部

iterator_to_array($formatters)

转换。优先级/属性:

TaggedIteratorArgument

本身不直接处理标签属性(如

priority

)来排序。它只会按照服务定义的顺序或者容器的内部顺序来提供服务。如果你需要基于标签属性进行复杂的排序或过滤,编译器Pass仍然是更合适的选择。但在许多情况下,你可能不需要严格的顺序,或者可以在使用时自行排序。

TaggedIteratorArgument

极大地降低了获取标记服务的门槛,让很多原本需要编写编译器Pass的场景变得异常简单。它是我现在处理简单服务集合注入时的首选。如果你只是想“收集”服务,而不是“修改”容器的构建过程,那么它无疑是更现代、更优雅的方案。

以上就是Symfony 如何将服务标签配置转数组的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1290933.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月11日 07:03:09
下一篇 2025年12月11日 07:03:18

相关推荐

  • CSS mask属性无法获取图片:为什么我的图片不见了?

    CSS mask属性无法获取图片 在使用CSS mask属性时,可能会遇到无法获取指定照片的情况。这个问题通常表现为: 网络面板中没有请求图片:尽管CSS代码中指定了图片地址,但网络面板中却找不到图片的请求记录。 问题原因: 此问题的可能原因是浏览器的兼容性问题。某些较旧版本的浏览器可能不支持CSS…

    2025年12月24日
    900
  • 如何利用BFC和inline-block解决兄弟元素间margin塌陷问题?

    BFC清除兄弟元素间margin塌陷原理 margin塌陷问题 当相邻的块级元素垂直排列,它们的margin可能会塌陷并重叠,称为margin塌陷。 BFC清除margin塌陷 清除margin塌陷的一种常见方法是将下方元素包裹在一个新的块级格式化上下文(BFC)中,因为BFC之间不会相互影响。 d…

    2025年12月24日
    500
  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • 如何优化CSS Grid布局中子元素排列和宽度问题?

    css grid布局中的优化问题 在使用css grid布局时可能会遇到以下问题: 问题1:无法控制box1中li的布局 box1设置了grid-template-columns: repeat(auto-fill, 20%),这意味着容器将自动填充尽可能多的20%宽度的列。当li数量大于5时,它们…

    2025年12月24日
    800
  • SASS 中的 Mixins

    mixin 是 css 预处理器提供的工具,虽然它们不是可以被理解的函数,但它们的主要用途是重用代码。 不止一次,我们需要创建多个类来执行相同的操作,但更改单个值,例如字体大小的多个类。 .fs-10 { font-size: 10px;}.fs-20 { font-size: 20px;}.fs-…

    2025年12月24日
    000
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 为什么设置 `overflow: hidden` 会导致 `inline-block` 元素错位?

    overflow 导致 inline-block 元素错位解析 当多个 inline-block 元素并列排列时,可能会出现错位显示的问题。这通常是由于其中一个元素设置了 overflow 属性引起的。 问题现象 在不设置 overflow 属性时,元素按预期显示在同一水平线上: 不设置 overf…

    2025年12月24日 好文分享
    400
  • 网页使用本地字体:为什么 CSS 代码中明明指定了“荆南麦圆体”,页面却仍然显示“微软雅黑”?

    网页中使用本地字体 本文将解答如何将本地安装字体应用到网页中,避免使用 src 属性直接引入字体文件。 问题: 想要在网页上使用已安装的“荆南麦圆体”字体,但 css 代码中将其置于第一位的“font-family”属性,页面仍显示“微软雅黑”字体。 立即学习“前端免费学习笔记(深入)”; 答案: …

    2025年12月24日
    000
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 面板翻页显示16张图片和信息,如何实现模块靠左显示并按行排列?

    如何在面板上翻页显示16个图片和信息,如何设置div内的模块靠左显示,模块内容按行显示? 问题:在面板上翻页显示16个图片和信息,如何设置div内的模块靠左显示,模块内容按行显示,设置了float没有效果。 已知信息: 图片和信息使用json数据定义。使用paginationbyjs函数进行分页。使…

    2025年12月24日
    000
  • 如何在面板上翻页显示16个图片和信息,并实现模块靠左显示、内容按行排列?

    如何设置div内的模块靠左显示,模块内容按行显示? 问题: 在面板上翻页显示16个图片和信息,如何设置div内的模块靠左显示,模块内容按行显示,设置了float没有效果。 答案: 要将div内的模块靠左显示,并按行排列模块内容,可以使用以下方式: 给div容器添加flexbox属性: #list {…

    2025年12月24日
    000
  • 如何实现 div 内模块靠左显示并按行排列, 且翻页显示图片和信息?

    如何设置div内的模块靠左显示,模块内容按行显示? 在面板上翻页显示16个图片和信息,如何设置div内的模块靠左显示,模块内容按行显示,设置了float没有效果 中间部分里面的图片,文字显示在图片下方 第二页图片靠左显示 以上就是如何实现 div 内模块靠左显示并按行排列, 且翻页显示图片和信息?的…

    2025年12月24日
    000
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么我的特定 DIV 在 Edge 浏览器中无法显示?

    特定 DIV 无法显示:用户代理样式表的困扰 当你在 Edge 浏览器中打开项目中的某个 div 时,却发现它无法正常显示,仔细检查样式后,发现是由用户代理样式表中的 display none 引起的。但你疑问的是,为什么会出现这样的样式表,而且只针对特定的 div? 背后的原因 用户代理样式表是由…

    2025年12月24日
    200
  • inline-block元素错位了,是为什么?

    inline-block元素错位背后的原因 inline-block元素是一种特殊类型的块级元素,它可以与其他元素行内排列。但是,在某些情况下,inline-block元素可能会出现错位显示的问题。 错位的原因 当inline-block元素设置了overflow:hidden属性时,它会影响元素的…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200

发表回复

登录后才能评论
关注微信