0

0

Yii2的深入学习--别名(Aliases),yii2aliases_PHP教程

php中文网

php中文网

发布时间:2016-07-12 09:06:56

|

1139人浏览过

|

来源于php中文网

原创

Yii2的深入学习--别名(Aliases),yii2aliases

在之前自动加载机制的文章中,我们有提到别名,提到 getAlias 方法,大家当时可能不太清楚,这到底是什么,今天我们就来说一下别名。

别名用来表示文件路径和 URL,这样就避免了将一些文件路径、URL以硬编码的方式写入代码中,或者多处出现一长串的文件路径、URL。

在 Yii2 中,一个别名必须以 @ 字符开头,Yii2 预定义了大量可用的别名,预定义的别名如下:

  • @yii 表示Yii框架所在的目录,也是 BaseYii.php 文件所在的位置
  • @app 表示正在运行的应用的根目录
  • @vendor 表示Composer 第三方库所在目录,一般是 @app/vendor 或 @app/../vendor
  • @bower 表示 Bower 第三方库所在目录,一般是 @vendor/bower
  • @npm 表示 NPM 第三方库所在目录,一般是 @vendor/npm
  • @runtime 表示正在运行的应用的运行时用于存放运行时文件的目录,一般是 @app/runtime
  • @webroot 表示正在运行的应用的入口文件 index.php 所在的目录,一般是 @app/web
  • @web URL别名,表示当前应用的根URL,主要用于前端
  • @common 表示通用文件夹
  • @frontend 表示前台应用所在的文件夹
  • @backend 表示后台应用所在的文件夹
  • @console 表示命令行应用所在的文件夹
  • 其他使用Composer安装的Yii扩展注册的二级别名

其中的 @common @frontend @backend 和 @console 在 baisc 的项目中是不会存在的。在 advanced 的项目中通常是定义在 commonconfigootstrap.php 文件中,其内容如下:

立即学习PHP免费学习笔记(深入)”;

<?<span>php
Yii</span>::setAlias('common', <span>dirname</span><span>(__DIR__));
Yii</span>::setAlias('frontend', <span>dirname</span>(<span>dirname</span>(__DIR__)) . '/frontend'<span>);
Yii</span>::setAlias('backend', <span>dirname</span>(<span>dirname</span>(__DIR__)) . '/backend'<span>);
Yii</span>::setAlias('console', <span>dirname</span>(<span>dirname</span>(__DIR__)) . '/console');

Yii2 中关于别名的设置和获取的方法都放在 BaseYii 类中,其结构基本如下:

<?<span>php
</span><span>class</span><span> BaseYii
{
    </span><span>/*</span><span>*
     * @var array registered path aliases
     * @see getAlias()
     * @see setAlias()
     * Yii 的路径别名的 Map, 默认 @yii 指向当前目录
     </span><span>*/</span>
    <span>public</span> <span>static</span> <span>$aliases</span> = ['@yii' =><span> __DIR__];

    </span><span>/*</span><span>*
     * Translates a path alias into an actual path.
     * 将别名转化为真实的路径
     </span><span>*/</span>
    <span>public</span> <span>static</span> <span>function</span> getAlias(<span>$alias</span>, <span>$throwException</span> = <span>true</span><span>)
    {
        </span>...<span>
    }

    </span><span>/*</span><span>*
     * Registers a path alias.
     * 用一个真实的路径注册一个别名
     </span><span>*/</span>
    <span>public</span> <span>static</span> <span>function</span> setAlias(<span>$alias</span>, <span>$path</span><span>)
    {
        </span>...<span>
    }
}</span>

这是简化之后的 BaseYii 类的结构,其中有一个重要的变量 $aliases,两个重要的方法 getAlias 和 setAlias。$aliases 是存储 Yii2 路径别名的一个数组,key 是别名,value 是真实路径。getAlias 方法是根据别名获取到真实的地址,setAlias 是用一个真实的地址去注册一个别名。

