laravel框架源码分析（一）自动加载

一、前言

　　使用php已有好几年，laravel的使用也是有好长时间，但是一直对于框架源码的理解不深，原因很多，归根到底还是php基础不扎实，所以源码看起来也比较吃力。最近有时间，所以开启第5、6遍的框架源码探索之旅，前面几次都是看了一些就放弃，希望这次能够看完。每一次看源码都会有新的收获，因为框架用到的一些设计模式、高级特性，在平时的业务需求里面根本用不到，或者说项目前期就把需要用到高级特性的地方都做好了，业务需求也就用到mvc。

　　本文及后续的“laravel框架源码分析“文章都是基于laravel框架5.7.16版本。“自动加载”是laravel框架启动后做的第一件事，这里要求对__autolad()、spl_autoload()、spl_autoload_register()等方法至少有初步了解。

二、自动加载的分析

1、先看下框架入口文件index.php：

<?php

define('LARAVEL_START', microtime(true));

require __DIR__.'/../vendor/autoload.php';

... ... 

2、require 加载 autoload.php文件：

<?php

require_once __DIR__ . '/composer/autoload_real.php';

return ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3::getLoader();

【备注】：

1）ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3 这个类是在 autoload_real.php 文件中定义的

2）ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3 这个类名是由 ComposerAutoloaderInit 加上哈希值组成，如果你在你的项目中打开这个文件，你会看到你文件中这个哈希值跟我这里的不一样，这个是正常的。

参考了网上的资料，这么做可能原因是：如果直接用ComposerAutoloaderInit，因为是全局的一个类，怕会被开发人员自己写的一个同名的类给覆盖导致报错。这是从网上查来的信息，也不确定是不是就是这个原因，这里可以不需要深究。

3、来看下 autoload_real.php 文件：

<?php

// autoload_real.php @generated by Composer

class ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3
{
    private static $loader;

    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }

    public static function getLoader()
    {
        /*
         * 加载器最开始是null，后面实例化后是一个静态变量会一直存在
         */
        if (null !== self::$loader) {
            return self::$loader;
        }

        /*
         * 注册一个自动加载函数，就是本类钟的 loadClassLoader 方法
         * 第二个参数为true表示注册失败的时候会抛出异常
         * 第三个参数为true表示该自动加载函数是加入到队列的头部，自动加载函数是有很多的，可以认为是一个队列，默认false值是往队尾添加
         * 加载类的时候，会先从队头的自动加载函数去寻找类和实例化，这里是true，就是作为第一个去执行的自动加载函数。
         */
        spl_autoload_register(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'), true, true);

        /*
         * 当前文件中并没有require下面这个ClassLoader类，那么就刚好用到上面注册的一个自动加载函数
         * 相当于是 require __DIR__ . '/ClassLoader.php'
         */
        self::$loader = $loader = new \Composer\Autoload\ClassLoader();

        /*
         * 注释掉刚刚注册的自动加载函数，因为这个自动加载函数只是对上面new的这个类有用。意思是当前类的自动加载函数对其他类不起作用，所以没必要一直放在队列中
         */
        spl_autoload_unregister(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'));

        /*
         * PHP_VERSION_ID 版本号，可以使用php artisan -V命令查看，当前版本是5.7.16
         * HHVM_VERSION 是Facebook 的一个为php提高性能的一个开源项目，参考http://fex.baidu.com/blog/2014/03/hvvm-and-php
         * zend_loader_file_encoded 不清楚是啥东西
         *
         * $useStaticLoader 这个为true的话，是直接就加载autoload_static.php文件，然后返回预定义的变量的值，比如files信息，后续要预加载
         * 为false的话，会加载几个php文件，加载后的结果和直接加载autoload_statis.php的效果应该是一样的
         * 就是说如果有autoload_static.php文件，直接加载就好了，会更加快速
         * $useStaticLoader 就是根据条件来判断是要静态加载还是普通加载。两者的结果是一致的。
         */
        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
        if ($useStaticLoader) {
            // 静态加载
            require_once __DIR__ . '/autoload_static.php';
            /**
             * 返回files等信息，是在ClassLoader.php中定义的属性的值
             */
            call_user_func(\Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::getInitializer($loader));
        } else {
            $map = require __DIR__ . '/autoload_namespaces.php';
            foreach ($map as $namespace => $path) {
                $loader->set($namespace, $path);
            }

            $map = require __DIR__ . '/autoload_psr4.php';
            foreach ($map as $namespace => $path) {
                $loader->setPsr4($namespace, $path);
            }

            $classMap = require __DIR__ . '/autoload_classmap.php';
            if ($classMap) {
                $loader->addClassMap($classMap);
            }
        }

        /*
         * 预加载loader
         */
        $loader->register(true);

        /*
         * 要预加载的文件
         */
        if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file);
        }

        return $loader;
    }
}

/*
 * 预加载文件
 */
function composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;

        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
    }
}

【备注】我在上面加了我的理解，源代码里面是没这些中文注释的。

【说明】：

1）在上面第2点里面是return 类名::getLoader()，所以我们来看这个getLoader()方法

if (null !== self::$loader) {
	return self::$loader;
}

这里是先判断$loader静态变量是否已经设置了，如果设置了的话，直接就返回了，不往下处理。一开始这个变量是null，所以会往下执行。

2）注册自动加载函数

