什麼是 Symfony 路由元件？

Symfony 路由元件是一個(gè)非常流行的路由元件，它由多個(gè)框架改編而成，如果您希望在 PHP 應(yīng)用程式中設(shè)定路由，它可以提供很大的靈活性。

如果您已經(jīng)建立了自訂 PHP 應(yīng)用程式並正在尋找功能豐富的路由庫，那麼 Symfony 路由元件是最佳候選之一。它還允許您以 YAML 格式定義應(yīng)用程式的路由。

從安裝和配置開始，我們將透過實(shí)際範(fàn)例來示範(fàn)該元件用於路由配置的各種選項(xiàng)。在本文中，您將了解：

• Symfony 路由元件的安裝與設(shè)定
• #如何設(shè)定基本路線
• #如何從 YAML 檔案載入路由
• 將路由建立為註解：推薦方式

安裝和設(shè)定

在本節(jié)中，我們將安裝在 PHP 應(yīng)用程式中設(shè)定路由所需的函式庫。我假設(shè)您已經(jīng)在系統(tǒng)中安裝了 Composer，因?yàn)槲覀冃枰鼇戆惭b Packagist 上提供的必要程式庫。

安裝 Composer 後，請(qǐng)繼續(xù)使用下列指令安裝核心路由元件。

$composer require symfony/routing

雖然路由元件本身足以在您的應(yīng)用程式中提供全面的路由功能，但我們也將繼續(xù)安裝一些其他元件，以使我們的生活更輕鬆並豐富現(xiàn)有的核心路由功能。

首先，我們將繼續(xù)安裝 HttpFoundation 元件，該元件為 PHP 全域變數(shù)和回應(yīng)相關(guān)函數(shù)提供物件導(dǎo)向的包裝器。它確保您不需要直接存取 $_GET、$_POST 等全域變數(shù)。

$composer require symfony/http-foundation

接下來，如果您想在 YAML 檔案而不是 PHP 程式碼中定義應(yīng)用程式路由，則 YAML 元件可以發(fā)揮作用，因?yàn)樗梢詭椭鷮?YAML 字串轉(zhuǎn)換為 PHP 數(shù)組，反之亦然。

$composer require symfony/yaml

最後，我們將安裝 Config 元件，它提供了幾個(gè)實(shí)用程式類別來初始化和處理不同類型檔案（如 YAML、INI、XML 等）中定義的設(shè)定值。在我們的例子中，我們將使用它從 YAML 檔案載入路由。

$composer require symfony/config

這就是安裝部分，但是你應(yīng)該如何使用它？事實(shí)上，只需將 Composer 建立的 autoload.php 檔案包含在您的應(yīng)用程式中即可，如下列程式碼片段所示。

<?php
require_once './vendor/autoload.php';
 
// application code
?>

設(shè)定基本路由

在上一節(jié)中，我們完成了必要的路由元件的安裝?，F(xiàn)在，您可以立即在 PHP 應(yīng)用程式中設(shè)定路由。

讓我們繼續(xù)建立包含以下內(nèi)容的 basic_routes.php 檔案。

<?php
require_once './vendor/autoload.php';
 
use Symfony\Component\Routing\Matcher\UrlMatcher;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Generator\UrlGenerator;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 
try
{
    // Init basic route
    $foo_route = new Route(
      '/foo',
      array('controller' => 'FooController')
    );
 
    // Init route with dynamic placeholders
    $foo_placeholder_route = new Route(
      '/foo/{id}',
      array('controller' => 'FooController', 'method'=>'load'),
      array('id' => '[0-9]+')
    );
 
    // Add Route object(s) to RouteCollection object
    $routes = new RouteCollection();
    $routes->add('foo_route', $foo_route);
    $routes->add('foo_placeholder_route', $foo_placeholder_route);
 
    // Init RequestContext object
    $context = new RequestContext();
    $context->fromRequest(Request::createFromGlobals());
 
    // Init UrlMatcher object
    $matcher = new UrlMatcher($routes, $context);
 
    // Find the current route
    $parameters = $matcher->match($context->getPathInfo());
 
    // How to generate a SEO URL
    $generator = new UrlGenerator($routes, $context);
    $url = $generator->generate('foo_placeholder_route', array(
      'id' => 123,
    ));
 
    echo '<pre class="brush:php;toolbar:false">';
    print_r($parameters);
 
    echo 'Generated URL: ' . $url;
    exit;
}
catch (ResourceNotFoundException $e)
{
  echo $e->getMessage();
}

