Composer 自動載入

taozhang-tt發表於2018-08-19
compoer自動載入的原理先簡單描述如下，而後再通過例子說明：

通過在 composer.json 檔案中配置需要載入的類、名稱空間，通過執行 composer install 命令自動生成類名和對應的類檔案的對映，而後通過註冊 loadClass 方法，實現對 composer 管理的諸多類的自動載入；

如何在 composer.json 檔案中配置類和名稱空間 ？

共有四種方式：
PSR-0（網上查到的例子和 PSR-4 沒有看出太大區別，且已不推薦使用);
PSR-4;
Class-map;
Files；
在 composer.json 檔案中新增以下程式碼塊：

"autoload": {
    "psr-4": {
        "src\\darren\\": "src/",
        "project\\darren\\": "project"
        },
    "files": ["common/Darren.php", "common/Since.php"],
    "classmamp": [lib]
}

測試程式碼目錄結構如下：

common
    Darren.php
    Since.php
lib
    Darren.php
    Since.php
project
    Darren.php
src
    Darren.php
vendor
composer.json
index.php

程式碼中的名稱空間習慣為：目錄名 /Darren
當我們配置好 composer.json 檔案，並執行 compoer install 命令後，在 vendor/composer 目錄下會自動生成一些 php 檔案，這些檔案實際上記錄了類、名稱空間和對應的類檔案的對映，下面一一舉例說明；

PSR-4

如上所述，通過 psr-4 方式配置了兩個名稱空間的自動載入，分別是 src\daren 和 projecr\darren；vendor/composer 目錄下自動生成了 autoload_psr4.php 檔案，具體程式碼如下所示：

<?php

// autoload_psr4.php @generated by Composer

$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);

return array(
'src\\darren\\' => array($baseDir . '/src'),
'project\\darren\\' => array($baseDir . '/project'),
);
Classmap方式

classmap 方式只需要我們配置需要自動載入的目錄，compoer 會自動掃描目錄下的的 .php 檔案或 .inc 檔案中的 class，並自動生成這些類和其對應的類檔案的對映關係，儲存在 vendor/composer 目錄下的 autoload_classmap.php 檔案中，具體程式碼如下：

<?php

// autoload_classmap.php @generated by Composer

$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);

return array(
'lib\\darren\\Darren' => $baseDir . '/lib/Darren.php',
'lib\\since\\Since' => $baseDir . '/lib/Since.php',
);

其中 lib\darren 為名稱空間，Darren 為類名；

Files

files 方式其實就是手動指定要載入的檔案，這通常適用於一些全域性的 functions，可以將這些 functions 統一放在一個檔案裡，然後直接進行載入；
上述的配置檔案通過files方式載入了兩個檔案 common/Darren.php 和 common/Since.php，vendor/composer 目錄下自動生成了autoload_files.php 檔案，具體程式碼如下所示：

<?php

// autoload_files.php @generated by Composer

$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);

return array(
'b704865b506bf33e8097e6f62604fc7f' => $baseDir . '/common/Darren.php',
'603921ee67f9053beb44a88f05b115d2' => $baseDir . '/common/Since.php',
);
composer是如何實現自動載入的 ？

配置完 compoer.json 檔案，跑完了 composer install 命令，在檔案的開始引用 vendor/autolaod.php 即可實現類的自動載入，那麼 composer 是如何實現自動載入的呢？

這裡先插敘一點php的特性：當呼叫不存在的類時，系統會自動呼叫 __autoload( )方法來載入相應的類；

舉例子說明如下：
我們在 index.php 檔案中呼叫 Darren 類中的 testAutoload( ) 方法【Darren 類與 index.php 檔案在同級目錄】，這裡我們沒有在 index.php 檔案中引入 Darren 類，那麼肯定是會報錯的；但是我們可以重寫 __autoload( )方法實現 Darren 類的載入，具體程式碼如下：

//當呼叫不存在的類時，系統自動呼叫__autolaod()查詢
function __autolaod($class)
{
    $file = $class . '.php';
    if (is_file($file)) {
        require_once($file);
    }
}
Darren::testAutoload();

我們也可以通過 spl_autoload_register( ) 方法來註冊一個其它方法來替代 __autoload( )；

舉例如下：

function loader($class)
{
    $file = $class . '.php';
    if (is_file($file)) {
        require_once($file);
    }
}
spl_autoload_register('loader');
Darren::testAutoload();

這樣，loader方法就取代了 __autoload;

接下來我們繼續研究 composer 背後的載入機制，autoload.php 中引入了autoload_real.php 然後呼叫了getLoader( )方法，getLoader( )方法具體程式碼如下：

public static function getLoader()
{
    if (null !== self::$loader) {
        return self::$loader;
    }

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

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

    //整理通過psr-4方式配置的類
    $map = require __DIR__ . '/autoload_psr4.php';
    foreach ($map as $namespace => $path) {
        $loader->setPsr4($namespace, $path);
    }

    //整理通過classmap方式配置的類
    $classMap = require __DIR__ . '/autoload_classmap.php';
    if ($classMap) {
        $loader->addClassMap($classMap);
    }

    //註冊實現自動載入的方法
    $loader->register(true);

    //直接引入通過files配置的類
    $includeFiles = require __DIR__ . '/autoload_files.php';
    foreach ($includeFiles as $fileIdentifier => $file) {
        composerRequire0a8197b9e4da93df051721eff8ed7b28($fileIdentifier, $file);
    }

    return $loader;
}

該方法先是建立了一個 ClassLoader 類的物件，然後載入 composer 自動生成的那些記錄類、名稱空間與檔案對映關係的檔案，呼叫 ClassLoader 中的方法對這些檔案整理，並將對映關係通過陣列儲存，陣列的鍵為類名或者名稱空間加類名，陣列的值為類對應的類檔案地址；這裡值得注意的一點是，我們通過files配置的那些需要自動載入的類，是直接將類檔案引入進來，並不是在呼叫時才去載入，程式碼如下：

function composerRequire0a8197b9e4da93df051721eff8ed7b28($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;//直接引入類檔案
        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
     }
}
ClassLoader類中值得注意的方法：

通過 register 方法註冊 loadClass 方法，取代 __autoload( )方法，實現類的載入

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

具體如何查詢陣列從而得到該類對應的類檔案，可以通過 xdebug 跟一遍程式碼，並不難理解；

資源裡上傳了示例程式碼，也可以通過百度雲盤自取https://pan.baidu.com/s/1i6eEHLz

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章