Yii2设置别名函数（setAlias）和获取别名函数（getAlias）

首先说说什么是别名。

在Yii中有很多的路径，在开发的过程当前我们也会使用一些路径。一般来说都需要使用绝对路径，但绝对路径都很长。
所以，为了方便的使用路径，可以在Yi中i给每个路径起个名称，这个名称就是别名。

别名的格式：

• 别名必须以“@”字符开头，别名中还可以包含“/”。如（"@www"为根别名，"@www/test"就为子别名）
• 别名最后的目录分隔符（“\”或者“/”）都将去掉（如果有的情况下）
  

别名的路径有以下几个格式

• 目录路径或者文件的路径（`/tmp`, `/tmp/main.txt`）
• URL（`http://www.yii2.com`）
• 另一个别名路径（`@yii/base`），这样会调用getAlias()，解析里面的别名。
  

设置别名

1. Yii::setAlias("@www", "C:\www\");
   
2. Yii::setAlias("@data", "C:\www\data");
   
3. Yii::setAlias("@data/attach", "C:\www\data\attach\icon.png");
   
4. Yii::setAlias("@home", "www.yiifans.com\");
   
5. Yii::setAlias("@admin", "@www\admin");

设置别名的时候，如果路径里面包含别名那么会调用 getAlias()，解析里面的别名。
如：别名 @yii 对应的路径为 /xxx/yii，那么 @yii/base将会解析为 /xxx/yii/base

获取别名

获取别名路径的时候按如下顺序来：

• 如果别名不以"@"开头，直接返回别名，不作处理
• 查找相匹配的最长的别名，然后用别名路径来替换传入的参数中的别名。
  

如设置了两个别名 “@foo”=>"my"和 “@foo/test”=>"my/test"。

• 如果用@foo/test/config来获取对应的路径，结果为"my/test/config"
• 如果用@foo/testtst/config来获取对应的路径，结果为"my/testtst/config"
• 如果用@foo/config来获取对应的路径，结果为"my/config"
  

即在匹配的时候会以 “/”作为分隔符， 先匹配最长的别名。

上面设置的别名的结果分别为：

1. Yii::getAlias("@www");
   
2. //输出：C:\www
   
3. 
   
4. Yii::getAlias("@data");
   
5. //输出：C:\www\data
   
6. 
   
7. Yii::getAlias("@data/attach");
   
8. //输出：C:\www\data\attach\icon.png
   
9. 
   
10. Yii::getAlias("@home");
    
11. //输出：www.yiifans.com
    
12. 
    
13. Yii::getAlias("@admin");
    
14. //输出：C:\www\admin

设置别名函数源码：setAlias

1. public static function setAlias($alias, $path)
   
2. {
   
3.         if (strncmp($alias, '@', 1)) {
   
4.                 //如果不是@开头，则自动在前面加上@
   
5.                 $alias = '@' . $alias;
   
6.         }
   
7.         //查找别名中的“/”
   
8.         $pos = strpos($alias, '/');
   
9.         //如果别名中没有“/”，则根别名就是所输入的别名，否则从截取“/”前面的作为根别名
   
10.         //如：@www，根别名就为@www；
    
11.         //如:@www/data，那么根别名截取为@www。
    
12.         $root = $pos === false ? $alias : substr($alias, 0, $pos);
    
13.         if ($path !== null) {
    
14.                 /*
    
15.                  * 如果路径中包含有别名，另直接调用getAlias来解析得到路径。
    
16.                  * 否则去掉结尾的“/”、“\”
    
17.                  */
    
18.                 $path = strncmp($path, '@', 1) ? rtrim($path, '\\/') : static::getAlias($path);
    
19.                 if (!isset(static::$aliases[$root])) {
    
20.                         /*
    
21.                          * 如果还没有设置过这个根别名（@www）
    
22.                          *
    
23.                          * 如果别名就是根别名（参数就是@www），则直接设置别名对应的路径（['@www'=>'路径']）
    
24.                          * 否则生成路径为一个数组(['@www'=>['@www/data'=>'路径'])
    
25.                          *
    
26.                          * @www                        ['@www'=>'xxxx']
    
27.                          * @www/a                      ['@www'=>['@www/a'=>xxxa]]        
    
28.                          * @www/b                      ['@www'=>['@www/b'=>xxxb]]        
    
29.                          * @www/a/b                    ['@www'=>['@www/a/b'=>xxxc]]        
    
30.                          *
    
31.                          * 注：上面的这4中只会注册其中的一个，因为在上面判断了有没有注册@www
    
32.                          */
    
33.                         if ($pos === false) {
    
34.                                 static::$aliases[$root] = $path;
    
35.                         } else {
    
36.                                 static::$aliases[$root] = [$alias => $path];
    
37.                         }
    
38.                 } elseif (is_string(static::$aliases[$root])) {
    
39.                         /*
    
40.                          * 注册过根别名（只有注册过根别名，对应的值才会是字符串）
    
41.                          *
    
42.                          * 如果当前注册的是根别名，直接覆盖旧值。
    
43.                          * ['@www']=xxx
    
44.                          *
    
45.                          * 否则把当前别名和根别名添加到根别名数组中
    
46.                          * @www/a                ['@www']=['@www/a'=>xxxa,'@www'=>'xxx']
    
47.                          *
    
48.                          */
    
49.                         if ($pos === false) {
    
50.                                 static::$aliases[$root] = $path;
    
51.                         } else {
    
52.                                 static::$aliases[$root] = [
    
53.                                         $alias => $path,
    
54.                                         $root => static::$aliases[$root],
    
55.                                 ];
    
56.                         }
    
57.                 } else {
    
58.                         //添加到根别名的数组中
    
59.                         static::$aliases[$root][$alias] = $path;
    
60.                         krsort(static::$aliases[$root]);
    
61.                 }
    
62.         } elseif (isset(static::$aliases[$root])) {
    
63.                 //如果是根别名数组，删除子别名。
    
64.                 if (is_array(static::$aliases[$root])) {
    
65.                         unset(static::$aliases[$root][$alias]);
    
66.                 } elseif ($pos === false) {
    
67.                         //删除整个根别名数组
    
68.                         unset(static::$aliases[$root]);
    
69.                 }
    
70.         }
    
71. }

例如：

• @www=>xxx                ['@www']=xxx
• @www=>yyy                ['@www']=yyy
• @www/a=>yyya           ['@www']=['@www/a'=>yyya,'@www'=>yyy]
• @www/b=yyyb             ['@www']=['@www/a'=>yyya,'@www'=>yyy,'@www/b'=>yyyb]
  

也就是说，会把所有的相同根别名的数据，放到一个以根别名为键的数组中，而且对键进行逆向排序

获取别名函数源码:getAlias

1. public static function getAlias($alias, $throwException = true)
   
2. {
   
3.         //如果不是为@开头，直接返回alias
   
4.         if (strncmp($alias, '@', 1)) {
   
5.                 // not an alias
   
6.                 return $alias;
   
7.         }
   
8. 
   
9.         //获取根别名，和setAlias相同
   
10.         $pos = strpos($alias, '/');
    
11.         $root = $pos === false ? $alias : substr($alias, 0, $pos);
    
12. 
    
13.         if (isset(static::$aliases[$root])) {
    
14.                 //如果根别名的值为字符串，即只设置了一个根别名（['@www'=>xxx]）
    
15.                 if (is_string(static::$aliases[$root])) {
    
16.                         /*
    
17.                          * 如果获取的名称为根别名，直接返回根别名对应的路径，
    
18.                          * 否则返回值为根别名路径+去掉别名之后的路径
    
19.                          *
    
20.                          * 如：
    
21.                          * @www,直接返回 xxx
    
22.                          * @www/aaa/bbb 返回xxx/aaa/bbb
    
23.                          */
    
24.                         return $pos === false ? static::$aliases[$root] : static::$aliases[$root] . substr($alias, $pos);
    
25.                 } else {
    
26.                         
    
27.                         /* 遍历子别名
    
28.                          *
    
29.                          * @www=>xxx                ['@www']=xxx
    
30.                          * @www=>yyy                ['@www']=yyy
    
31.                          * @www/a=>yyya             ['@www']=['@www/a'=>yyya,'@www'=>yyy]
    
32.                          * @www/b=>yyyb             ['@www']=['@www/a'=>yyya,'@www/b'=>yyyb,'@www'=>yyy]
    
33.                          * @www/a/c=>yyyac          ['@www']=['@www/a/c'=>yyyac,'@www/a'=>yyya,'@www/b'=>yyyb,'@www'=>yyy]
    
34.                          */
    
35.                         foreach (static::$aliases[$root] as $name => $path) {
    
36.                                 /*
    
37.                                  * 在这里，因为根别名的所有子别名都根据键也就是子别名进行了逆向排序
    
38.                                  * 所以在查找的时候总是先匹配最长的别名。
    
39.                                  *
    
40.                                  * 又因为在比较的时候给别名后面加了“/”，所以可以保证在查找的时候能以“/”作为分隔符。
    
41.                                  */
    
42.                                 if (strpos($alias . '/', $name . '/') === 0) {
    
43.                                         return $path . substr($alias, strlen($name));
    
44.                                 }
    
45.                         }
    
46.                 }
    
47.         }
    
48. 
    
49.         if ($throwException) {
    
50.                 throw new InvalidParamException("Invalid path alias: $alias");
    
51.         } else {
    
52.                 return false;
    
53.         }
    
54. }