[003] Symfony 4 路由

Symfony 4 的路由支持的格式的非常丰富. 可以自己在 Controller 里定义, 也可以在单独的 YAML, XML, PHP 文件中定义. 通常最方便的做法自己在 Controller 里定义比较直观.

在 Controller 里自己定下路由定义是通过注释来实现的. 通过 annotations 解析方法的注释部分的 @Route 声明, 进行路由解析.

使用 Annotations 方法非常容易, 只需要 Composer 安装一下即可. 由于 Symfony 有 Flex 机制, 安装包非常的方便.

$ composer require annotations

简单的 Route 定义代码:

<?php
/**
 * src/Controller/BlogController.php
 */

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Routing\Annotation\Route;

class BlogController extends AbstractController
{
    /**
     * 匹配 URL: /blog
     * @Route("/blog", name="blog_list")
     */
    public function list()
    {
        //todo
    }

    /**
     * 匹配 URL: /blog/*
     * @Route("/blog/{slug}", name="blog_show")
     * @param mixed $slug
     */
    public function show($slug)
    {
        //todo
    }
}

上面对2个方法分别定义了2个路由.

• 如果请求URL为: /blog, 那么会执行: list() 方法.
• 如果请求URL为: /blog/*, 那么会执行: show() 方法. /blog/{slug} 中 {slug} 为占位符, 可以匹配所有的内容. 并且 $slug 变量会作为函数参数进行传递到方法中去.

• 路由国际化 i18n

一个方法可以定义多个国际化的路由, 通常由语言区域为来区分.

    /**
     * @Route({
           "zh": "guan-yu-wo-men",
     *     "en": "about-us"
     * }, name="about_us")
     */
    public function about()
    {
        //todo
    }

通常对国际化的URL中加一个该区域前缀, 具体的后面再说了.

• 对路由中的 {placeholder} 进行约束

通常路由中定义了 占位符 {placeholder}, 表示任意都匹配, 这样会有一些不必要的冲突, 可以通过约束条件来让路由看起来更智能. 假设定义: 1, 列表页路由: blog_list: /blog/{page}, 2, 详情页路由: blog_show: /blog/{slug}.

• /blog/{page}: 匹配所有 /blog/* 请求.
• /blog/{slug}: 也匹配所有 /blog/* 请求.

默认情况下, 先定义的路由会获得被执行权, 但是实际上我们希望 /blog/1, /blog/2 此类请求命中: blog_list. 而 /blog/article-title-one, /blog/article-title-other 此类请求命中: blog_show.

使用 requirements 属性来解决问题:

    /**
     * 匹配 URL: /blog/1-N
     * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
     * @param int $page
     */
    public function list($page)
    {
        //todo
    }

\d+ 是一个正则表达式, 表示匹配所有的数字. 这样定义后, URL匹配规则会变成这样:

URL	Route	参数
/blog/2	blog_list	$page = 2
/blog/hello-world	blog_show	$slug = hello-world

对占位符的约束简略写法, 在占位符后用<>声明约束条件. 上面的可改写为:

@Route("/blog/{page<\d+>}", name="blog_list")

• 对占位符的变量设置默认值
  在 Controller 的 method 的参数中指定一个默认值. 比如: public function list($page = 1).
  在声明 Route 的时候, 在占位符后添加问号?再写上默认值. 比如:

@Route("/blog/{page<\d+>?1}", name="blog_list")

路由的基础用法指南来源: https://symfony.com/doc/current/routing.html