先来看下 setAlias 方法,其内容如下:

    <span>/*</span><span>*
     * Registers a path alias.
     *
     * 用一个真实的路径注册一个别名
     *
     * A path alias is a short name representing a long path (a file path, a URL, etc.)
     * For example, we use '@yii' as the alias of the path to the Yii framework directory.
     *
     * A path alias must start with the character '@' so that it can be easily differentiated
     * from non-alias paths.
     *
     * Note that this method does not check if the given path exists or not. All it does is
     * to associate the alias with the path.
     *
     * Any trailing '/' and '' characters in the given path will be trimmed.
     *
     * @param string $alias the alias name (e.g. "@yii"). It must start with a '@' character.
     * It may contain the forward slash '/' which serves as boundary character when performing
     * alias translation by [[getAlias()]].
     * @param string $path the path corresponding to the alias. If this is null, the alias will
     * be removed. Trailing '/' and '' characters will be trimmed. This can be
     *
     * - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`)
     * - a URL (e.g. `http://www.yiiframework.com`)
     * - a path alias (e.g. `@yii/base`). In this case, the path alias will be converted into the
     *   actual path first by calling [[getAlias()]].
     *
     * @throws InvalidParamException if $path is an invalid alias.
     * @see getAlias()
     </span><span>*/</span>
    <span>public</span> <span>static</span> <span>function</span> setAlias(<span>$alias</span>, <span>$path</span><span>)
    {
        </span><span>if</span> (<span>strncmp</span>(<span>$alias</span>, '@', 1<span>)) {
            </span><span>//</span><span> 如果不是以 @ 开头,就将 @ 拼到开头</span>
            <span>$alias</span> = '@' . <span>$alias</span><span>;
        }
        </span><span>//</span><span> 获取 / 在 $alias 中首次出现的位置</span>
        <span>$pos</span> = <span>strpos</span>(<span>$alias</span>, '/'<span>);
        </span><span>//</span><span> 如果 / 不存在,$root 就是整个 $alias,否则就是 $alias 中 / 前的内容</span>
        <span>$root</span> = <span>$pos</span> === <span>false</span> ? <span>$alias</span> : <span>substr</span>(<span>$alias</span>, 0, <span>$pos</span><span>);
        </span><span>if</span> (<span>$path</span> !== <span>null</span><span>) {
            </span><span>//</span><span> 如果 $path 以 @ 开头,使用 getAlias 去获取路径,否则,就去除掉最右边的 /</span>
            <span>$path</span> = <span>strncmp</span>(<span>$path</span>, '@', 1) ? <span>rtrim</span>(<span>$path</span>, '\/') : <span>static</span>::getAlias(<span>$path</span><span>);
            </span><span>if</span> (!<span>isset</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>])) {
                </span><span>//</span><span> 如果不存在这个 $root 的别名</span>
                <span>if</span> (<span>$pos</span> === <span>false</span><span>) {
                    </span><span>//</span><span> 没有 /,就将 $path 直接赋值以为 $root 别名对应的路径</span>
                    <span>static</span>::<span>$aliases</span>[<span>$root</span>] = <span>$path</span><span>;
                } </span><span>else</span><span> {
                    </span><span>//</span><span> 否则,就将 $path 直接赋值为 $root 下的 $alias 的路径</span>
                    <span>static</span>::<span>$aliases</span>[<span>$root</span>] = [<span>$alias</span> => <span>$path</span><span>];
                }
            } </span><span>elseif</span> (<span>is_string</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>])) {
                </span><span>//</span><span> 如果存在,而且是个string类型</span>
                <span>if</span> (<span>$pos</span> === <span>false</span><span>) {
                    </span><span>//</span><span> 没有 /,意味着 $alias 就是 $root,直接覆盖即可</span>
                    <span>static</span>::<span>$aliases</span>[<span>$root</span>] = <span>$path</span><span>;
                } </span><span>else</span><span> {
                    </span><span>//</span><span> 否则,就合并到一起</span>
                    <span>static</span>::<span>$aliases</span>[<span>$root</span>] =<span> [
                        </span><span>$alias</span> => <span>$path</span>,
                        <span>$root</span> => <span>static</span>::<span>$aliases</span>[<span>$root</span>],<span>
                    ];
                }
            } </span><span>else</span><span> {
                </span><span>//</span><span> 这种,正常是个 array 类型
                // 直接添加进去即可</span>
                <span>static</span>::<span>$aliases</span>[<span>$root</span>][<span>$alias</span>] = <span>$path</span><span>;
                </span><span>//</span><span> krsort — 对数组按照键名逆向排序<br>          // 可以做到优先匹配长的别名</span>
                <span>krsort</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>]);
            }
        } </span><span>elseif</span> (<span>isset</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>])) {
            </span><span>//</span><span> $path 为空且对应的别名有值存在,就是要移除相应的别名</span>
            <span>if</span> (<span>is_array</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>])) {
                </span><span>//</span><span> 如果 $root 的别名对应一个 array,就只移除掉对应的别名即可</span>
                <span>unset</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span>][<span>$alias</span><span>]);
            } </span><span>elseif</span> (<span>$pos</span> === <span>false</span><span>) {
                </span><span>//</span><span> 如果 $root 的别名对应不是一个 array 而且 $root 就是 $alias,就移除这个 $root 的别名</span>
                <span>unset</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>]);
            }
        }
    }</span>