spl_autoload_register(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'), true, true);

这一行代码的意思是注册一个自动加载函数，并且放在注册函数队列的第一位，如果注册失败则抛出异常。这里如果不能理解，请看下spl_autoload_register相关方法。

注册的自动加载函数是array里面的，也就是当前类里面的 loadClassLoader 方法：

    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }　　

这里的意思是如果new一个类的时候，找不到类定义的文件，那么会在autoload函数队列里面去找，比如这里刚刚把loadClassLoader方法注册为自动加载函数，而且是第一位。

3）实例化loader

self::$loader = $loader = new \Composer\Autoload\ClassLoader();

spl_autoload_unregister(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'));

第一行代码是new一个类，因为当前文件并没有直接require或者include，就是没有加载该类的定义文件，所以找不到该类，这个时候就从自动加载函数里面去加载，看能否加载该类。

因为loadClassLoader这个自动加载函数是在队列的第一位，所以先执行这个自动加载函数。从上面的代码看出，实际上就是 require __DIR__ . '/ClassLoader.php';

但是为何搞这么复杂，不直接require，而是要通过注册自动加载函数呢？ 这个原因后续再说。

那么第一行的意思就是require一个文件，第二行代码是注销掉刚刚注册的这个自动加载函数，因为这个自动加载函数只对本来有效，其他类不会用到，所以没有必要一直放在队列里。

4）判断是静态加载文件还是普通加载：

        /*
         * PHP_VERSION_ID 版本号，可以使用php artisan -V命令查看，当前版本是5.7.16
         * HHVM_VERSION 是Facebook 的一个为php提高性能的一个开源项目，参考http://fex.baidu.com/blog/2014/03/hvvm-and-php
         * zend_loader_file_encoded 不清楚是啥东西
         *
         * $useStaticLoader 这个为true的话，是直接就加载autoload_static.php文件，然后返回预定义的变量的值，比如files信息，后续要预加载
         * 为false的话，会加载几个php文件，加载后的结果和直接加载autoload_statis.php的效果应该是一样的
         * 就是说如果有autoload_static.php文件，直接加载就好了，会更加快速
         * $useStaticLoader 就是根据条件来判断是要静态加载还是普通加载。两者的结果是一致的。
         */
        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());　　

这里是各种条件的判断，$useStaticLoader为true则是静态加载，为false则是普通加载。

5）静态加载

require_once __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::getInitializer($loader));　　

首先是加载autoload_static.php文件，然后调用该文件定义的类的getInitializer方法，并且把刚刚实例化的$loader作为参数传递过去。

来看下这个getInitializer方法：

    public static function getInitializer(ClassLoader $loader)
    {
        /*
         * Closure::bind 绑定一个匿名函数到一个对象，参考：http://php.net/manual/zh/closure.bind.php
         * Closure::bind 这个方法返回值就是绑定的这个匿名函数。这里$loader是ClassLoader的一个实例
         * 为何以这种方式来设置$loader的属性呢？原因是这几个属性都是private，而现在把匿名函数（bind中定义的匿名函数）绑定到
         * ClassLoader类，也就是$loader的一个方法，那么就可以直接设置内部私有的属性（成员变量）
         * 可以这么理解：
         * 1）function A(ClassLoader $loader)
         * {
         *      $loader->属性 = ....
         * }
         * 2) 绑定function A 到 ClassLoader类
         * 3) return A(); 那么也就是这个时候，把$loader的各个成员属性的值都设置了
         */
        return \Closure::bind(function () use ($loader) {
            $loader->prefixLengthsPsr4 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$prefixLengthsPsr4;
            $loader->prefixDirsPsr4 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$prefixDirsPsr4;
            $loader->fallbackDirsPsr4 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$fallbackDirsPsr4;
            $loader->prefixesPsr0 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$prefixesPsr0;
            $loader->classMap = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$classMap;
        }, null, ClassLoader::class);
    }　　

这里的意思是把autoload_static.php文件中定义好的一些变量赋值给$loader对象。

6）普通加载

普通加载和静态加载的过程不一样，但是结果是一样的，都是设置$loader的成员属性。就不细说了。

7）预加载loader【重点】

$loader->register(true);　　

这个register的代码：

    public function register($prepend = false)
    {
        spl_autoload_register(array($this, 'loadClass'), true, $prepend);
    }　　

这里是注册自动加载函数，loadClass方法：

    public function loadClass($class)
    {
        if ($file = $this->findFile($class)) {
            includeFile($file);

            return true;
        }
    }　　

这个自动加载函数的功能就是去查找文件并且include文件。就不往下细说了。

【备注】：

这里是最重要的一个地方，以后所有new 一个类，或者需要加载类但是没有require的时候，就会去调用这个自动加载函数然后include对应文件。

8）设置要加载的文件

　　　　　if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }　　

这里是把要加载的文件放入$includeFiles变量

9）加载文件

foreach ($includeFiles as $fileIdentifier => $file) {
     composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file);
}

/*
 * 预加载文件
 */
function composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;

        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
    }
}

可以看到这里就是去require文件。

三、小结

在框架启动后，会去设置自动加载函数，而且预加载了部分指定要加载的文件。自动加载的好处是不需要到处去require文件，用到的时候再require。另外就是如果类依赖其他类过多，每次都要require，也不好维护。

关于自动加载函数的说明先讲到这里，后续会有用到的地方再做解释，先埋个伏笔。