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，也不好維護。

關於自動加載函數的說明先講到這里，后續會有用到的地方再做解釋，先埋個伏筆。