Symfony:如何批量为指定目录类配置services.yaml的public属性及按类名获取服务
针对指定目录批量设置服务public属性的正确实现
通配符写法不生效的原因
你之前单独写App\Service\*作为服务ID的写法是错误的:Symfony的服务定义解析器不会自动识别这种裸通配符的作用域,无法匹配到实际目录下的类,自然会报服务不存在的错误。
Symfony从3.3版本开始提供了配套的目录资源扫描机制,专门用来批量给指定目录下的类统一配置服务属性,不需要逐个手动声明服务。
正确的批量配置写法
直接在services.yaml中通过资源扫描的方式,给指定目录下的所有类统一设置public属性即可,示例配置:
services: _defaults: public: false # *这个配置确实能优化生产环境性能*:编译容器时,非public服务不会生成对外访问入口,会大幅减小编译后容器的内存占用,是官方推荐的默认配置 # 自动扫描App\Service目录下的所有类注册为服务 App\Service\: resource: '../src/Service/' # 配置为相对于当前services.yaml文件的目录路径 public: true # 对扫描到的所有服务统一设置public属性 # 可按需配置排除规则,不需要设为public的类单独排除 exclude: - '../src/Service/Internal/HelperService.php'
这种写法会自动把扫描到的每个类以其完整命名空间作为服务ID注册,同时继承统一的public配置,完全不需要为每个服务单独写声明,服务数量增加时也几乎没有额外维护成本。
更优的动态按类名获取服务的方案
你目前为了动态获取服务,把整个Service目录设为public的方式存在明显短板:会把所有内部实现的服务都对外暴露,破坏Symfony的私有服务封装,同时带来不必要的容器内存开销。更优的方案完全不需要依赖大范围的public配置:
方案1:使用专属服务定位器(Service Locator)
这是Symfony官方专门为动态查找服务设计的原生机制,核心优势是:
- 不需要把对应的服务设为public
- 不需要注入全量的容器实例
- 仅把允许动态访问的服务注入到独立的定位器中,访问范围可控、性能开销极小
配置示例
services: App\Controller\MyController: arguments: # 给控制器注入专属的服务定位器,只包含允许动态访问的Service类 $serviceLocator: !service_locator # 可以手动指定单个服务 App\Service\Service1: '@App\Service\Service1' # 也可以配合资源扫描,自动批量把Service目录下的服务注入定位器,全程不需要设置服务为public App\Service\: resource: '../src/Service/'
控制器代码调整
不需要再注入全局的ContainerInterface,直接注入这个专属定位器即可:
// 类属性定义 private ServiceLocatorInterface $serviceLocator; // 构造函数注入 public function __construct(ServiceLocatorInterface $serviceLocator) { $this->serviceLocator = $serviceLocator; } // 动态获取服务 public function myAction (string $className) { return $this->serviceLocator->get($className); }
方案2:使用标签迭代器动态收集服务
如果你的动态获取场景不需要实时按需取服务,可以给所有需要动态访问的类加上统一的自定义标签,通过标签迭代器把所有匹配的服务收集为数组,再做类名匹配查找。这种方式同样不需要把服务设为public,适合需要提前批量加载同类服务的场景。
补充:如果使用较新的Symfony版本(5.4+、6.x、7.x),可以配合类上的
#[AsService]属性快速给单个服务设置public属性,不需要在yaml中单独声明,但批量配置的场景下,还是资源扫描的方式维护成本最低。
内容的提问来源于stack exchange,提问作者Alex Lysenko

