開始使用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中文網其他相關文章！