详解Yii2 之 生成 URL 的方法
前言
在项目中,推荐使用 Yii2 内置的 URL 工具类生成链接,这样可以非常便捷的管理整站的 URL 行为:比如通过修改配置改变整站的URL格式等。URL 更多高级的用法参见官方文档,这篇文章仅仅介绍 Yii2 生成 URL 的几种方式。
Yii2 默认的 URL 链接格式
Yii2 默认的 URL 链接格式是指为开启 URL 美化时的格式。
未启用子模块的 URL 格式:
// 参数 r 中的 article 表示控制器, view 表示动作 http://www.example.com/index.php?r=article/view&id=100
启用了子模块的 URL 格式:
// 参数 r 中的 kernel 表示子模块 http://www.example.com/index.php?r=kernel/article/view&id=100
Yii2 内置的 URL 生成工具
- URL 管理器:urlManager
- URL 助手类:yii\helpers\Url
使用内置的 URL 生成工具,以后可以在不改变源码的情况通过配置即可美化整站的 URL
URL 管理器
URL 管理器是一个名叫 urlManager 的内置应用组件。在 WEB 应用和控制台应用中以通过以下两种方式创建 URL:
- \Yii::$app->urlManager->createUrl($params)
- \Yii::$app->urlManager->createAbsoluteUrl($params, $schema = null)
createUrl
方法生成根目录的相对路径,例如:/index.php?r=article/view
createAbsoluteUrl()
方法生成的是绝对路径,例如:http://www.example.com/index.php?r=article/view
常见的利用 URL 管理器创建 URL 的例子:
// URL:/index.php?r=article/view \Yii::$app->urlManager->createUrl('article/view'); // URL:/index.php?r=article/view&id=2 \Yii::$app->urlManager->createUrl(['article/view','id'=>2]); // URL: http://www.example.com?r=kernel/article/view echo \Yii::$app->urlManager->createAbsoluteUrl('kernel/article/view');
URL 助手类
相对于 URL管理器,使用 yii\helpers\Url
助手类可大大简化 URL 的创建。
1. 假设当前 URL /index.php?r=kernel/article/view&id=10
,以下说明 URL 助手类 Url::to()
是如何工作的(不推荐):
// 创建当前 URL // 显示:/?r=kernel/article/view&id=10 echo Url::to(); // 创建当前 URL // 显示:http://www.example.com/?r=kernel/article/view&id=10 echo Url::to('', true); // 字符参数,没啥用 // 显示:kernel/article/view echo Url::to('kernel/article/view'); // 创建路由,数组参数的自动调用 Url::toRoute(...) // 显示:/index.php?r=kernel/article/view echo Url::to(['article/view']);
2. 假设当前 URL /index.php?r=kernel/article/view&id=10
,以下说明 URL 助手类 Url::toRoute()
方法是如何工作的(推荐):
// 创建当前路由(仅继承参数r的值) // 显示:/index.php?r=kernel/article/view echo Url::toRoute([]); // 相同的模块和控制器,不同的动作(仅继承参数r的值) // 显示:/index.php?r=kernel/article/list echo Url::toRoute('list'); // 相同的模块和控制器,不同的动作(仅继承参数r的值) // 显示:/index.php?r=kernel/article/list&cat=contact echo Url::toRoute(['list','cat'=>10]); // 相同模块,不同控制器和动作(仅继承参数r的值) // 显示:/index.php?r=kernel/product/index echo Url::toRoute('product/index'); // 绝对路由,不管是被哪个模块和控制器调用 // 显示:/index.php?r=product/index echo Url::toRoute('/product/index'); // 控制器动作 `actionListHot` 的 URL 格式(仅继承参数r的值,区分大小写) // 显示:/index.php?r=kernel/article/list-hot echo Url::toRoute('list-hot'); // 从别名中获取 URL // 显示:http://www.baidu.com/ Yii::setAlias('@baidu', 'http://www.baidu.com/'); echo Url::to('@baidu');
3. 假设当前 URL /index.php?r=kernel/article/view&id=10
,以下说明 URL 助手类 Url::current()
方法是如何工作的(推荐):
// 创建当前 URL(包括路由和参数) // 显示:/?r=kernel/article/view&id=10 echo Url::current(); // 移除参数 id // 显示:/?r=kernel/article/view echo Url::current(['id'=>null]); // 新增参数 cat // 显示:/?r=kernel/article/view&id=10&cat=2 echo Url::current(['cat'=>2]);