编译容器
编辑本页警告:您正在浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 4.4，现已不再维护。
读本页的更新版本用于Sy欧宝娱乐app下载地址mfony 6.2(当前稳定版本)。
编译容器
由于各种原因，可以编译服务容器。这些原因包括检查任何潜在的问题，如循环引用，以及通过解析参数和删除未使用的服务来提高容器的效率。还有，某些特性，比如使用家长服务-要求容器被编译。
它是通过运行以下命令编译的:
1
＄容器->编译();编译方法使用编译器用于编译。DependencyInjection组件附带了几个自动注册用于编译的通道。例如CheckDefinitionValidityPass检查容器中设置的定义的各种潜在问题。在此和其他几次检查容器有效性的传递之后，在缓存它之前使用进一步的编译器传递来优化配置。例如，将删除私有服务和抽象服务，并解析别名。
使用扩展管理配置
以及将配置直接加载到容器中，如依赖注入组件，您可以通过向容器注册扩展来管理它。编译过程的第一步是从容器中注册的任何扩展类加载配置。与直接加载的配置不同，它们只在容器编译时被处理。如果您的应用程序是模块化的，那么扩展允许每个模块注册和管理自己的服务配置。
扩展必须实现ExtensionInterface并且可以用:
1
＄容器->registerExtension (＄扩展）;扩展的主要工作是在load ()方法。在load ()方法中所示的方法可从一个或多个配置文件加载配置以及操作容器定义如何使用服务定义对象．
的load ()方法将传递一个要设置的新容器，然后将其合并到它所注册的容器中。这允许您使用多个扩展独立地管理容器定义。扩展在被添加时不会添加到容器配置中，但在容器被删除时被处理编译()方法。
一个非常简单的扩展可以将配置文件加载到容器中:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
使用欧宝娱乐app下载地址＼组件＼配置＼FileLocator；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼ContainerBuilder；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼扩展＼ExtensionInterface；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼加载程序＼XmlFileLoader；类AcmeDemoExtension实现了ExtensionInterface｛公共函数负载(数组＄配置, ContainerBuilder＄容器）｛＄加载程序＝新XmlFileLoader (＄容器，新FileLocator (__DIR__．“/ . . /资源/配置”));＄加载程序->负载(“xml”）;｝/ /……｝与将文件直接加载到正在构建的整个容器中相比，这样做并没有获得太多的好处。它只允许在模块/包中拆分文件。要使复杂的应用程序可配置，就需要能够从模块/包外部的配置文件影响模块的配置。这可以通过指定配置文件的部分直接加载到容器中作为特定扩展来实现。配置中的这些部分不会直接由容器处理，而是由相关的扩展处理。
扩展名必须指定getAlias ()方法来实现接口:
1 2 3 4 5 6 7 8 9 10 11
/ /……类AcmeDemoExtension实现了ExtensionInterface｛/ /……公共函数getAlias（）｛返回“acme_demo”；}}对于YAML配置文件，将扩展名的别名指定为键将意味着将这些值传递给扩展名load ()方法:
1 2 3 4
#……acme_demo:foo:fooValue栏:barValue如果这个文件被加载到配置中，那么它中的值只在容器编译时被处理，此时扩展被加载:
12 3 4 5 6 7 8 9 10 11 12
使用欧宝娱乐app下载地址＼组件＼配置＼FileLocator；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼ContainerBuilder；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼加载程序＼YamlFileLoader；＄containerBuilder＝新ContainerBuilder ();＄containerBuilder->registerExtension (新AcmeDemoExtension);＄加载程序＝新YamlFileLoader (＄containerBuilder，新FileLocator (__DIR__));＄加载程序->负载(“config.yaml”）;/ /……＄containerBuilder->编译();请注意
当加载使用扩展别名作为键的配置文件时，该扩展必须已经在容器构建器中注册，否则将抛出异常。
的第一个参数中传递配置文件的这些部分的值load ()扩展方法:
1 2 3 4 5
公共函数负载(数组＄配置, ContainerBuilder＄容器）｛＄喷火＝＄配置［0] [“foo”];/ / fooValue＄酒吧＝＄配置［0] [“酒吧”];/ / barValue｝的美元配置参数是一个数组，包含加载到容器中的每个不同配置文件。在上面的例子中，您只加载了一个配置文件，但它仍然在一个数组中。数组看起来像这样:
1 2 3 4 5 6
[[“foo”= >“fooValue”，“酒吧”= >“barValue”，]，]虽然您可以手动管理合并不同的文件，但使用它要好得多Config组件合并并验证配置值。使用配置处理，你可以这样访问配置值:
12 3 4 5 6 7 8 9 10 11 12 13 14
使用欧宝娱乐app下载地址＼组件＼配置＼定义＼处理器；/ /……公共函数负载(数组＄配置, ContainerBuilder＄容器）｛＄配置＝新配置();＄处理器＝新处理器();＄配置＝＄处理器->processConfiguration (＄配置，＄配置）;＄喷火＝＄配置［“foo”];/ / fooValue＄酒吧＝＄配置［“酒吧”];/ / barValue/ /……｝还有另外两个方法必须实现。一个返回XML名称空间，以便将XML配置文件的相关部分传递给扩展。另一个是指定XSD文件的基本路径，以验证XML配置:
1 2 3 4 5 6 7 8 9
公共函数getXsdValidationBasePath（）｛返回__DIR__．“/ . . /资源/ config /”；｝公共函数getNamespace（）｛返回“http://www.example.com/欧宝娱乐app下载地址symfony/schema/”；｝请注意
XSD验证是可选的，返回假从getXsdValidationBasePath ()方法将禁用它。
配置的XML版本看起来像这样:
12 3 4 5 6 7 8 9 10 11 12 13 14
<？?> . xml version="1.0" encoding="UTF-8"<容器xmlns＝“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services”xmlns: xsi＝“http://www.w3.org/2001/XMLSchema-instance”xmlns: acme-demo＝“http://www.example.com/schema/dic/acme_demo”xsi: schemaLocation＝“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services //www.oldmanjams.com/schema/dic/services/services-1.0.xsd http://www.example.com/schema/dic/acme_demo https://www.example.com/schema/dic/acme_demo/acme_demo-1.0.xsd”><acme-demo:配置><acme_demo: foo>fooValueacme_demo: foo><acme_demo:酒吧>barValueacme_demo:酒吧>acme-demo:配置>容器>请注意
在Symfon欧宝娱乐app下载地址y全栈框架中，有一个实现这些方法的基本扩展类，以及一个用于处理配置的快捷方法。看到如何在一个包内加载服务配置欲知详情。
处理后的配置值现在可以作为容器参数添加，就像在容器中列出一样参数部分的配置文件，但具有合并多个文件和验证配置的额外好处:
1 2 3 4 5 6 7 8 9 10
公共函数负载(数组＄配置, ContainerBuilder＄容器）｛＄配置＝新配置();＄处理器＝新处理器();＄配置＝＄处理器->processConfiguration (＄配置，＄配置）;＄容器->setParameter (“acme_demo。FOO”，＄配置［“foo”]);/ /……｝扩展类可以满足更复杂的配置需求。例如，你可以选择加载一个主服务配置文件，但也可以只在设置了某个参数的情况下加载一个辅助配置文件:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16
公共函数负载(数组＄配置, ContainerBuilder＄容器）｛＄配置＝新配置();＄处理器＝新处理器();＄配置＝＄处理器->processConfiguration (＄配置，＄配置）;＄加载程序＝新XmlFileLoader (＄容器，新FileLocator (__DIR__．“/ . . /资源/配置”));＄加载程序->负载(“xml”）;如果（＄配置［“高级”) {＄加载程序->负载(“advanced.xml”）;}}请注意
仅仅在容器中注册一个扩展不足以在编译容器时将其包含在已处理的扩展中。加载配置使用扩展的别名作为键，如上面的例子将确保它被加载。容器构建器也可以被告知装载它loadFromExtension ()方法:
1 2 3 4 5 6 7
使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼ContainerBuilder；＄containerBuilder＝新ContainerBuilder ();＄扩展＝新AcmeDemoExtension ();＄containerBuilder->registerExtension (＄扩展）;＄containerBuilder->loadFromExtension (＄扩展->getAlias ());＄containerBuilder->编译();请注意
如果你需要操作一个扩展加载的配置，那么你不能从另一个扩展做，因为它使用一个新的容器。相反，您应该使用一个编译器通道，在扩展处理完成后使用完整的容器。
预挂传递给扩展的配置
扩展可以在任何Bundle的配置之前添加扩展load ()方法由实现调用PrependExtensionInterface：
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16
使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼扩展＼PrependExtensionInterface；/ /……类AcmeDemoExtension实现了ExtensionInterface，PrependExtensionInterface｛/ /……公共函数预谋(ContainerBuilder＄容器）｛/ /……＄容器->prependExtensionConfig (＄的名字，＄配置）;/ /……}}详情请参见如何简化多个bundle的配置，它是特定于Symfony框架的，但包含关于此特性的更欧宝娱乐app下载地址多细节。
在编译期间执行代码
您还可以在编译期间通过编写自己的编译器通道来执行自定义代码。通过实现CompilerPassInterface在您的扩展中，添加了过程()方法将在编译时调用:
12 3 4 5 6 7 8 9 10 11 12
/ /……使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼编译器＼CompilerPassInterface；类AcmeDemoExtension实现了ExtensionInterface，CompilerPassInterface｛公共函数过程(ContainerBuilder＄容器）｛/ /……在编译期间做一些事情｝/ /……｝作为过程()被称为后所有扩展都已加载，它允许您编辑其他扩展的服务定义以及检索有关服务定义的信息。
容器的参数和定义可以使用中描述的方法进行操作如何使用服务定义对象．
请注意
请注意过程()方法时调用扩展类中的PassConfig: TYPE_BEFORE_OPTIMIZATION的一步。你可以阅读下一节如果您需要在另一个步骤中编辑容器。
请注意
作为规则，只使用编译器传递中的服务定义，而不创建服务实例。在实践中，这意味着使用这些方法有()，findDefinition ()，getDefinition ()，setDefinition ()，等等，而不是get ()，设置()等。
提示
确保编译器通道不要求服务存在。如果某些所需的服务不可用，则中止方法调用。
编译器传递的一个常见用例是搜索具有特定标记的所有服务定义，以便动态地将每个服务插入其他服务。请参阅有关服务标签举个例子。
创建单独的编译器通道
有时候，你需要在编译过程中做不止一件事，想要使用编译器而不使用扩展，或者你需要在编译过程的另一个步骤执行一些代码。在这些情况下，可以创建一个实现CompilerPassInterface：
1 2 3 4 5 6 7 8 9 10
使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼编译器＼CompilerPassInterface；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼ContainerBuilder；类CustomPass实现了CompilerPassInterface｛公共函数过程(ContainerBuilder＄容器）｛/ /……在编译期间做一些事情}}然后你需要在容器中注册你的自定义通行证:
1 2 3 4
使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼ContainerBuilder；＄containerBuilder＝新ContainerBuilder ();＄containerBuilder->addCompilerPass (新CustomPass ());请注意
如果您使用的是全栈框架，则编译器传递的注册方式不同，请参见如何使用编译器传递欲知详情。
控制通道顺序
默认编译器传递分为优化传递和删除传递。优化过程首先运行，并包括诸如解析定义中的引用之类的任务。删除通道执行删除私有别名和未使用的服务等任务。注册编译器时通过usingaddCompilerPass ()，您可以在运行编译器通道时进行配置。默认情况下，它们在优化通过之前运行。
你可以使用以下常量来确定何时执行你的传递:
PassConfig: TYPE_BEFORE_OPTIMIZATIONPassConfig: TYPE_OPTIMIZEPassConfig: TYPE_BEFORE_REMOVINGPassConfig: TYPE_REMOVEPassConfig: TYPE_AFTER_REMOVING
例如，要在运行默认删除通道后运行自定义通道，请使用:
1 2 3 4 5
/ /……＄containerBuilder->addCompilerPass (新PassConfig CustomPass ()：：TYPE_AFTER_REMOVING);还可以控制每个编译阶段运行编译器传递的顺序。使用可选的第三个参数addCompilerPass ()将优先级设置为整数。默认优先级为0它的值越高，执行得越早:
1 2 3 4 5 6 7 8
/ /……// FirstPass在SecondPass之后执行，因为它的优先级更低＄容器->addCompilerPass (新PassConfig FirstPass ()：：TYPE_AFTER_REMOVING,10）;＄容器->addCompilerPass (新PassConfig SecondPass ()：：TYPE_AFTER_REMOVING,30.）;转储性能配置
如果有很多服务，使用配置文件管理服务容器比使用PHP容易理解得多。但是，当涉及到性能时，这种轻松是有代价的，因为需要解析配置文件并根据它们构建PHP配置。编译过程使容器更高效，但运行起来需要时间。通过使用配置文件，然后转储和缓存生成的配置，您可以两全其美。的PhpDumper用于转储已编译的容器:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16
使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼ContainerBuilder；使用欧宝娱乐app下载地址＼组件＼DependencyInjection＼自动倾卸车＼PhpDumper；＄文件＝__DIR__．“/缓存/ container.php”；如果(file_exists (＄文件)) {require_once＄文件；＄容器＝新ProjectServiceContainer ();｝其他的｛＄containerBuilder＝新ContainerBuilder ();/ /……＄containerBuilder->编译();＄自动倾卸车＝新PhpDumper (＄containerBuilder）;写入＄文件，＄自动倾卸车->dump ());｝ProjectServiceContainer提供给转储容器类的默认名称。但是，可以使用类选项，当你转储它:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ /……＄文件＝__DIR__．“/缓存/ container.php”；如果(file_exists (＄文件)) {require_once＄文件；＄容器＝新MyCachedContainer ();｝其他的｛＄containerBuilder＝新ContainerBuilder ();/ /……＄containerBuilder->编译();＄自动倾卸车＝新PhpDumper (＄containerBuilder）;写入＄文件，＄自动倾卸车->转储([“类”= >“MyCachedContainer”)));｝现在，您将通过使用配置文件的便捷性获得PHP配置容器的速度。此外，以这种方式转储容器可以进一步优化容器创建服务的方式。
在上面的例子中，无论何时进行任何更改，都需要删除缓存的容器文件。添加一个变量检查，以确定您是否处于调试模式，允许您在生产中保持缓存容器的速度，但在开发应用程序时获得最新配置:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/ /……//基于你的项目中的一些东西＄isDebug=……;＄文件＝__DIR__．“/缓存/ container.php”；如果(!＄isDebug& & file_exists (＄文件)) {require_once＄文件；＄容器＝新MyCachedContainer ();｝其他的｛＄containerBuilder＝新ContainerBuilder ();/ /……＄containerBuilder->编译();如果(!＄isDebug){＄自动倾卸车＝新PhpDumper (＄containerBuilder）;写入＄文件，＄自动倾卸车->转储([“类”= >“MyCachedContainer”)));}}只有在对容器的配置进行更改时，而不是在每个请求时，才在调试模式下重新编译容器，可以进一步改进这一点。这可以通过缓存用于配置容器的资源文件来实现，方法请参见“基于资源的缓存在配置组件文档中。欧宝体育电话
您不需要确定要缓存哪些文件，因为容器构建器会跟踪用于配置它的所有资源，不仅是配置文件，还包括扩展类和编译器传递的信息。这意味着对这些文件的任何更改都将使缓存失效并触发重新构建容器。你需要向容器请求这些资源，并将它们用作缓存的元数据:
12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20 21 22
/ /……//基于你的项目中的一些东西＄isDebug=……;＄文件＝__DIR__．“/缓存/ container.php”；＄containerConfigCache＝新ConfigCache (＄文件，＄isDebug）;如果(!＄containerConfigCache->isFresh ()) {＄containerBuilder＝新ContainerBuilder ();/ /……＄containerBuilder->编译();＄自动倾卸车＝新PhpDumper (＄containerBuilder）;＄containerConfigCache->写(＄自动倾卸车->转储([“类”= >“MyCachedContainer”]),＄containerBuilder->getresource ());｝require_once＄文件；＄容器＝新MyCachedContainer ();现在，不管调试模式是否打开，缓存的转储容器都将被使用。区别在于ConfigCache使用其第二个构造函数参数将其设置为调试模式。当缓存不在调试模式时，缓存的容器将总是被使用(如果它存在的话)。在调试模式下，附加的元数据文件与所有涉及的资源文件一起写入。然后检查它们的时间戳是否已更改，如果有，则缓存将被视为过期。
请注意
在全栈框架中，容器的编译和缓存都由您负责。
