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)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
Symfony 怎么将Doctrine结果集转数组
上一篇 2025年12月11日 07:03:09
Symfony 怎样把SMTP配置转为数组
下一篇 2025年12月11日 07:03:18

相关推荐

  • Matplotlib 地图中多类型图例的创建与优化

    Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化

    本教程旨在解决matplotlib地图可视化中,如何在一个图例中同时展示颜色块(如区域分类)和自定义标记(如特定兴趣点)的问题。文章详细介绍了当传统`patch`对象无法正确显示标记时,如何利用`matplotlib.lines.line2d`创建标记图例句柄,并将其与颜色块图例句柄合并,从而生成一…

    2026年5月10日 用户投稿
    100
  • Golang JSON序列化:控制敏感字段暴露的最佳实践

    本教程探讨golang中如何高效控制结构体字段在json序列化时的可见性。当需要将包含敏感信息的结构体数组转换为json响应时,通过利用`encoding/json`包提供的结构体标签,特别是`json:”-“`,可以轻松实现对特定字段的忽略,从而避免敏感数据泄露,确保api…

    2026年5月10日
    000
  • 比特币新手教程 比特币交易平台有哪些

    比特币是一种去中心化的数字货币,基于区块链技术实现点对点交易,具有匿名性、有限发行和不可篡改等特点;新手可通过交易所购买,P2P交易获得比特币,常用平台包括Binance、OKX和Huobi;交易流程包括注册账户、实名认证、绑定支付方式、充值法币并下单购买,可选择市价单或限价单;比特币存储方式有交易…

    2026年5月10日
    000
  • c++中的SFINAE技术是什么_c++模板编程中的SFINAE原理与应用

    SFINAE 是“替换失败不是错误”的原则,指模板实例化时若参数替换导致错误,只要存在其他合法候选,编译器不报错而是继续重载决议。它用于条件启用模板、类型检测等场景,如通过 decltype 或 enable_if 控制函数重载,实现类型特征判断。尽管 C++20 引入 Concepts 简化了部分…

    2026年5月10日
    000
  • 如何让动态追加元素的类事件生效?

    如何在追加元素后使其绑定类事件生效 在页面中引入三方 JavaScript 类并通过添加相应 class 来调用事件方法是一种常见的做法。然而,如果通过 JavaScript 追加标签元素,即使添加了对应的 class,事件也可能无法生效。 为了解决这个问题,可以尝试以下步骤: 检查追加的标签是否为…

    2026年5月10日
    000
  • Go语言mgo查询构建:深入理解bson.M与日期范围查询的正确实践

    本文旨在解决go语言mgo库中构建复杂查询时,特别是涉及嵌套`bson.m`和日期范围筛选的常见错误。我们将深入剖析`bson.m`的类型特性,解释为何直接索引`interface{}`会导致“invalid operation”错误,并提供一种推荐的、结构清晰的代码重构方案,以确保查询条件能够正确…

    2026年5月10日
    100
  • RichHandler与Rich Progress集成:解决显示冲突的教程

    在使用rich库的`richhandler`进行日志输出并同时使用`progress`组件时,可能会遇到显示错乱或溢出问题。这通常是由于为`richhandler`和`progress`分别创建了独立的`console`实例导致的。解决方案是确保日志处理器和进度条组件共享同一个`console`实例…

    2026年5月10日
    000
  • 理解编程指令:当结果正确,但实现方式不符要求时

    本文探讨了在编程实践中,即使程序输出了正确的结果,但若其实现方式未能严格遵循既定指令,仍可能被视为“不正确”的问题。我们将通过具体示例,对比直接求和与累加求和两种实现策略,强调理解和遵守编程规范的重要性,以确保代码的健壮性、可维护性及符合项目要求。 在软件开发过程中,我们经常会遇到这样的情况:编写的…

    2026年5月10日
    000
  • Golang goroutine与channel调试技巧

    使用go run -race检测数据竞争,结合runtime.NumGoroutine监控协程数量,通过pprof分析阻塞调用栈,利用select超时避免永久阻塞,有效排查goroutine泄漏、死锁和数据竞争问题。 Go语言的goroutine和channel是并发编程的核心,但它们也带来了调试上…

    2026年5月10日
    000
  • 使用 Jupyter Notebook 进行探索性数据分析

    Jupyter Notebook通过单元格实现代码与Markdown结合,支持数据导入(pandas)、清洗(fillna)、探索(matplotlib/seaborn可视化)、统计分析(describe/corr)和特征工程,便于记录与分享分析过程。 Jupyter Notebook 是进行探索性…

    2026年5月10日
    000
  • 《魔兽世界》将于6月11日开启国服回归技术测试

    《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试

    《%ign%ignore_a_1%re_a_1%》官方宣布,将于6月11日开启国服回归技术测试,时间为7天,并称可以在6月内正式开服,玩家们可以访问官网下载战网客户端并预下载“巫妖王之怒”客户端,技术测试详情见下图。 WordAi WordAI是一个AI驱动的内容重写平台 53 查看详情 以上就是《…

    2026年5月10日 用户投稿
    200
  • 如何在HTML中插入表单元素_HTML表单控件与输入类型使用指南

    HTML表单通过标签构建,包含action和method属性定义数据提交目标与方式,常用input类型如text、password、email等适配不同输入需求,配合label、required、placeholder提升可用性,结合textarea、select、button等控件实现完整交互,是…

    2026年5月10日
    000
  • 创建指定大小并填充特定数据的Golang文件教程

    本文将介绍如何使用Golang创建一个指定大小的文件,并用特定数据填充它。我们将使用 `os` 包提供的函数来创建和截断文件,从而实现快速生成大文件的目的。示例代码展示了如何创建一个10MB的文件,并将其填充为全零数据。掌握这些方法,可以方便地在例如日志系统或磁盘队列等场景中,预先创建测试文件或初始…

    2026年5月10日
    000
  • Python命令怎样使用profile分析脚本性能 Python命令性能分析的基础教程

    使用Python的cProfile模块分析脚本性能最直接的方式是通过命令行执行python -m cProfile your_script.py,它会输出每个函数的调用次数、总耗时、累积耗时等关键指标,帮助定位性能瓶颈;为进一步分析,可将结果保存为文件python -m cProfile -o ou…

    2026年5月10日
    000
  • 如何插入查询结果数据_SQL插入Select查询结果方法

    如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法

    使用INSERT INTO…SELECT语句可高效插入数据,通过NOT EXISTS、LEFT JOIN、MERGE语句或唯一约束避免重复;表结构不一致时可通过别名、类型转换、默认值或计算字段处理;结合存储过程可提升可维护性,支持参数化与动态SQL。 将查询结果数据插入到另一个表中,可以…

    2026年5月10日 用户投稿
    000
  • 使用 WebCodecs VideoDecoder 实现精确逐帧回退

    本文档旨在解决在使用 WebCodecs VideoDecoder 进行视频解码时,实现精确逐帧回退的问题。通过比较帧的时间戳与目标帧的时间戳,可以避免渲染中间帧,从而提高用户体验。本文将提供详细的解决方案和示例代码,帮助开发者实现精确的视频帧控制。 在使用 WebCodecs VideoDecod…

    2026年5月10日
    000
  • Discord.py 交互按钮超时与持久化解决方案

    本教程旨在解决Discord.py中交互按钮在一段时间后出现“This Interaction Failed”错误的问题。我们将深入探讨视图(View)的超时机制,并提供通过正确设置timeout参数以及利用bot.add_view()方法实现按钮持久化的具体方案,确保您的机器人交互功能稳定可靠,即…

    2026年5月10日
    000
  • Debian Copilot的社区活跃度如何

    debian copilot是codeberg社区维护的ai助手,旨在为debian用户提供服务。尽管搜索结果中没有直接提供关于debian copilot社区支持活跃度的具体数据,但我们可以通过debian社区的整体活跃度和特点来推断其活跃性。 Debian社区的一般情况: Debian拥有详尽的…

    2026年5月10日
    000
  • python中zip函数详解 python多序列压缩zip函数应用场景

    zip函数的应用场景包括:1) 同时遍历多个序列,2) 合并多个列表的数据,3) 数据分析和科学计算中的元素运算,4) 处理csv文件,5) 性能优化。zip函数是一个强大的工具,能够简化代码并提高处理多个序列时的效率。 在Python中,zip函数是一个非常有用的工具,它能够将多个可迭代对象打包成…

    2026年5月10日
    000
  • JavaScript 动态菜单点击高亮效果实现教程

    本教程详细介绍了如何使用 JavaScript 实现动态菜单的点击高亮功能。通过事件委托和状态管理,当用户点击菜单项时,被点击项会高亮显示(绿色),同时其他菜单项恢复默认样式(白色)。这种方法避免了不必要的DOM操作,提高了性能和代码可维护性,确保了无论点击方向如何,功能都能稳定运行。 动态菜单高亮…

    2026年5月10日
    200

发表回复

登录后才能评论
关注微信