使用 Symfony Routing 元件設(shè)定路由通常要經(jīng)歷以下列出的一系列步驟。

• 為每個(gè)應(yīng)用程式路由初始化 Route 物件。
• 將所有 Route 物件新增至 RouteCollection 物件。
• 初始化 RequestContext 對(duì)象，該對(duì)象保存目前請(qǐng)求上下文資訊。
• 透過傳遞 RouteCollection 物件和 RequestContext 物件來初始化 UrlMatcher 物件。

初始化不同路由的路由物件

讓我們繼續(xù)定義一個(gè)非常基本的 foo 路由。

$foo_route = new Route(
  '/foo',
  array('controller' => 'FooController')
);

Route 建構(gòu)函數(shù)的第一個(gè)參數(shù)是 URI 路徑，第二個(gè)參數(shù)是符合此特定路由時(shí)要傳回的自訂屬性陣列。通常，它是控制器和方法的組合，當(dāng)請(qǐng)求此路由時(shí)您要呼叫它們。

接下來我們來看看參數(shù)化路由。

$foo_placeholder_route = new Route(
  '/foo/{id}',
  array('controller' => 'FooController', 'method'=>'load'),
  array('id' => '[0-9]+')
);

上述路由可以符合 foo/1、foo/123 等類似的 URI。請(qǐng)注意，我們將{id} 參數(shù)限制為僅限數(shù)字值，因此它不會(huì)符合foo/bar 這樣的URI，因?yàn)?code class=" inline">{id}參數(shù)以字串形式提供。

將所有路由物件新增至 RouteCollection 物件

下一步是將我們?cè)谏弦还?jié)中初始化的路由物件新增到 RouteCollection 物件。

$routes = new RouteCollection();
$routes->add('foo_route', $foo_route);
$routes->add('foo_placeholder_route', $foo_placeholder_route);

正如您所看到的，這非常簡(jiǎn)單，您只需要使用 RouteCollection 對(duì)象的 add 方法來添加路由對(duì)象。 add 方法的第一個(gè)參數(shù)是路由名稱，第二個(gè)參數(shù)是路由對(duì)象本身。

初始化 RequestContext 對(duì)象

接下來，我們需要初始化RequestContext對(duì)象，該對(duì)象保存當(dāng)前請(qǐng)求上下文信息。當(dāng)我們初始化 UrlMatcher 對(duì)象時(shí)，我們將需要這個(gè)對(duì)象，因?yàn)槲覀兩院髸?huì)詳細(xì)介紹它。

$context = new RequestContext();
$context->fromRequest(Request::createFromGlobals());

初始化 UrlMatcher 對(duì)象

最后，我們需要初始化 UrlMatcher 對(duì)象以及路由和上下文信息。

// Init UrlMatcher object
$matcher = new UrlMatcher($routes, $context);

現(xiàn)在，我們擁有了可以匹配路線的一切。

如何匹配路由

這是 UrlMatcher 對(duì)象的 match 方法，它允許您將任何路由與一組預(yù)定義路由進(jìn)行匹配。

match 方法將 URI 作為其第一個(gè)參數(shù)，并嘗試將其與預(yù)定義的路由進(jìn)行匹配。如果找到該路由，它將返回與該路由關(guān)聯(lián)的自定義屬性。另一方面，如果沒有與當(dāng)前 URI 關(guān)聯(lián)的路由，它會(huì)拋出 ResourceNotFoundException 異常。

$parameters = $matcher->match($context->getPathInfo());

在我們的例子中，我們通過從 $context 對(duì)象獲取當(dāng)前 URI 來提供它。因此，如果您訪問 https://your-domain/basic_routes.php/foo URL，則 $context->getPathInfo() 返回 foo，并且我們已經(jīng)為 foo URI 定義了一條路由，因此它應(yīng)該返回以下內(nèi)容。

