yii2项目实战-路由美化以及如何正确的生成链接

美化路由

何为美化路由呢？美化嘛，无外乎就是给路由化化妆，让她好看点。我虽没化过妆，那好歹也是见过描描眉的。下面我们就来看看如何给你的路由添加添加点“颜色”的。

yii的路由美化工作，全权由urlManager组件负责。默认情况下，该组件并没有开启。

我们在配置文件backend\config\main.php中简单配置下该组件

'urlManager' => [
    'enablePrettyUrl' => false,
    'showScriptName' => true,
    'enableStrictParsing' => false,
    'suffix' => '',
    'rules' => [
    ],
],

按照我们上文的配置，你可能看不到当前路由有什么变化，我们来做几个小例子分别讲述下要介绍的这几个参数

enablePrettyUrl：是否开启美化效果

我们把false改为true前后，分别访问下左侧的“博客”菜单项，前后对比如下：

1 2	false：/index.php?r=blog%2Findex true：/index.php/blog/index

这效果感觉跟开了美颜相机似的。

showScriptName：是否或略脚本名index.php

就上面的链接而言，大多数情况下我们并不想展示index.php，我们更想要的是/blog/index效果，这个时候showScriptName的作用就显现出来了

不过该参数还需要我们配置web服务器如apache和nginx，为了更详细的说明，我们准备单独写篇文章说说。

enableStrictParsing：是否开启严格解析路由

什么意思呢？假设我们在开启了路由美化的功能（enablePrettyUrl设置为true），enableStrictParsing设置为false的情况下，我们直接访问/index.php/blog/index肯定是没有问题的。但是如果我们直接访问/index.php?r=blog%2Findex呢？发现页面展示的效果是/site/index（实际上这里展示的默认的路由页面），并非是博客列表页面。如果我们把enableStrictParsing参数设置为true你会发现页面直接抛出404。因为这货设置为true之后，会匹配rules选项中设定的至少一个规则，那我们这里先设置一个路由，不然没法继续了。

1
2
3

'rules' => [
    "<controller:\w+>/<action:\w+>"=>"<controller>/<action>",
],

此时刷新下/index.php/blog/index就正常了。

rules：包含了路由的匹配规则列表

也就是说，如果我们要定制特殊的路由，就需要通过这个属性进行配置。

rules包含着我们配置的路由规则列表，当解析一个路由或者生成一个路由的时候，匹配规则的顺序是从第一条规则开始，知道匹配到第一个满足的为止。

我们来说一下rules的每一项的规则，以/blogs为例，当然这是一个不存在的路由，你可以访问下试试会不会抛出404异常。

我们在rules的第一项添加，现在我们的rules是下面这样的

'rules' => [
    '/blogs' => '/blog/index',
    "<controller:\w+>/<action:\w+>"=>"<controller>/<action>",
],

这其实就是把我们访问的/blogs路由映射到/blog/index路由上面了，所以我们访问/blogs才得以被解析并能正常访问/blog/index页面。

我们再举一个例子，如果我们要求访问/blogs/1可以展示/blog/view?id=1这个界面呢？

实际上/blog/view?id=1需要一个参数是id，我们可以这样做一个映射

1	'/blogs/<id:\d+>' => '/blog/view',

可以自行体会一下。

但是，如果我们的项目要求所有的路由都这样被解析，每一个都这样写rules岂不是很庞大很复杂？

rules不只支持正则匹配，我们还可以配置controller和action匹配所有满足的路由。比如我们在开启enableStrictParsing为true后，设置的

1	"<controller:\w+>/<action:\w+>"=>"<controller>/<action>",

再比如如果我们想要所有的controller/id映射到controller/view界面，我们可以这样配置

'rules' => [
    '/blogs' => '/blog/index',
    // '/blogs/<id:\d+>' => '/blog/view',
    '<controller:\w+>/<id:\d+>' => '<controller>/view',
    "<controller:\w+>/<action:\w+>"=>"<controller>/<action>",
],

此时我们访问 /index.php/blog/1 会正常显示/blog/view?id=1这个界面。

suffix：url后缀

有时候我们想要访问的页面都带上.html后缀，这个时候只需要简单的配置suffix参数即可

1	'suffix' => '.html',

