自定义动态路由

编辑此页

DynamicRouter 被设计为可自定义的。路由匹配和 URL 生成服务都可以被注入，并且提供的路由匹配器和 URL 生成器类被构建为可以进一步自定义。

本章描述了最常见的自定义。如果你想进一步深入，你需要阅读组件文档并查看源代码。

如果 DynamicRouter 完全不符合你的需求，你可以选择编写自己的路由器来挂钩到 ChainRouter。

编写你自己的路由增强器

如果你有 RouteEnhancerInterface 实现，而这些实现没有被提供的增强器处理，你可以添加你自己的实现。

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/AppBundle/Routing/Enhancer/SimpleEnhancer.php
namespace AppBundle\Routing\Enhancer;

use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface;
use Symfony\Component\HttpFoundation\Request;

class SimpleEnhancer implements RouteEnhancerInterface
{
    public function enhance(array $defaults, Request $request)
    {
        // ... customize the $defaults array

        return $defaults;
    }
}
    

只需为你的增强器定义服务，并使用 dynamic_router_route_enhancer 标记它们，即可将它们添加到路由中。你可以在标签上指定一个可选的 priority 参数来控制增强器执行的顺序。优先级越高，增强器执行得越早。

        1
2
3
4
5
6
        # app/config/services.yaml
services:
    app.routing.simple_enhancer:
        class: AppBundle\Routing\Enhancer\SimpleEnhancer
        tags:
            -  { name: dynamic_router_route_enhancer, priority: 10 }
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- app/config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="https://symfony.ac.cn/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://symfony.ac.cn/schema/dic/services https://symfony.ac.cn/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="app.routing.simple_enhancer" class="AppBundle\Routing\Enhancer\SimpleEnhancer">
            <tag name="dynamic_router_route_enhancer" priority="10" />
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
7
8
9
10
        // app/config/services.php
use AppBundle\Routing\Enhancer\SimpleEnhancer;
use Symfony\Component\DependencyInjection\Definition;

$definition = new Definition(SimpleEnhancer::class);
$definition->addTag('dynamic_router_route_enhancer', [
    'priority' => 10,
]);

$container->setDefinition('app.routing.simple_enhancer', $definition);
    

使用自定义路由提供器

动态路由允许你自定义路由提供器（即负责从数据库检索路由的类），以及扩展的路由对象。

创建路由提供器

路由提供器必须实现 RouteProviderInterface。以下类提供了一个使用 ODM 仓库的简单解决方案。

        1
2
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
        // src/AppBundle/Repository/RouteProvider.php
namespace AppBundle\Repository;

use Doctrine\ODM\PHPCR\DocumentRepository;
use Symfony\Cmf\Component\Routing\RouteProviderInterface;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route as SymfonyRoute;

class RouteProvider extends DocumentRepository implements RouteProviderInterface
{
    /**
     * This method is used to find routes matching the given URL.
     */
    public function findManyByUrl($url)
    {
        // for simplicity we retrieve one route
        $document = $this->findOneBy([
            'url' => $url,
        ]);

        $pattern = $document->getUrl(); // e.g. "/this/is/a/url"

        $collection = new RouteCollection();

        // create a new Route and set our document as
        // a default (so that we can retrieve it from the request)
        $route = new SymfonyRoute($pattern, [
            'document' => $document,
        ]);

        // add the route to the RouteCollection using
        // a unique ID as the key.
        $collection->add('my_route_'.uniqid(), $route);

        return $collection;
    }

    /**
     * This method is used to generate URLs, e.g. {{ path('foobar') }}.
     */
    public function getRouteByName($name, $params = [])
    {
        $document = $this->findOneBy([
            'name' => $name,
        ]);

        if (!$document) {
            throw new RouteNotFoundException("No route found for name '$name'");
        }

        $route = new SymfonyRoute($document->getUrl(), [
            'document' => $document,
        ]);

        return $route;
    }
}
    

提示

你可能已经注意到我们返回了一个 RouteCollection 对象 - 为什么不返回单个 Route 呢？动态路由允许我们返回许多候选路由，换句话说，可能匹配传入 URL 的路由。这对于启用匹配动态路由的可能性非常重要，例如 /page/{page_id}/edit。在我们的示例中，我们精确匹配给定的 URL，并且只返回单个 Route。

替换默认的 CMF 路由提供器

要替换默认的 RouteProvider，需要按如下方式修改你的配置

        1
2
3
4
        # app/config/packages/cmf_routing.yaml
cmf_routing:
    dynamic:
        route_provider_service_id: app.route_provider
    

        1
2
3
4
5
6
7
        <!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="https://symfony.ac.cn/schema/dic/services">
    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <dynamic route-provider-service-id="app.route_provider"/>
    </config>
</container>
    

        1
2
3
4
5
6
        // app/config/packages/cmf_routing.php
$container->loadFromExtension('cmf_routing', [
    'dynamic' => [
       'route_provider_service_id' => 'app.route_provider',
    ],
]);
    

其中 app.route_provider 是你的路由提供器的服务 ID。有关创建自定义服务的信息，请参阅在容器中创建和配置服务。

使用自定义 URL 生成器

动态路由器还可以从路由对象生成 URL。如果你需要自定义此行为，超出路由生成事件允许的范围，你可以自己实现 Symfony\Component\Routing\Generator\UrlGeneratorInterface 并配置该服务

        1
2
3
4
        # app/config/packages/cmf_routing.yaml
cmf_routing:
    dynamic:
        url_generator: app.my_url_generator
    

        1
2
3
4
5
6
7
        <!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="https://symfony.ac.cn/schema/dic/services">
    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <dynamic url-generator="app.my_url_generator"/>
    </config>
</container>
    

        1
2
3
4
5
6
        // app/config/packages/cmf_routing.php
$container->loadFromExtension('cmf_routing', [
    'dynamic' => [
       'url_generator' => 'app.my_url_generator',
    ],
]);
    

RouteDefaultsValidator

路由的 getDefaults 方法有一个 RouteDefaults 约束。当验证路由时，将调用 RouteDefaultsValidator。如果设置了 _controller 或 _template 默认值，则验证器将检查它们是否存在。

你可以通过设置 cmf_routing.validator.route_defaults.class 参数来覆盖验证器。

这项工作，包括代码示例，根据 Creative Commons BY-SA 3.0 许可协议获得许可。

版本