如何创建自定义路由加载器
编辑本页警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 5.0，现已不再维护。
读本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。
如何创建自定义路由加载器
简单的应用程序通常可以在一个配置文件中定义它们所有的路由配置/ routes.yaml(见路由)．然而，在大多数应用程序中，从不同的资源导入路由定义是很常见的:控制器文件中的PHP注释、YAML、存储在某个目录中的XML或PHP文件等等。
内置路由加载器
ob娱乐下载Symfony为最常见的需求提供了几种路由加载器:
- YAML
- XML
- PHP
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
#配置/ routes.yamlapp_file:#从存储在某个bundle中的给定路由文件中加载路由资源:“@AcmeBundle /资源/ config / routing.yaml”app_annotations:#从该目录中找到的控制器的PHP注释中加载路由资源:“. . / src /控制器/”类型:注释app_directory:#从该目录下的YAML、XML或PHP文件中加载路由资源:“遗留/路由/ . . /”类型:目录app_bundle:#从某个bundle目录中的YAML、XML或PHP文件中加载路由资源:“@AcmeOtherBundle /资源/ config /路由/”类型:目录请注意
当导入资源时，键(例如。app_file)是集合的名称。只要确保每个文件都是唯一的，这样其他行就不会覆盖它。
如果您的应用程序需求不同，您可以创建自己的自定义路由加载器，这将在下一节中解释。
什么是自定义路由加载器
自定义路由加载器使您能够基于一些约定、模式或集成生成路由。这个用例的一个例子是OpenAPI-ob娱乐下载Symfony-Routing该库基于OpenAPI/Swagger注释生成路由。另一个例子是SonataAdminBundle它根据CRUD约定创建路由。
加载路径
类加载Symfony应用程序中的ob娱乐下载路由DelegatingLoader．这个加载器使用其他几个加载器(委托)来加载不同类型的资源，例如YAML文件或@Route控制器文件中的注释。专门的加载器实现LoaderInterface因此有两个重要的方法:支持()而且load ()．
看看这些线条routes.yaml：
- YAML
- XML
- PHP
1 2 3 4
#配置/ routes.yaml控制器:资源:. . / src /控制器/类型:注释当主加载器解析这个时，它会尝试所有已注册的委托加载器并调用它们的支持()方法使用给定资源(. . / src /控制器/)和类型(注释)作为参数。当其中一个加载器返回时真正的,它的load ()方法将被调用，该方法将返回RouteCollection包含路线对象。
请注意
通过这种方式加载的路由将被路由器缓存，就像用默认格式(如XML、YAML、PHP文件)定义路由一样。
使用自定义服务加载路由
使用常规的Symfony服务是以ob娱乐下载定制的方式加载路由的最简单方法。这比创建一个完整的自定义路由加载器要容易得多，所以你应该首先考虑这个选项。
为此，定义服务类型:作为加载路由资源的类型，并配置调用的服务和方法:
- YAML
- XML
- PHP
1 2 3 4
#配置/ routes.yamladmin_routes:资源:“admin_route_loader:: loadRoutes”类型:服务在本例中，通过调用loadRoutes ()服务ID为的方法admin_route_loader．您的服务不必扩展或实现任何特殊的类，但被调用的方法必须返回一个RouteCollection对象。
如果你在使用可以使用autoconfigure，您的类应该实现RouteLoaderInterface自动标记的接口。如果你不使用自动配置，手动标记routing.route_loader．
请注意
使用服务路由加载器定义的路由将被框架自动缓存。因此，无论何时您的服务应该加载新的路由，不要忘记清除缓存。
提示
如果您的服务是可调用的，则不需要精确指定要使用的方法。
创建自定义加载器
要从一些自定义源加载路由(即从注解、YAML或XML文件以外的东西加载路由)，你需要创建一个自定义路由加载器。这个加载器必须实现LoaderInterface．
在大多数情况下，它更容易从加载程序而不是实现LoaderInterface你自己。
类型的示例加载器支持加载路由资源额外的．类型名不应与可能支持同一类型资源的其他加载器冲突。根据你的工作，随便起个名字。资源名称本身并没有在示例中实际使用:
12 34 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 38 39 40 41 42 43
/ / src /路由/ ExtraLoader.php名称空间应用程序＼路由；使用ob娱乐下载＼组件＼配置＼加载程序＼加载程序；使用ob娱乐下载＼组件＼路由＼路线；使用ob娱乐下载＼组件＼路由＼RouteCollection；类ExtraLoader扩展加载程序｛私人＄isLoaded＝假；公共函数负载（＄资源、字符串＄类型= null)｛如果（真正的= = =＄这->isLoaded) {扔新\ RuntimeException (“不要添加“额外”加载器两次”);｝＄路线＝新RouteCollection ();//准备一个新的路由＄路径＝“额外/{参数}”；＄违约= (“_controller”＝＞控制器应用\ \ ExtraController:额外的,);＄需求= (“参数”＝＞“\ d +”,);＄路线＝新路线(＄路径，＄违约，＄需求);//添加新的路由到路由集合＄routeName＝“extraRoute”；＄路线->add (＄routeName，＄路线);＄这->isLoaded =真正的；返回＄路线；｝公共函数支持（＄资源、字符串＄类型= null)｛返回“额外的”= = =＄类型；}}确保您指定的控制器确实存在。在这种情况下，您必须创建一个额外的()方法中的ExtraController：
12 3 4 5 6 7 8 9 10 11 12 13
/ / src /控制器/ ExtraController.php名称空间应用程序＼控制器；使用ob娱乐下载＼包＼FrameworkBundle＼控制器＼AbstractController；使用ob娱乐下载＼组件＼HttpFoundation＼响应；类ExtraController扩展AbstractController｛公共函数额外的（＄参数）｛返回新响应(＄参数);}}属性定义服务ExtraLoader：
- YAML
- XML
- PHP
1 2 3 4 5 6
#配置/ services.yaml服务:#……应用\ \ ExtraLoader路由:标签:(routing.loader)注意标签routing.loader．所有与此相关的服务标签将被标记为潜在的路由加载器，并作为专门的路由加载器添加到routing.loader服务，这是一个实例DelegatingLoader．
使用自定义加载器
如果您什么也不做，那么您的自定义路由加载器就会这样做不被称为。接下来要做的就是在路由配置中添加几行代码:
- YAML
- XML
- PHP
1 2 3 4
#配置/ routes.yamlapp_extra:资源:．类型:额外的这里重要的部分是类型关键。它的值应该是额外的因为这是一种ExtraLoader支持，这将确保它load ()方法被调用。的资源键是无关紧要的ExtraLoader，所以设置为．(一个点)。
请注意
使用自定义路由加载器定义的路由将被框架自动缓存。因此，无论何时更改装入器类本身的内容，都不要忘记清除缓存。
更先进的装载机
如果您的自定义路由加载器从加载程序如上所示，您还可以使用提供的解析器，它是LoaderResolver，加载从路由资源。
您仍然需要实现支持()而且load ()．每当您想加载另一个资源(例如YAML路由配置文件)时，都可以调用进口()方法:
12 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
/ / src /路由/ AdvancedLoader.php名称空间应用程序＼路由；使用ob娱乐下载＼组件＼配置＼加载程序＼加载程序；使用ob娱乐下载＼组件＼路由＼RouteCollection；类AdvancedLoader扩展加载程序｛公共函数负载（＄资源、字符串＄类型= null)｛＄路线＝新RouteCollection ();＄资源＝“@ThirdPartyBundle /资源/ config / routes.yaml”；＄类型＝yaml的；＄importedRoutes＝＄这->导入(＄资源，＄类型);＄路线->addCollection (＄importedRoutes);返回＄路线；｝公共函数支持（＄资源、字符串＄类型= null)｛返回“advanced_extra”= = =＄类型；}}请注意
导入的路由配置的资源名称和类型可以是路由配置加载器通常支持的任何类型(YAML、XML、PHP、注释等)。
请注意
有关更高级的用途，请参阅ChainRouter由Symfony CMF项目提供ob娱乐下载。该路由器允许应用程序组合使用两个或多个路由器，例如在编写自定义路由器时继续使用默认的Symfony路由系统。ob娱乐下载