下面举几个例子来说明,别名写入后,$aliases 中的内容变化。

<span>//</span><span> 初始 BaseYii::aliases['@foo'] = 'path/to/foo'</span>
Yii::setAlias('@foo', 'path/to/foo'<span>);

</span><span>//</span><span> 直接覆盖 BaseYii::aliases['@foo'] = 'path/to/foo2'</span>
Yii::setAlias('@foo', 'path/to/foo2'<span>);

</span><span>/*</span><span>*
* 新增
* BaseYii::aliases['@foo'] = [
*     '@foo/bar' => 'path/to/foo/bar',
*     '@foo' => 'path/to/foo2',
* ];
</span><span>*/</span><span>
Yii</span>::setAlias('@foo/bar', 'path/to/foo/bar'<span>);

</span><span>//</span><span> 初始 BaseYii::aliases['@bar'] = ['@bar/qux' => 'path/to/bar/qux'];</span>
Yii::setAlias('@bar/qux', 'path/to/bar/qux'<span>);

</span><span>//</span><span> 直接覆盖 BaseYii::aliases['@bar'] = ['@bar/qux' => 'path/to/bar/qux2'];</span>
Yii::setAlias('@bar/qux', 'path/to/bar/qux2'<span>);

</span><span>/*</span><span>*
* 新增
* BaseYii::aliases['@bar'] = [
*     '@bar/foo' => 'path/to/bar/foo',
*     '@bar/qux' => 'path/to/bar/qux2',
* ];
</span><span>*/</span><span>
Yii</span>::setAlias('@bar/foo', 'path/to/bar/foo'<span>);

</span><span>/*</span><span>*
* 新增
* BaseYii::aliases['@bar'] = [
*     '@bar/foo' => 'path/to/bar/foo',
*     '@bar/qux' => 'path/to/bar/qux2',
*     '@bar' => 'path/to/bar',
* ];
</span><span>*/</span><span>
Yii</span>::setAlias('@bar', 'path/to/bar'<span>);

</span><span>/*</span><span>*
* 删除
* BaseYii::aliases['@bar'] = [
*     '@bar/foo' => 'path/to/bar/foo',
*     '@bar' => 'path/to/bar',
* ];
</span><span>*/</span><span>
Yii</span>::setAlias('@bar/qux', <span>null</span><span>);

</span><span>/*</span><span>*
* 删除
* BaseYii::aliases['@bar'] = [
*     '@bar/foo' => 'path/to/bar/foo',
* ];
</span><span>*/</span><span>
Yii</span>::setAlias('@bar', <span>null</span>);

