Composer 自動載入原始碼解析

myjob發表於2019-05-31
原始碼

1.1 先看下框架入口檔案index.php：

<?php
define('LARAVEL_START', microtime(true));
require __DIR__.'/../vendor/autoload.php';
... ...

1.2 Composer 目錄檔案

根目錄 composer/

autoload_namespaces.php 為需要載入的名稱空間字首定義路徑
autoload_classmap.php 為所有需要自動載入的類定義路徑
autoload_files.php 定義所有需要載入的配置檔案
autoload_psr4.php 根據 Psr4 規範定義名稱空間字首和路徑
autoload_static.php 包含所有需要載入的檔案、類，內容包含以上檔案
autoload_real.php 自動載入配置
ClassLoader.php 自動載入類

1.3 require 載入 autoload.php檔案：

<?php
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3::getLoader();
//ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3 這個類是在 autoload_real.php 檔案中定義的
//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;
    }
}

在第2點裡面是return 類名::getLoader()，所以我們來看這個getLoader()方法

//這裡是先判斷$loader靜態變數是否已經設定了，如果設定了的話，直接就返回了，不往下處理。一開始這個變數是null，所以會往下執行。
if (null !== self::$loader) {
    return self::$loader;
}

註冊自動載入函式

//這一行程式碼的意思是註冊一個自動載入函式，並且放在註冊函式佇列的第一位，
//如果註冊失敗則丟擲異常。這裡如果不能理解，請看下spl_autoload_register相關方法。
//註冊的自動載入函式是array裡面的，也就是當前類裡面的 loadClassLoader 方法：
spl_autoload_register(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'), true, true);
//這裡的意思是如果new一個類的時候，找不到類定義的檔案，那麼會在autoload函式佇列裡面去找，
//比如這裡剛剛把loadClassLoader方法註冊為自動載入函式，而且是第一位。
public static function loadClassLoader($class)
{
    if ('Composer\Autoload\ClassLoader' === $class) {
        require __DIR__ . '/ClassLoader.php';
    }
}

例項化loader

//第一行程式碼是new一個類，因為當前檔案並沒有直接require或者include，
//就是沒有載入該類的定義檔案，所以找不到該類，這個時候就從自動載入函式裡面去載入，看能否載入該類。

//因為loadClassLoader這個自動載入函式是在佇列的第一位，所以先執行這個自動載入函式。
//從上面的程式碼看出，實際上就是 require __DIR__ . '/ClassLoader.php';

//但是為何搞這麼複雜，不直接require，而是要通過註冊自動載入函式呢？ 這個原因後續再說。

//那麼第一行的意思就是require一個檔案，第二行程式碼是登出掉剛剛註冊的這個自動載入函式，
//因為這個自動載入函式只對本來有效，其他類不會用到，所以沒有必要一直放在佇列裡。

self::$loader = $loader = new \Composer\Autoload\ClassLoader();
spl_autoload_unregister(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'));

判斷是靜態載入檔案還是普通載入：$useStaticLoader 為 true則是靜態載入，為 false則是普通載入


$useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());　　

靜態載入，首先是載入autoload_static.php檔案，然後呼叫該檔案定義的類的getInitializer方法，並且把剛剛例項化的$loader作為引數傳遞過去。

require_once __DIR__ . '/autoload_static.php';
//執行一個函式，可以是閉包
call_user_func(\Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::getInitializer($loader));

getInitializer方法：這裡的意思是把autoload_static.php檔案中定義好的一些變數賦值給$loader物件。

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);
}　　

普通載入，普通載入和靜態載入的過程不一樣，但是結果是一樣的，都是設定$loader的成員屬性。

\$loader 這個載入器的四個屬性 \$prefixLengthsPsr4、\$prefixDirsPsr4、\$prefixesPsr0、\$classMap 被依次填充，前兩個對應著 psr-4 規範，後面兩個分別對應 psr-0 和 classMap。

// 載入的已定義名稱空間
$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);
}

填充的內容來自於 vendor/composer 資料夾下的這三個檔案：autoload_classmap、autoload_namespaces、autoload_psr4。開啟這些檔案，每一個檔案都返回了一個包含了很多檔案路徑的陣列。這些則來自於 composer.json。

不只是 Laravel 的根目錄存在 composer.json，vendor 資料夾下每一個由 composer 安裝的依賴庫，都存在著一個這樣的檔案。

"autoload": {
        "classmap": [
            "database"
        ],
        "psr-4": {
            "App\\": "app/"
        }
    },
    "autoload-dev": {
        "classmap": [
            "tests/TestCase.php"
        ]
    },

$loader 載入器被填充後，呼叫了它的 register 方法，在這個方法中，使用了 spl_autoload_register 註冊該類的 loadClass 方法作為 __autoload 的實現。需要用到一個類的時候，就會呼叫 loadClass 方法。

這個自動載入函式的功能就是去查詢檔案並且include檔案。

//預載入loader【重點】
$loader->register(true);　　
public function register($prepend = false)
{
    spl_autoload_register(array($this, 'loadClass'), true, $prepend);
}　　

緊接著，引入了 autoload_files，與其他三個不同，它返回的陣列，陣列中定義的多個檔案會被提前載入，而不是用到時才載入。如其中的 '/laravel/framework/src/Illuminate/Foundation/helpers.php'、'/laravel/framework/src/Illuminate/Support/helpers.php'。正是由於這兩個檔案被提前載入，其中的定義的框架方法才可以被在專案中任意使用。

// vendor/laravel/framework/composer.json
    "autoload": {
        "files": [
            "src/Illuminate/Foundation/helpers.php",
            "src/Illuminate/Support/helpers.php"
        ],
        "psr-4": {
            "Illuminate\\": "src/Illuminate/"
        }
    },

最後，$loader 被返回。接下來就可以在專案中沒有顧忌的使用各種類和方法了，而不需要把 include 寫滿每一個角落。當然，前提是需要符合 psr-4 的規範。

相關文章