Array
(
    [controller] => FooController
    [_route] => foo_route
)

現(xiàn)在，讓我們繼續(xù)訪問 http://your-domain/basic_routes.php/foo/123 URL 來測(cè)試參數(shù)化路由。

Array
(
    [controller] => FooController
    [method] => load
    [id] => 123
    [_route] => foo_placeholder_route
)

如果您可以看到 id 參數(shù)與適當(dāng)?shù)闹?123 綁定，則說明有效。

接下來，讓我們嘗試訪問不存在的路由，例如 http://your-domain/basic_routes.php/unknown-route，您應(yīng)該會(huì)看到以下消息。

No routes found for "/unknown-route".

這就是如何使用 match 方法查找路由。

除此之外，您還可以使用路由組件在應(yīng)用程序中生成鏈接。提供了 RouteCollection 和 RequestContext 對(duì)象，UrlGenerator 允許您為特定路由構(gòu)建鏈接。

$generator = new UrlGenerator($routes, $context);
$url = $generator->generate('foo_placeholder_route', array(
  'id' => 123,
));

generate 方法的第一個(gè)參數(shù)是路由名稱，第二個(gè)參數(shù)是數(shù)組，如果是參數(shù)化路由，則可以包含參數(shù)。上面的代碼應(yīng)該生成 /basic_routes.php/foo/123 URL。

從 YAML 文件加載路由

在上一節(jié)中，我們使用 Route 和 RouteCollection 對(duì)象構(gòu)建了自定義路由。事實(shí)上，路由組件提供了不同的方式供您選擇來實(shí)例化路由。您可以從各種加載器中進(jìn)行選擇，例如 YamlFileLoader、XmlFileLoader 和 PhpFileLoader。

在本節(jié)中，我們將通過 YamlFileLoader 加載器來了解如何從 YAML 文件加載路由。

路由 YAML 文件

繼續(xù)創(chuàng)建包含以下內(nèi)容的 routes.yaml 文件。

foo_route:
    path:     /foo
    controller: App\Controller\FooController::index
    methods:    GET
 
foo_placeholder_route:
    path:     /foo/{id}
    controller: App\Controller\FooController::load
    methods:    GET
    requirements:
        id: '[0-9]+'

示例文件

接下來，繼續(xù)使用以下內(nèi)容創(chuàng)建 load_routes_from_yaml.php 文件。

load('routes.yaml');
 
    // Init RequestContext object
    $context = new RequestContext();
    $context->fromRequest(Request::createFromGlobals());
 
    // Init UrlMatcher object
    $matcher = new UrlMatcher($routes, $context);
 
    // Find the current route
    $parameters = $matcher->match($context->getPathInfo());
 
    // How to generate a SEO URL
    $generator = new UrlGenerator($routes, $context);
    $url = $generator->generate('foo_placeholder_route', array(
      'id' => 123,
    ));
 
    echo '
';
    print_r($parameters);
 
    echo 'Generated URL: ' . $url;
    exit;
}
catch (ResourceNotFoundException $e)
{
  echo $e->getMessage();
}

在這種情況下唯一不同的是我們初始化路由的方式！
$fileLocator = new FileLocator(array(__DIR__));
$loader = new YamlFileLoader($fileLocator);
$routes = $loader->load('routes.yaml');

我們使用 YamlFileLoader 加載器從 routes.yaml 文件加載路由，而不是直接在 PHP 本身中對(duì)其進(jìn)行初始化。除此之外，一切都是相同的，并且應(yīng)該產(chǎn)生與 basic_routes.php 文件相同的結(jié)果。
一體化路由器
在本節(jié)中，我們將介紹 Router 類，它允許您使用更少的代碼行快速設(shè)置路由。
繼續(xù)制作包含以下內(nèi)容的 all_in_one_router.php 文件。
<?php
require_once './vendor/autoload.php';
 
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\Router;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Generator\UrlGenerator;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Routing\Loader\YamlFileLoader;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 
try
{
    $fileLocator = new FileLocator(array(__DIR__));
 
    $requestContext = new RequestContext();
    $requestContext->fromRequest(Request::createFromGlobals());
 
    $router = new Router(
        new YamlFileLoader($fileLocator),
        'routes.yaml',
        array('cache_dir' => __DIR__.'/cache'),
        $requestContext
    );
 
    // Find the current route
    $parameters = $router->match($requestContext->getPathInfo());
 
    // How to generate a SEO URL
    $routes = $router->getRouteCollection();
    $generator = new UrlGenerator($routes, $requestContext);
    $url = $generator->generate('foo_placeholder_route', array(
      'id' => 123,
    ));
 
    echo '<pre class="brush:php;toolbar:false">';
    print_r($parameters);
 
    echo 'Generated URL: ' . $url;
    exit;
}
catch (ResourceNotFoundException $e)
{
  echo $e->getMessage();
}