再来看一下 getAlias 方法,其内容如下:

    <span>/*</span><span>*
     * Translates a path alias into an actual path.
     * 将别名转化为真实的路径
     *
     * The translation is done according to the following procedure:
     *
     * 1. If the given alias does not start with '@', it is returned back without change;
     * 2. Otherwise, look for the longest registered alias that matches the beginning part
     *    of the given alias. If it exists, replace the matching part of the given alias with
     *    the corresponding registered path.
     * 3. Throw an exception or return false, depending on the `$throwException` parameter.
     *
     * For example, by default '@yii' is registered as the alias to the Yii framework directory,
     * say '/path/to/yii'. The alias '@yii/web' would then be translated into '/path/to/yii/web'.
     *
     * If you have registered two aliases '@foo' and '@foo/bar'. Then translating '@foo/bar/config'
     * would replace the part '@foo/bar' (instead of '@foo') with the corresponding registered path.
     * This is because the longest alias takes precedence.
     *
     * However, if the alias to be translated is '@foo/barbar/config', then '@foo' will be replaced
     * instead of '@foo/bar', because '/' serves as the boundary character.
     *
     * Note, this method does not check if the returned path exists or not.
     *
     * @param string $alias the alias to be translated.
     * @param boolean $throwException whether to throw an exception if the given alias is invalid.
     * If this is false and an invalid alias is given, false will be returned by this method.
     * @return string|boolean the path corresponding to the alias, false if the root alias is not previously registered.
     * @throws InvalidParamException if the alias is invalid while $throwException is true.
     * @see setAlias()
     </span><span>*/</span>
    <span>public</span> <span>static</span> <span>function</span> getAlias(<span>$alias</span>, <span>$throwException</span> = <span>true</span><span>)
    {
        </span><span>/*</span><span>*
         * strncmp — 二进制安全比较字符串开头的若干个字符
         * int strncmp ( string $str1 , string $str2 , int $len )
         * 如果 $alias 不是以 '@' 开头的,就不是一个 Yii 的别名
         </span><span>*/</span>
        <span>if</span> (<span>strncmp</span>(<span>$alias</span>, '@', 1<span>)) {
            </span><span>//</span><span> not an alias</span>
            <span>return</span> <span>$alias</span><span>;
        }

        </span><span>//</span><span> 获取 / 在 $alias 中首次出现的位置</span>
        <span>$pos</span> = <span>strpos</span>(<span>$alias</span>, '/'<span>);
        </span><span>//</span><span> 如果 / 不存在,$root 就是整个 $alias,否则就是 $alias 中 / 前的内容</span>
        <span>$root</span> = <span>$pos</span> === <span>false</span> ? <span>$alias</span> : <span>substr</span>(<span>$alias</span>, 0, <span>$pos</span><span>);

        </span><span>//</span><span> 如果存在 $root 的别名</span>
        <span>if</span> (<span>isset</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>])) {
            </span><span>if</span> (<span>is_string</span>(<span>static</span>::<span>$aliases</span>[<span>$root</span><span>])) {
                </span><span>//</span><span> 如果 $root 对应的别名是一个字符串,之直接返回 $aliases[$root] 或者 $aliases[$root] . substr($alias, $pos)
                // 当 $root 就是 $alias 返回 $aliases[$root], 否则就在拼接上 $alias 除去 $root 后,剩下的字符串</span>
                <span>return</span> <span>$pos</span> === <span>false</span> ? <span>static</span>::<span>$aliases</span>[<span>$root</span>] : <span>static</span>::<span>$aliases</span>[<span>$root</span>] . <span>substr</span>(<span>$alias</span>, <span>$pos</span><span>);
            } </span><span>else</span><span> {
                </span><span>//</span><span> 否则,要遍历整个 $aliases[$root] 数组,找到 $name 与 $alias 相同的值,返回 $path . substr($alias, strlen($name))
                // 其实是返回了 $path 拼接上 $alias 除去 $root 后,剩下的字符串</span>
                <span>foreach</span> (<span>static</span>::<span>$aliases</span>[<span>$root</span>] <span>as</span> <span>$name</span> => <span>$path</span><span>) {
                    </span><span>if</span> (<span>strpos</span>(<span>$alias</span> . '/', <span>$name</span> . '/') === 0<span>) {
                        </span><span>return</span> <span>$path</span> . <span>substr</span>(<span>$alias</span>, <span>strlen</span>(<span>$name</span><span>));
                    }
                }
            }
        }

        </span><span>if</span> (<span>$throwException</span><span>) {
            </span><span>throw</span> <span>new</span> InvalidParamException("Invalid path alias: <span>$alias</span>"<span>);
        } </span><span>else</span><span> {
            </span><span>return</span> <span>false</span><span>;
        }
    }</span>

