YII框架路由和URL生成

时间：2021-10-18 00:35:27

路由和URL生成

当一个YII应用开始处理一个请求的时候，它首先要做的便是将请求的URL转化成一个路由。路由的作用是用于后续实例化相应的控制器和操作，以便处理请求，整个处理过程便叫做路由。路由的逆过程叫做URL生成，是指用给定的路由和参数信息来生成一个URL。当使用生成的URL来发出请求的时候，路由处理的过程又能够再次将其解析还原出原始的路由和参数信息。

主要负责路由和URL生成工作的是URL管理器，其被注册成为应用组件。URL管理器提供方法parseRequest()来解析请求，解析出其中的路由和参数信息。而方法 createUrl() 用于将给定的路由和参数信息，生成一个URL。通过在应用配置中配置URL管理器，可以让你的应用能够识别任意的URL格式，而不用修改已有程序代码。例如，你能使用如下的代码来生成一个URL。

use yii\helpers\Url;

// Url::to() calls UrlManager::createUrl() to create a URL

$url = Url::to(['post/view', 'id' => 100]);

取决于URL管理器的配置，如上代码生成的URL的样子看上去像下面这样的。假如这个URL后续被请求的话，它将被解析成上面的原始路由和参数信息。

/index.php?r=post/view&id=100

/index.php/post/100

/posts/100

URL格式

URL管理器支持两种URL格式：默认URL格式和漂亮URL格式。默认URL格式使用一个查询参数r传递路由，其他参数按照正常方式放在URL中。例如，URL /index.php?r=post/view&id=100 的路由为post/view和参数id为100。默认URL格式并不要求对URL管理器做任何配置。漂亮URL格式是使用额外的路径跟在入口脚本名之后，来展现路由和相关参数的。例如，URL /index.php/post/100的额外路径为/post/100，其展现出的路由为post/view和参数id为100。如果要使用这种URL格式，你需要根据实际需求，设计一个URL规则集。你可以通过修改URL管理器中属性enablePrettyUrl的值，来达到在这两种URL格式之间切换的目的。

路由

路由的工作可以分为两步：
1.从请求中解析出一个路由和相关参数；
2.根据路由生成响应的控制器操作，来处理该请求。

当使用默认URL格式的时候，解析出路由很简单，只要获取参数r的值便可；
当使用漂亮URL格式的时候，URL管理器会检测URL规则集，从中找出与该请求匹配的路由。如果找不到规则与之匹配，将会抛出异常yii\web\NotFoundHttpException。

一旦从请求中解析出路由，接下来要做的就是创建与该路由相关的控制器操作。路由被斜线切割成几个部分，例如，site/index会被切割成site和index。每个部分都是一个ID,它们也许指向模块、控制器或操作。从路由的第一个部分开始，应该会执行如下几步来创建模块（如果有的话）、控制器和操作：
1.设置应用主体为当前模块。
2.检查当前模块的 yii\base\Module::controllerMap 是否包含当前ID。如果是，会根据该表中的配置创建一个控制器对象，然后跳到步骤五执行该路由的后续片段。
3.检查该 ID 是否指向当前模块中 yii\base\Module::modules 属性里的模块列表中的一个模块。如果是，会根据该模块表中的配置创建一个模块对象，然后会以新创建的模块为环境，跳回步骤二解析下一段路由。
4.将该 ID 视为控制器 ID，并创建控制器对象。用下个步骤解析路由里剩下的片段。
5.控制器会在他的 yii\base\Controller::actions()里搜索当前 ID。如果找得到，它会根据该映射表中的配置创建一个操作对象；反之，控制器则会尝试创建一个与该 ID 相对应，由某个 action 方法所定义的行内操作（inline action）。

上面这些步骤中，如果有任何错误发生，应用都会抛出异常yii\web\NotFoundHttpException，意味着路由处理失败。

默认路由

当一个请求没有找到匹配的路由的时候，所谓的默认路由将会被代替使用。默认情况下，默认路由为site/index，其指向控制器site下面的操作index。你也可以通过修改应用配置中属性defaultRoute来指定它，就像下面这样：

[

    // ...

    'defaultRoute' => 'main/index',

];

catchAll 路由
当你的应用处于临时维护状态下时,你也许希望对于所有的请求，应用都显示相同的页面。有很多方法来实现这个目标，最简单的方法之一便是在应用配置中配置属性yii\web\Application::$catchAll，像下面这样。

[

    // ...

    'catchAll' => ['site/offline'],

];

创建链接

YII提供了一个帮助方法yii\helpers\Url::to()，根据提供的路由和参数信息去生成各种URL,如下是一些例子：

use yii\helpers\Url;

// creates a URL to a route: /index.php?r=post/index

echo Url::to(['post/index']);

// creates a URL to a route with parameters: /index.php?r=post/view&id=100

echo Url::to(['post/view', 'id' => 100]);

// creates an anchored URL: /index.php?r=post/view&id=100#content

echo Url::to(['post/view', 'id' => 100, '#' => 'content']);

// creates an absolute URL: http://www.example.com/index.php?r=post/index

echo Url::to(['post/index'], true);

// creates an absolute URL using the https scheme: https://www.example.com/index.php?r=post/index

echo Url::to(['post/index'], 'https');

注意，上面的例子是基于默认URL模式是开启状态的。如果漂亮URL模式被启动的话，上面创建的URL会有所不同，取决于使用的URL路由。

传递给方法 yii\helpers\Url::to()的路由信息是和上下文有关的，它可以是相对路径，也可以是绝对路径，可以根据下面的规则来标准化：

1. 如果路由传递的是空字符串，当前请求的路由将被使用；
2. 如果路由不包含任何斜杠(\),它会被认为是当前控制器的某个操作的ID,它将会被前置当前路由唯一ID；
3. 如果路由不以斜杠(\)打头，它会被认为是相对于当前模块的路由，它将会被前置当前模块的唯一ID。

=================================

未完待续。。。今日查看YII框架的中文文档，点击其中包含的某个链接竟然报错，*去其英文支持站点搜索相关文档，对比发现：中文文档有些内容可能有删节。于是，便想在阅读英文文档的时候，顺便做个翻译，给后来者一些便利，不知道这样做是否有意义？同时由于英文水平有限，翻译过程中难免有不足之处，还请大家多多拍砖...

原文网址：http://www.yiiframework.com/doc-2.0/guide-runtime-routing.html

相关文章