别名 ¶

别名用于表示文件路径或 URL，这样您就不必在项目中硬编码绝对路径或 URL。别名必须以 @ 字符开头，以便与普通文件路径和 URL 区分。没有前导 @ 的别名将以 @ 字符为前缀。

Yii 已经预定义了许多可用的别名。例如，别名 @yii 表示 Yii 框架的安装路径；@web 表示当前运行的 Web 应用程序的基 URL。

定义别名 ¶

您可以通过调用 Yii::setAlias() 来定义文件路径或 URL 的别名。

// an alias of a file path
Yii::setAlias('@foo', '/path/to/foo');

// an alias of a URL
Yii::setAlias('@bar', 'https://www.example.com');

// an alias of a concrete file that contains a \foo\Bar class
Yii::setAlias('@foo/Bar.php', '/definitely/not/foo/Bar.php');

注意：被别名化的文件路径或 URL 可能不一定是指向现有文件或资源。

给定一个定义的别名，您可以通过追加一个斜杠 / 以及一个或多个路径段来推导出一个新的别名（无需调用 Yii::setAlias()）。通过 Yii::setAlias() 定义的别名成为根别名，而从其推导的别名称为派生别名。例如，@foo 是一个根别名，而 @foo/bar/file.php 是一个派生别名。

您可以使用另一个别名（根别名或派生别名）来定义别名。

Yii::setAlias('@foobar', '@foo/bar');

根别名通常在 引导 阶段定义。例如，您可以在 入口脚本 中调用 Yii::setAlias()。为了方便起见，应用程序 提供了一个可写属性名为 aliases，您可以在应用程序 配置 中配置它。

return [
    // ...
    'aliases' => [
        '@foo' => '/path/to/foo',
        '@bar' => 'https://www.example.com',
    ],
];

解析别名 ¶

您可以调用 Yii::getAlias() 将根别名解析为它所代表的文件路径或 URL。相同的方法也可以将派生别名解析为相应的文件路径或 URL。

echo Yii::getAlias('@foo');               // displays: /path/to/foo
echo Yii::getAlias('@bar');               // displays: https://www.example.com
echo Yii::getAlias('@foo/bar/file.php');  // displays: /path/to/foo/bar/file.php

派生别名所代表的路径/URL 是通过用其在派生别名中相应的路径/URL 替换根别名部分来确定的。

注意：Yii::getAlias() 方法不检查生成的路径/URL 是否指向现有文件或资源。

根别名也可能包含斜杠 / 字符。 Yii::getAlias() 方法足够智能，可以识别别名中哪一部分是根别名，从而正确地确定相应的文件路径或 URL。

Yii::setAlias('@foo', '/path/to/foo');
Yii::setAlias('@foo/bar', '/path2/bar');
Yii::getAlias('@foo/test/file.php');  // displays: /path/to/foo/test/file.php
Yii::getAlias('@foo/bar/file.php');   // displays: /path2/bar/file.php

如果 @foo/bar 未定义为根别名，则最后一条语句将显示 /path/to/foo/bar/file.php。

使用别名 ¶

别名在 Yii 的许多地方被识别，无需调用 Yii::getAlias() 将它们转换为路径或 URL。例如，yii\caching\FileCache::$cachePath 可以接受文件路径和代表文件路径的别名，这得益于 @ 前缀，它允许它区分文件路径和别名。

use yii\caching\FileCache;

$cache = new FileCache([
    'cachePath' => '@runtime/cache',
]);

请注意 API 文档，以查看属性或方法参数是否支持别名。

预定义别名 ¶

Yii 预定义了一组别名，以方便地引用常用的文件路径和 URL。

• @yii 是包含 BaseYii.php 文件的目录（也称为框架目录）。
• @app 是当前运行应用程序的 基本路径。
• @runtime 是当前运行应用程序的 运行时路径。默认为 @app/runtime。
• @webroot 是当前运行 Web 应用程序的 Web 根目录。它根据包含 入口脚本 的目录确定。
• @web 是当前运行 Web 应用程序的基本 URL。它与 yii\web\Request::$baseUrl 的值相同。
• @vendor 是 Composer 供应商目录。默认为 @app/vendor。
• @bower 是包含 bower 包 的根目录。默认为 @vendor/bower。
• @npm 是包含 npm 包 的根目录。默认为 @vendor/npm。

@yii 别名是在将 Yii.php 文件包含在您的 入口脚本 中时定义的。其余的别名是在应用程序构造函数中应用应用程序 配置 时定义的。

注意：@web 和 @webroot 别名如其描述所示，是在 Web 应用程序 中定义的，因此默认情况下对于 控制台应用程序 不可使用。

扩展别名 ¶

每个通过 Composer 安装的 扩展 会自动定义一个别名。每个别名都以扩展的根命名空间命名，如其 composer.json 文件中所声明，每个别名都代表包的根目录。例如，如果您安装了 yiisoft/yii2-jui 扩展，您将自动在 引导 阶段定义别名 @yii/jui，等效于

Yii::setAlias('@yii/jui', 'VendorPath/yiisoft/yii2-jui');