Yii2框架自动加载机制学习

Yii2 的自动加载分两部分，一部分是 Composer 的自动加载机制，另一部分是 Yii2 框架自身的自动加载机制。

Composer自动加载

对于库的自动加载信息，Composer 生成了一个 vendor/autoload.php 文件。你可以简单的引入这个文件，你会得到一个自动加载的支持。

在之前的文章，入口文件的介绍中，我们可以看到如下内容：

// 引入 vendor 中的 autoload.php 文件，会基于 composer 的机制自动加载类
require(__DIR__ . '/../vendor/autoload.php');

因为这个系列主要是关于 Yii2 的，所以有关 Composer 自动加载机制就不在这里详细说明了。

可查阅资料：

    Composer 自动加载
    Composer 自动加载-参考
    Composer 中文官网

Yii2 框架的自动加载机制

Yii2 框架的自动加载是通过 spl_autoload_register 方法实现的。

在之前的文章，入口文件的介绍中，我们可以看到如下内容：

// 引入 Yii 框架的文件 Yii.php
require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

Yii.php 里究竟是什么内容？如何实现了自动加载？

下面我们来看一下，Yii.php 的内容如下：

iframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */
require(__DIR__ . '/BaseYii.php');
/**
 * Yii is a helper class serving common framework functionalities.
 *
 * It extends from [[yiiBaseYii]] which provides the actual implementation.
 * By writing your own Yii class, you can customize some functionalities of [[yiiBaseYii]].
 *
 * @author Qiang Xue 
 * @since 2.0
 */
class Yii extends yiiBaseYii
{
}
/**
 * spl_autoload_register ― 注册给定的函数作为 __autoload 的实现
 *
 * bool spl_autoload_register ([ callable $autoload_function [, bool $throw = true [, bool $prepend = false ]]] )
 *
 * 将函数注册到SPL __autoload函数队列中。如果该队列中的函数尚未激活，则激活它们。
 * 如果在你的程序中已经实现了__autoload()函数，它必须显式注册到__autoload()队列中。
 * 因为 spl_autoload_register()函数会将Zend Engine中的__autoload()函数取代为spl_autoload()或spl_autoload_call()。
 * 如果需要多条 autoload 函数，spl_autoload_register() 满足了此类需求。
 * 它实际上创建了 autoload 函数的队列，按定义时的顺序逐个执行。
 * 相比之下， __autoload() 只可以定义一次。
 *
 * autoload_function
 * 欲注册的自动装载函数。如果没有提供任何参数，则自动注册 autoload 的默认实现函数spl_autoload()。
 *
 * throw
 * 此参数设置了 autoload_function 无法成功注册时， spl_autoload_register()是否抛出异常。
 *
 * prepend
 * 如果是 true，spl_autoload_register() 会添加函数到队列之首，而不是队列尾部。
 *
 * Yii 注册了 Yii 的 autoload 函数，实现自动加载, 其实现在 yiiBaseYii 中
 */
spl_autoload_register(['Yii', 'autoload'], true, true);
// 定义 Yii 核心的 class 的类名与文件地址的 Map
Yii::$classMap = require(__DIR__ . '/classes.php');
// 创建 Yii 的依赖注入的容器
Yii::$container = new yiidiContainer();

其主要内容就是引入了 BaseYii.php 文件，然后声明了类 Yii，继承了 BaseYii，然后注册了 Yii （其实是 BaseYii）的 autoload 方法，去实现自动加载。之后又引入了Yii 核心类名与文件地址一一对应的 Map，存储到 Yii::$classMap 中。最后创建了一个 yiidiContainer 的实例，存储到 Yii::$container 中。

可以看出实现自动加载的关键代码是：

spl_autoload_register(['Yii', 'autoload'], true, true);