如果我们此时在访问/index.php/blog/index恐怕是不可以的，因为我们已经要求所有的url后缀都要带上.html才可以被正常解析！即只有访问 /index.php/blog/index.html 才是可以的。

urlManager的匹配规则我们掌握了，但是！整个网站的链接是要我们手动写的，难不成你天天修改规则，我还要天天修改链接的写法吗？这简直就是一场“灾难”！

举一个例子，由于网站前期并没有考虑页面路由添加.html后缀利于seo搜索的问题，小张三，哦不小张，名字有点lower，小三吧，哦不还是小张吧。小张整站的链接的写法都是这样的

1
2
3

<a href="/site/index">Yii Forum &raquo;</a>
<a href="/site/index2">Yii Forum2 &raquo;</a>
<a href="/site/index3">Yii Forum3 &raquo;</a>

固定死的写法，这无异于给自己埋了一颗定时炸弹！

有一天老大说了，要求我们网站所有的链接都加后缀.html。no zuo no die！

再来一个小练习考考各位：

一般情况下，我们的后台列表的数据分页是借助yii\data\Pagination生成的，正常情况下其链接是这样的

1	/blog/index?page=2

如果我们想要的链接是下面这种形式的，请问如何设计？

1 2	// 其中 2是具体分页的页面 /blog/index/2.html

这个例子具体典型性，请一定要先思考再继续看下面答案！

你是不是没思考，请先思考后动手尝试几种方案后再继续往下阅读！

来，我们公布看看这个案例如何解决

列表页的数据我们是通过gridview进行展示的，但数据的来源，是通过BlogSearch的search方法提供的，我们看下这个search方法，发现最终提供数据的是ActiveDataProvider实例，这个ActiveDataProvider厉害了，它还集成了分页类yii\data\Pagination。只需要通过ActiveDataProvider的pagination属性便可以配置分页类。具体的分页基础可以参考这篇文章。

我们的blog表暂时没那么多数据，为了分页效果我们暂时设置pageSize为2，这里并设置每页数量的参数为false

$dataProvider = new ActiveDataProvider([
    'query' => $query,
    'pagination' => [
        'pageSize' => 2,
        'pageSizeParam' => false,
    ],
]);

接下来我们要做的，便是配置urlManager的路由规则，以便生成的链接满足我们的需求。

在rules中添加一条如下的规则即可

1	'<controller:\w+>/<action:\w+>/<page:\d+>' => '<controller>/<action>',

完整版的如下：

'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName' => false,
    'enableStrictParsing' => true,
    'suffix' => '.html',
    'rules' => [
        '<controller:\w+>/<action:\w+>/<page:\d+>' => '<controller>/<action>',
        "<controller:\w+>/<action:\w+>"=>"<controller>/<action>",
    ],
],

Url工具类的使用

URL工具类指的是yii\helpers\BaseUrl类，实际开发工作中，应用中的所有链接，我们都建议通过该类来生成，其好处不可言喻，我们来看看。

如果小张所有的链接都像下面这样写，反过来想想，他准能幸福的屁颠屁颠的。

<?php
use yii\helpers\Url;
?>

<a href="<?= Url::to(['site/index']) ?>">Yii Forum &raquo;</a>
<a href="<?= Url::toRoute('site/index') ?>">Yii Forum2 &raquo;</a>
<a href="<?= Url::toRoute(['site/index']) ?>">Yii Forum3 &raquo;</a>

细心的同学发现了我们这里其实列举了三种写法，其效果都是一样的。尤其是使用Url::to方法，参数一定要是数组形式，数组形式的参数等价于Url::toRoute形式。

现在，我们的重心就转移在Url::toRoute方法上了。该方法会根据你配置的urlManager组件规则去生成链接，按照我们上文中对urlManager的配置，我们再来列举两个简单的案例

1 2	<a href="<?= Url::to(['/blogs']) ?>">Yii Forum4 »</a> <a href="<?= Url::to(['site/index', 'id' => 1]) ?>">Yii Forum5 »</a>

其生成的链接形式分别是

1 2	<a href="/index.php/blogs.html">Yii Forum4 »</a> <a href="/index.php/site/index/1.html">Yii Forum5 »</a>

关于路由的美化与链接的生成，我们就说这么多，尤其是链接的生成需要特别注意哦，no zuo no die！