一切都幾乎相同，除了我們實(shí)例化了 Router 對(duì)象以及必要的依賴項(xiàng)。
$router = new Router(
    new YamlFileLoader($fileLocator),
    'routes.yaml',
    array('cache_dir' => __DIR__.'/cache'),
    $requestContext
);

完成后，您可以立即使用 Router 對(duì)象的 match 方法進(jìn)行路由映射。
$parameters = $router->match($requestContext->getPathInfo());

此外，您還需要使用 Router 對(duì)象的 getRouteCollection 方法來獲取路由。
$routes = $router->getRouteCollection();

將路由創(chuàng)建為注釋：推薦方式
在本節(jié)中，我們將討論如何實(shí)現(xiàn)基于注釋的路由。它正在成為在不同框架之間定義路由的最流行的方法之一。
在我們繼續(xù)實(shí)現(xiàn)基于注釋的路由之前，我們需要安裝幾個(gè)軟件包。讓我們快速完成此操作，如以下代碼片段所示。
$composer require symfony/framework-bundle
$composer require doctrine/annotations
$composer require doctrine/cache

如您所見，我們安裝了三個(gè)不同的組件。
在您的 composer.json 文件中，添加以下內(nèi)容：
"autoload": {
    "psr-4": {
        "App\\": "app/"
    }
}

現(xiàn)在，運(yùn)行以下命令。
$composer dump-autoload

現(xiàn)在，我們準(zhǔn)備好文件了。
繼續(xù)創(chuàng)建包含以下內(nèi)容的 index.php 文件。
load(__DIR__ . '/src/Controller/');
$context = new RequestContext();
$context->fromRequest(Request::createFromGlobals());

$matcher = new UrlMatcher($routes, $context);
$parameters = $matcher->match($context->getPathInfo());

$controllerInfo = explode('::',$parameters['_controller']);

$controller = new $controllerInfo[0];
$action = $controllerInfo[1];

$controller->$action();

現(xiàn)在，讓我們?cè)?src/Controller/FooController.php 中創(chuàng)建包含以下內(nèi)容的控制器文件。
<?php
namespace App\Controller;

use Symfony\Component\Routing\Annotation\Route;

class DefaultController
{
    /**
     * @Route("/",name="index")
     */
    public function index()
    {
        echo "Index action";
    }

    /**
     * @Route("/hello",name="hello")
     */
    public function hello()
    {
        echo "Hello action";
    }
}

您可能已經(jīng)注意到，我們以注釋的形式為每個(gè)方法定義了路由。這種方法的好處是，它允許您在與這些路由關(guān)聯(lián)的控制器的代碼旁邊定義路由。
繼續(xù)訪問 https://your-domain/index.php/ URL。根據(jù)以下路由配置，它應(yīng)該調(diào)用 index 方法。
/**
 * @Route("/",name="index")
 */

另一方面，如果您嘗試訪問 http://your-domain/index.php/hello URL，它應(yīng)該調(diào)用 DefaultController 控制器的 hello 方法類。
這就是基于注釋的路由的工作原理！
結(jié)論
繼續(xù)探索路由組件中可用的其他選項(xiàng)。
今天，我們探索了 Symfony 路由組件，它使得在 PHP 應(yīng)用程序中實(shí)現(xiàn)路由變得輕而易舉。在此過程中，我們創(chuàng)建了一些示例來演示路由組件的各個(gè)方面。 
以上是使用Symfony路由組件在PHP應(yīng)用程式中設(shè)定路由的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！