下面我们来看一下 BaseYii 中 autoload 方法的实现，其内容如下：

    /**
     * Class autoload loader.
     * This method is invoked automatically when PHP sees an unknown class.
     * The method will attempt to include the class file according to the following procedure:
     *
     * 1. Search in [[classMap]];
     * 2. If the class is namespaced (e.g. `yiibaseComponent`), it will attempt
     *    to include the file associated with the corresponding path alias
     *    (e.g. `@yii/base/Component.php`);
     *
     * This autoloader allows loading classes that follow the [PSR-4 standard](http://www.php-fig.org/psr/psr-4/)
     * and have its top-level namespace or sub-namespaces defined as path aliases.
     *
     * Example: When aliases `@yii` and `@yii/bootstrap` are defined, classes in the `yiibootstrap` namespace
     * will be loaded using the `@yii/bootstrap` alias which points to the directory where bootstrap extension
     * files are installed and all classes from other `yii` namespaces will be loaded from the yii framework directory.
     *
     * Also the [guide section on autoloading](guide:concept-autoloading).
     *
     * @param string $className the fully qualified class name without a leading backslash ""
     * @throws UnknownClassException if the class does not exist in the class file
     */
    public static function autoload($className)
    {
        // 自动加载类
        if (isset(static::$classMap[$className])) {
            // 如果 $classMap 中存在该类，就直接使用
            $classFile = static::$classMap[$className];
            // 如果第一个字符串为'@'，就意味着对应的文件地址是别名，就将它转化成真实的文件地址
            if ($classFile[0] === '@') {
                $classFile = static::getAlias($classFile);
            }
        } elseif (strpos($className, '\') !== false) {
            // 如果存在'\',就意味着含有 namespace,可以拼成别名，再根据别名获取真实的文件地址
            $classFile = static::getAlias('@' . str_replace('\', '/', $className) . '.php', false);
            // 没取到真是文件地址或者获取的地址不是一个文件，就返回空
            if ($classFile === false || !is_file($classFile)) {
                return;
            }
        } else {
            return;
        }
        // 引入该类的文件
        include($classFile);
        // 如果是调试模式，而且 $className 即不是类，不是接口，也不是 trait，就抛出异常
        if (YII_DEBUG && !class_exists($className, false) && !interface_exists($className, false) && !trait_exists($className, false)) {
            throw new UnknownClassException("Unable to find '$className' in file: $classFile. Namespace missing?");
        }
    }

其中，大家可能不太清楚 getAlias 方法，这个方法其实就是将 Yii2 中的别名转化成真实的文件地址，关于该方法的具体内容，之后会详细讲解。

举几个例子，帮助大家理解一下。

如果 Yii::$classMap 的值如下：

Yii::$classMap = [
    'app/test/Test' => '/var/www/basic/webtest/Test.php'
];

当你使用 ‘app/test/Test’ 类时，就会自动引入 '/var/www/basic/webtest/Test.php' 文件，项目中的内容当然不是这个样子的，这只是个简单的例子，便于大家理解。

在继续上面的例子，如果你使用了‘yiibaseComponent’ 类，它就会转变成 ‘@yii/base/Component.php’ 别名，然后在根据别名获取到它的文件地址，引入进来。



yii 类自动加载（Autoloading）

Yii 依靠类自动加载机制来定位和包含所需的类文件。它提供一个高性能且完美支持PSR-4 标准(中文汉化)的自动加载器。该自动加载器会在引入框架文件 Yii.php 时安装好。

 使用 Yii 自动加载器

要使用 Yii 的类自动加载器，你需要在创建和命名类的时候遵循两个简单的规则：

    每个类都必须置于命名空间之下 (比如 foobarMyClass)。
    每个类都必须保存为单独文件，且其完整路径能用以下算法取得：

    // $className 是一个开头包含反斜杠的完整类名(译者注：请自行谷歌：fully qualified class name)
    $classFile = Yii::getAlias('@' . str_replace('\\', '/', $className) . '.php');

举例来说，若某个类名为 foobarMyClass，对应类的文件路径别名会是 @foo/bar/MyClass.php。为了让该别名能被正确解析为文件路径，@foo 或 @foo/bar 中的一个必须是根别名。

当我们使用基本应用模版时，可以把你的类放置在顶级命名空间 app 下，这样它们就可以被 Yii 自动加载，而无需定义一个新的别名。这是因为 @app 本身是一个预定义别名，且类似于 appcomponentsMyClass 这样的类名，基于我们刚才所提到的算法，可以正确解析出 AppBasePath/components/MyClass.php 路径。

在高级应用模版里，每一逻辑层级会使用他自己的根别名。比如，前端层会使用 @frontend 而后端层会使用@backend。因此，你可以把前端的类放在 frontend 命名空间，而后端的类放在 backend。 这样这些类就可以被 Yii 自动加载了。

类映射表(Class Map)

Yii 类自动加载器支持类映射表功能，该功能会建立一个从类的名字到类文件路径的映射。当自动加载器加载一个文件时，他首先检查映射表里有没有该类。如果有，对应的文件路径就直接加载了，省掉了进一步的检查。这让类的自动加载变得超级快。事实上所有的 Yii 核心类都是这样加载的。

你可以用 Yii::$classMap 方法向映射表中添加类，

    Yii::$classMap['foo\bar\MyClass'] = 'path/to/MyClass.php';

别名可以被用于指定类文件的路径。你应该在引导启动的过程中设置类映射表，这样映射表就可以在你使用具体类之前就准备好。

用其他自动加载器

因为 Yii 完全支持 Composer 管理依赖包，所以推荐你也同时安装 Composer 的自动加载器，如果你用了一些自带自动加载器的第三方类库，你应该也安装下它们。

当你同时使用其他自动加载器和 Yii 自动加载器时，应该在其他自动加载器安装成功之后，再包含 Yii.php 文件。这将使 Yii 成为第一个响应任何类自动加载请求的自动加载器。举例来说，以下代码提取自基本应用模版的入口脚本 。第一行安装了 Composer 的自动加载器，第二行才是 Yii 的自动加载器：

    require(__DIR__ . '/../vendor/autoload.php');
    require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

你也可以只使用 Composer 的自动加载，而不用 Yii 的自动加载。不过这样做的话，类的加载效率会下降，且你必须遵循 Composer 所设定的规则，从而让你的类满足可以被自动加载的要求。

    补充：若你不想要使用 Yii 的自动加载器，你必须创建一个你自己版本的 Yii.php 文件，并把它包含进你的入口脚本里。

自动加载扩展类

Yii 自动加载器支持自动加载扩展的类。唯一的要求是它需要在 composer.json 文件里正确地定义 autoload部分。请参考 Composer 文档(英文)(中文汉化)，来了解如何正确描述 autoload 的更多细节。

在你不使用 Yii 的自动加载器时，Composer 的自动加载器仍然可以帮你自动加载扩展内的类。