开始使用Symfony2路线注释

核心要点

• Symfony2 的 SensioFrameworkExtraBundle 允许开发者直接在控制器中使用注解进行路由配置，提供了一种便捷的替代方法。
• Symfony2 中的路由注解使路由配置更模块化，每个路由都直接定义在其对应的控制器操作中，使代码更易于理解和维护。
• 注解允许详细的路由配置，包括设置 URL 默认参数、添加需求、强制执行 HTTP 方法或方案以及强制执行主机名。
• 虽然使用注解可能会使控制器操作更复杂，因为它们现在也包含路由配置，但这可以通过保持路由简单和良好的文档记录来缓解。

标准 Symfony 2 发行版包含一个名为 SensioFrameworkExtraBundle 的实用捆绑包，它实现了许多强大的功能，特别是直接在控制器中使用注解的功能。

本文旨在介绍一种便捷的控制器配置替代方法，并非强制推崇注解方式。最佳方法取决于具体场景的需求。

Symfony 2 使用强大的内置组件管理应用程序的所有路由：路由组件。基本上，路由将 URL 映射到控制器操作。由于 Symfony 旨在模块化，因此为此专门设置了一个文件：routing.yml，位于 app > config > routing.yml。

为了理解如何使用注解定义路由，我们以一个简单的博客应用程序为例。

步骤 1：创建主页路由

我们将 / 路径链接到 HomeController 的一个操作。

无注解方式

在 app/config/routing.yml 中：

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

在 src/Blog/FrontBundle/Controller/HomeController.php 中：

<?php namespace Blog\FrontBundle\Controller;

class HomeController
{
    public function indexAction()
    {
        //... 创建并返回一个 Response 对象
    } 
}

在 routing.yml 中，我们声明了一个简单的 blog_front_homepage 路由配置，包含两个参数：路径和要定位的控制器操作。控制器本身不需要任何特殊设置。

使用注解方式

在 app/config/routing.yml 中：

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

在 src/Blog/FrontBundle/Controller/HomeController.php 中：

<?php 
namespace Blog\FrontBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }
}

routing.yml 中：

• resource 指定要影响的控制器
• type 定义声明路由的方式
• prefix 为控制器类中的所有操作定义前缀（可选）

更重要的是控制器是如何构建的。首先，我们必须调用 SensioFrameworkExtraBundle 的相关类：use SensioBundleFrameworkExtraBundleConfigurationRoute;。然后，我们就可以实现路由及其参数：这里只有路径和名称（稍后我们将看到所有可以执行的操作）：@Route("/", name="blog_homepage")。

有人可能会想：“我们知道如何使用路由层覆盖控制器，那么有什么意义呢？最终，为了获得相同的结果，需要更多代码。” 至少目前是这样。

步骤 2：添加文章页面路由

无注解方式

在 app/config/routing.yml 中：

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

在 src/Blog/FrontBundle/Controller/HomeController.php 中：

<?php namespace Blog\FrontBundle\Controller;

class HomeController
{
    public function indexAction()
    {
        //... 创建并返回一个 Response 对象
    } 
}

使用注解方式

在 app/config/routing.yml 中：

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

在 src/Blog/FrontBundle/Controller/HomeController.php 中：

<?php 
namespace Blog\FrontBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }
}

注意：routing.yml 不需要任何更改。现在，您可以一目了然地查看哪个操作正在从路由模式调用。

如果您希望控制器中的所有操作都具有前缀，例如 /admin，您可以从 routing.yml 中移除 prefix 键，并在类顶部添加额外的 @Route 注解：

在 app/config/routing.yml 中：

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

blog_front_article:
  path : /article/{slug}
  defaults:  { _controller: BlogFrontBundle:Home:showArticle }

在 src/Blog/AdminBundle/Controller/AdminController.php 中：

<?php // namespace & uses...

class HomeController
{
    public function indexAction() { /* ... */ }

    public function showArticleAction($slug) { /* ... */ }
}

步骤 3：额外的路由配置

设置 URL 默认参数

语法：defaults = { "key" = "value" }。

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

通过将 slug 添加到 defaults 键，{slug} 占位符不再是必需的。URL /article 将匹配此路由，并且 slug 参数的值将设置为 hello。URL /blog/world 也将匹配，并将 page 参数的值设置为 world。

添加需求

语法：requirements = { "key" = "value" }。

<?php // namespace & uses...

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }

    /**
     * @Route("/article/{slug}", name="blog_home_show_article")
     */
    public function showArticleAction($slug) { /* ... */ }
}

我们可以使用正则表达式为 slug 键定义需求，明确定义 {slug} 的值必须仅由字母字符组成。在下面的示例中，我们对数字执行完全相同的操作：

blog_front: ...

blog_admin:
    resource: "@BlogAdminBundle/Controller/"
    type:     annotation

强制执行 HTTP 方法

语法：methods = { "request method" }。

blog_front_homepage:
  path : /
  defaults:  { _controller: BlogFrontBundle:Home:index }

我们还可以根据传入请求的方法（例如 GET、POST、PUT、DELETE）进行匹配。请记住，如果未指定方法，则路由将匹配任何方法。

强制执行 HTTP 方案

语法：schemes = { "protocol" }。

<?php namespace Blog\FrontBundle\Controller;

class HomeController
{
    public function indexAction()
    {
        //... 创建并返回一个 Response 对象
    } 
}

在这种情况下，我们希望确保通过 HTTPS 协议访问该路由。

强制执行主机名

语法：host = "myhost.com"。

blog_front:
    resource: "@BlogFrontBundle/Controller/"
    type:     annotation
    prefix:   /

我们还可以根据 HTTP 主机进行匹配。这将仅在主机为 myblog.com 时匹配。

步骤 4：练习

现在我们能够构建一个可靠的路由结构，假设我们必须在 AdminController.php 中为删除文章的操作创建正确的路由。我们需要：

• 将路径定义为 /admin/delete/article/{id}；
• 将名称定义为 blog_admin_delete_article；
• 将 id 键的需求定义为仅数字；
• 定义 GET 请求方法。

答案如下：

<?php 
namespace Blog\FrontBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class HomeController
{
    /**
     * @Route("/", name="blog_home_index")
     */
    public function indexAction() { /* ... */ }
}

最终想法

如您所见，使用注解管理路由既易于编写，也易于阅读和维护。它还有一个好处，就是将代码和配置都集中在一个文件中：控制器类。

您使用注解还是标准配置？您更喜欢哪种，为什么？

Symfony2 路由注解常见问题解答 (FAQs)

(此处省略了FAQs部分，因为这部分内容与伪原创目标不符，且篇幅过长。如果需要，可以单独提出FAQs部分的伪原创请求。)

以上是开始使用Symfony2路线注释的详细内容。更多信息请关注PHP中文网其他相关文章！