好了,关于别名就先说这么多~~

 

对 Yii2 源码有兴趣的同学可以关注项目 yii2-2.0.3-annotated,现在在上面已经添加了不少关于 Yii2 源码的注释,之后还会继续添加~

有兴趣的同学也可以参与进来,提交 Yii2 源码的注释。

 

www.bkjia.comtruehttp://www.bkjia.com/PHPjc/1063510.htmlTechArticleYii2的深入学习--别名(Aliases),yii2aliases 在之前自动加载机制的文章中,我们有提到别名,提到getAlias 方法,大家当时可能不太清楚,这到...

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

463

2026.02.13

微博网页版主页入口与登录指南_官方网页端快速访问方法
微博网页版主页入口与登录指南_官方网页端快速访问方法

本专题系统整理微博网页版官方入口及网页端登录方式,涵盖首页直达地址、账号登录流程与常见访问问题说明,帮助用户快速找到微博官网主页,实现便捷、安全的网页端登录与内容浏览体验。

135

2026.02.13

Flutter跨平台开发与状态管理实战
Flutter跨平台开发与状态管理实战

本专题围绕Flutter框架展开,系统讲解跨平台UI构建原理与状态管理方案。内容涵盖Widget生命周期、路由管理、Provider与Bloc状态管理模式、网络请求封装及性能优化技巧。通过实战项目演示,帮助开发者构建流畅、可维护的跨平台移动应用。

64

2026.02.13

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

20

2026.02.13

Redis高可用架构与分布式缓存实战
Redis高可用架构与分布式缓存实战

本专题围绕 Redis 在高并发系统中的应用展开,系统讲解主从复制、哨兵机制、Cluster 集群模式及数据分片原理。内容涵盖缓存穿透与雪崩解决方案、分布式锁实现、热点数据优化及持久化策略。通过真实业务场景演示,帮助开发者构建高可用、可扩展的分布式缓存系统。

26

2026.02.13

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

29

2026.02.12

雨课堂网页版登录入口与使用指南_官方在线教学平台访问方法
雨课堂网页版登录入口与使用指南_官方在线教学平台访问方法

本专题系统整理雨课堂网页版官方入口及在线登录方式,涵盖账号登录流程、官方直连入口及平台访问方法说明,帮助师生用户快速进入雨课堂在线教学平台,实现便捷、高效的课程学习与教学管理体验。

14

2026.02.12

豆包AI网页版入口与智能创作指南_官方在线写作与图片生成使用方法
豆包AI网页版入口与智能创作指南_官方在线写作与图片生成使用方法

本专题汇总豆包AI官方网页版入口及在线使用方式,涵盖智能写作工具、图片生成体验入口和官网登录方法,帮助用户快速直达豆包AI平台,高效完成文本创作与AI生图任务,实现便捷智能创作体验。

524

2026.02.12

PostgreSQL性能优化与索引调优实战
PostgreSQL性能优化与索引调优实战

本专题面向后端开发与数据库工程师,深入讲解 PostgreSQL 查询优化原理与索引机制。内容包括执行计划分析、常见索引类型对比、慢查询优化策略、事务隔离级别以及高并发场景下的性能调优技巧。通过实战案例解析,帮助开发者提升数据库响应速度与系统稳定性。

53

2026.02.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CSS3 教程
CSS3 教程

共18课时 | 5.7万人学习

Vue 教程
Vue 教程

共42课时 | 8.6万人学习

PostgreSQL 教程
PostgreSQL 教程

共48课时 | 9.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号