Composer的Autoload源碼實現(xiàn)——注冊與運(yùn)行

wanghui 發(fā)布于2019-06-27 16:27 / 870人閱讀

前言

在開始之前，歡迎關(guān)注我自己的博客：www.leoyang90.cn
上一篇文章我們講到了 Composer 自動加載功能的啟動與初始化，經(jīng)過啟動與初始化，自動加載核心類對象已經(jīng)獲得了頂級命名空間與相應(yīng)目錄的映射，換句話說，如果有命名空間 "AppConsoleKernel，我們已經(jīng)知道了 App 對應(yīng)的目錄，接下來我們就要解決下面的就是 ConsoleKernel這一段。

注冊

我們先回顧一下自動加載引導(dǎo)類：

public static function getLoader()
{
        /***************************經(jīng)典單例模式********************/
        if (null !== self::$loader) {
            return self::$loader;
        }
        
        /***********************獲得自動加載核心類對象********************/
        spl_autoload_register(array("ComposerAutoloaderInit
        832ea71bfb9a4128da8660baedaac82e", "loadClassLoader"), true, true);
        
        self::$loader = $loader = new ComposerAutoloadClassLoader();
        
        spl_autoload_unregister(array("ComposerAutoloaderInit
        832ea71bfb9a4128da8660baedaac82e", "loadClassLoader"));

        /***********************初始化自動加載核心類對象********************/
        $useStaticLoader = PHP_VERSION_ID >= 50600 && 
        !defined("HHVM_VERSION");
        
        if ($useStaticLoader) {
            require_once __DIR__ . "/autoload_static.php";

            call_user_func(ComposerAutoloadComposerStaticInit
            832ea71bfb9a4128da8660baedaac82e::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->register(true);

        /***********************自動加載全局函數(shù)********************/
        if ($useStaticLoader) {
            $includeFiles = ComposerAutoloadComposerStaticInit
            832ea71bfb9a4128da8660baedaac82e::$files;
        } else {
            $includeFiles = require __DIR__ . "/autoload_files.php";
        }
        
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequire
            832ea71bfb9a4128da8660baedaac82e($fileIdentifier, $file);
        }

        return $loader;
    }

現(xiàn)在我們開始引導(dǎo)類的第四部分：注冊自動加載核心類對象。我們來看看核心類的 register() 函數(shù)：

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

簡單到爆炸??！一行代碼實現(xiàn)自動加載有木有！其實奧秘都在自動加載核心類 ClassLoader 的 loadClass() 函數(shù)上，這個函數(shù)負(fù)責(zé)按照 PSR 標(biāo)準(zhǔn)將頂層命名空間以下的內(nèi)容轉(zhuǎn)為對應(yīng)的目錄，也就是上面所說的將 "AppConsoleKernel中"ConsoleKernel 這一段轉(zhuǎn)為目錄，至于怎么轉(zhuǎn)的我們在下面“Composer 自動加載源碼分析——運(yùn)行”講。核心類 ClassLoader 將 loadClass() 函數(shù)注冊到 PHP SPL 中的spl_autoload_register() 里面去，這個函數(shù)的來龍去脈我們之前文章講過。這樣，每當(dāng) PHP 遇到一個不認(rèn)識的命名空間的時候，PHP 會自動調(diào)用注冊到 spl_autoload_register 里面的函數(shù)堆棧，運(yùn)行其中的每個函數(shù)，直到找到命名空間對應(yīng)的文件。

全局函數(shù)的自動加載

Composer 不止可以自動加載命名空間，還可以加載全局函數(shù)。怎么實現(xiàn)的呢？很簡單，把全局函數(shù)寫到特定的文件里面去，在程序運(yùn)行前挨個 require 就行了。這個就是 composer 自動加載的第五步，加載全局函數(shù)。

if ($useStaticLoader) {
    $includeFiles = ComposerAutoloadComposerStaticInit832ea71bfb9a4128da8660baedaac82e::$files;
} else {
    $includeFiles = require __DIR__ . "/autoload_files.php";
}

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

跟核心類的初始化一樣，全局函數(shù)自動加載也分為兩種：靜態(tài)初始化和普通初始化，靜態(tài)加載只支持 PHP5.6 以上并且不支持 HHVM。

靜態(tài)初始化：

ComposerStaticInit832ea71bfb9a4128da8660baedaac82e::$files：

public static $files = array (
      "0e6d7bf4a5811bfa5cf40c5ccd6fae6a" => __DIR__ . "/.." . "/symfony/polyfill-mbstring/bootstrap.php",
      "667aeda72477189d0494fecd327c3641" => __DIR__ . "/.." . "/symfony/var-dumper/Resources/functions/dump.php",
      ...
    );

看到這里我們可能又要有疑問了，為什么不直接放文件路徑名，還要一個 hash 干什么呢？這個我們一會兒講，我們這里先了解一下這個數(shù)組的結(jié)構(gòu)。

普通初始化

autoload_files:

$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);
    
return array(
    "0e6d7bf4a5811bfa5cf40c5ccd6fae6a" => $vendorDir . "/symfony/polyfill-mbstring/bootstrap.php",
    "667aeda72477189d0494fecd327c3641" => $vendorDir . "/symfony/var-dumper/Resources/functions/dump.php",
     ....
);

其實跟靜態(tài)初始化區(qū)別不大。

加載全局函數(shù)

class ComposerAutoloaderInit832ea71bfb9a4128da8660baedaac82e{
    public static function getLoader(){
        ...
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequire832ea71bfb9a4128da8660baedaac82e($fileIdentifier, $file);
        }
        ...
    }
}

function composerRequire832ea71bfb9a4128da8660baedaac82e($fileIdentifier, $file)
{
      if (empty($GLOBALS["__composer_autoload_files"][$fileIdentifier])) {
          require $file;

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

這一段很有講究，
第一個問題：為什么自動加載引導(dǎo)類的 getLoader() 函數(shù)不直接 require includeFiles 里面的每個文件名，而要用類外面的函數(shù)composerRequire832ea71bfb9a4128da8660baedaac82e0？(順便說下這個函數(shù)名 hash 仍然為了避免和用戶定義函數(shù)沖突)因為怕有人在全局函數(shù)所在的文件寫 this 或者self。
假如 includeFiles 有個 app/helper.php 文件，這個 helper.php 文件的函數(shù)外有一行代碼：this->foo()，如果引導(dǎo)類在 getLoader() 函數(shù)直接 require(file)，那么引導(dǎo)類就會運(yùn)行這句代碼，調(diào)用自己的 foo() 函數(shù)，這顯然是錯的。事實上 helper.php 就不應(yīng)該出現(xiàn) this 或 self 這樣的代碼，這樣寫一般都是用戶寫錯了的，一旦這樣的事情發(fā)生，第一種情況：引導(dǎo)類恰好有 foo() 函數(shù)，那么就會莫名其妙執(zhí)行了引導(dǎo)類的 foo();第二種情況：引導(dǎo)類沒有 foo() 函數(shù)，但是卻甩出來引導(dǎo)類沒有 foo() 方法這樣的錯誤提示，用戶不知道自己哪里錯了。把 require 語句放到引導(dǎo)類的外面，遇到 this 或者 self，程序就會告訴用戶根本沒有類，this 或 self 無效，錯誤信息更加明朗。

第二個問題，為什么要用 hash 作為 fileIdentifier，上面的代碼明顯可以看出來這個變量是用來控制全局函數(shù)只被 require 一次的，那為什么不用 require_once 呢？事實上require_once 比 require 效率低很多，使用全局變量 GLOBALS 這樣控制加載會更快。

但是其實也帶來了一些問題，如果存在兩個自動加載，而且全局函數(shù)的相對路徑不一致，很容易造成 hash 不相同，但是文件相同的情況，導(dǎo)致重復(fù)定義函數(shù)。所以在使用 composer 的時候最好要統(tǒng)一自動加載和依賴機(jī)制，最好不要多重自動加載。

運(yùn)行

我們終于來到了核心的核心——composer 自動加載的真相，命名空間如何通過 composer 轉(zhuǎn)為對應(yīng)目錄文件的奧秘就在這一章。
前面說過，ClassLoader的register() 函數(shù)將 loadClass() 函數(shù)注冊到 PHP 的 SPL 函數(shù)堆棧中，每當(dāng) PHP 遇到不認(rèn)識的命名空間時就會調(diào)用函數(shù)堆棧的每個函數(shù)，直到加載命名空間成功。所以 loadClass() 函數(shù)就是自動加載的關(guān)鍵了。
loadClass():

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

    return true;
}
}

public function findFile($class)
{
// work around for PHP 5.3.0 - 5.3.2 https://bugs.php.net/50731
if ("" == $class[0]) {
    $class = substr($class, 1);
}

// class map lookup
if (isset($this->classMap[$class])) {
    return $this->classMap[$class];
}
if ($this->classMapAuthoritative) {
    return false;
}

$file = $this->findFileWithExtension($class, ".php");

// Search for Hack files if we are running on HHVM
if ($file === null && defined("HHVM_VERSION")) {
    $file = $this->findFileWithExtension($class, ".hh");
}

if ($file === null) {
    // Remember that this class does not exist.
    return $this->classMap[$class] = false;
}

return $file;
}

我們看到 loadClass()，主要調(diào)用 findFile() 函數(shù)。findFile() 在解析命名空間的時候主要分為兩部分：classMap 和 findFileWithExtension() 函數(shù)。classMap 很簡單，直接看命名空間是否在映射數(shù)組中即可。麻煩的是 findFileWithExtension() 函數(shù)，這個函數(shù)包含了 PSR0 和 PSR4 標(biāo)準(zhǔn)的實現(xiàn)。還有個值得我們注意的是查找路徑成功后 includeFile() 仍然類外面的函數(shù)，并不是 ClassLoader 的成員函數(shù)，原理跟上面一樣，防止有用戶寫 $this 或 self。還有就是如果命名空間是以開頭的，要去掉然后再匹配。
findFileWithExtension：

private function findFileWithExtension($class, $ext)
{
      // PSR-4 lookup
      $logicalPathPsr4 = strtr($class, "", DIRECTORY_SEPARATOR) . $ext;

      $first = $class[0];
      if (isset($this->prefixLengthsPsr4[$first])) {
          foreach ($this->prefixLengthsPsr4[$first] as $prefix => $length) {
              if (0 === strpos($class, $prefix)) {
                  foreach ($this->prefixDirsPsr4[$prefix] as $dir) {
                      if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
                          return $file;
                      }
                  }
              }
          }
      }

      // PSR-4 fallback dirs
      foreach ($this->fallbackDirsPsr4 as $dir) {
          if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
              return $file;
          }
      }

      // PSR-0 lookup
      if (false !== $pos = strrpos($class, "")) {
          // namespaced class name
          $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
                . strtr(substr($logicalPathPsr4, $pos + 1), "_", DIRECTORY_SEPARATOR);
      } else {
          // PEAR-like class name
          $logicalPathPsr0 = strtr($class, "_", DIRECTORY_SEPARATOR) . $ext;
      }

      if (isset($this->prefixesPsr0[$first])) {
          foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
              if (0 === strpos($class, $prefix)) {
                  foreach ($dirs as $dir) {
                      if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
                          return $file;
                      }
                  }
              }
          }
      }

      // PSR-0 fallback dirs
      foreach ($this->fallbackDirsPsr0 as $dir) {
          if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
              return $file;
          }
      }

      // PSR-0 include paths.
      if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
          return $file;
      }
}

下面我們通過舉例來說下上面代碼的流程：
如果我們在代碼中寫下 "phpDocumentorReflectionexample"，PHP 會通過 SPL 調(diào)用 loadClass->findFile->findFileWithExtension。首先默認(rèn)用 php 作為文件后綴名調(diào)用 findFileWithExtension 函數(shù)里，利用 PSR4 標(biāo)準(zhǔn)嘗試解析目錄文件，如果文件不存在則繼續(xù)用 PSR0 標(biāo)準(zhǔn)解析，如果解析出來的目錄文件仍然不存在，但是環(huán)境是 HHVM 虛擬機(jī)，繼續(xù)用后綴名為 hh 再次調(diào)用 findFileWithExtension 函數(shù)，如果不存在，說明此命名空間無法加載，放到 classMap 中設(shè)為 false，以便以后更快地加載。
對于 phpDocumentorReflectionexample，當(dāng)嘗試?yán)?PSR4 標(biāo)準(zhǔn)映射目錄時，步驟如下：

PSR4 標(biāo)準(zhǔn)加載


將  轉(zhuǎn)為文件分隔符 /，加上后綴 php 或 hh，得到 $logicalPathPsr4 即 phpDocumentor//Reflection//example.php(hh);

利用命名空間第一個字母 p 作為前綴索引搜索 prefixLengthsPsr4 數(shù)組，查到下面這個數(shù)組：

p" => 
    array (
       "phpDocumentorReflection" => 25,
       "phpDocumentorFake" => 19,
    )

遍歷這個數(shù)組，得到兩個頂層命名空間 phpDocumentorReflection 和 phpDocumentorFake

用這兩個頂層命名空間與 phpDocumentorReflectionexample_e 相比較，可以得到 phpDocumentorReflection 這個頂層命名空間

在 prefixLengthsPsr4 映射數(shù)組中得到 phpDocumentorReflection 長度為25。

在 prefixDirsPsr4 映射數(shù)組中得到 phpDocumentorReflection 的目錄映射為：

"phpDocumentorReflection" => 
    array (
        0 => __DIR__ . "/.." . "/phpdocumentor/reflection-common/src",
        1 => __DIR__ . "/.." . "/phpdocumentor/type-resolver/src",
        2 => __DIR__ . "/.." . "/phpdocumentor/reflection-docblock/src",
),


遍歷這個映射數(shù)組，得到三個目錄映射；

查看 “目錄+文件分隔符 //+substr($logicalPathPsr4, $length)” 文件是否存在，存在即返回。這里就是 "__DIR__/../phpdocumentor/reflection-common/src + /+ substr(phpDocumentor/Reflection/example_e.php(hh),25)"

如果失敗，則利用 fallbackDirsPsr4 數(shù)組里面的目錄繼續(xù)判斷是否存在文件，具體方法是“目錄+文件分隔符//+$logicalPathPsr4”

PSR0 標(biāo)準(zhǔn)加載

如果 PSR4 標(biāo)準(zhǔn)加載失敗，則要進(jìn)行 PSR0 標(biāo)準(zhǔn)加載：

找到 phpDocumentorReflectionexample_e 最后“”的位置，將其后面文件名中’‘_’‘字符轉(zhuǎn)為文件分隔符“/”,得到 logicalPathPsr0 即 phpDocumentor/Reflection/example/e.php(hh)
利用命名空間第一個字母 p 作為前綴索引搜索 prefixLengthsPsr4 數(shù)組，查到下面這個數(shù)組：

    "P" => 
        array (
            "Prophecy" => 
            array (
                0 => __DIR__ . "/.." . "/phpspec/prophecy/src",
            ),
            "phpDocumentor" => 
            array (
                0 => __DIR__ . "/.." . "/erusev/parsedown",
            ),
        ),

遍歷這個數(shù)組，得到兩個頂層命名空間phpDocumentor和Prophecy

用這兩個頂層命名空間與 phpDocumentorReflectionexample_e 相比較，可以得到 phpDocumentor 這個頂層命名空間

在映射數(shù)組中得到 phpDocumentor 目錄映射為 "_DIR_ . "/.." . "/erusev/parsedown"

查看 “目錄+文件分隔符//+logicalPathPsr0”文件是否存在，存在即返回。這里就是
“_DIR_ . "/.." . "/erusev/parsedown + //+ phpDocumentor//Reflection//example/e.php(hh)”

如果失敗，則利用 fallbackDirsPsr0 數(shù)組里面的目錄繼續(xù)判斷是否存在文件，具體方法是“目錄+文件分隔符//+logicalPathPsr0”

如果仍然找不到，則利用 stream_resolve_include_path()，在當(dāng)前 include 目錄尋找該文件，如果找到返回絕對路徑。

結(jié)語

經(jīng)過三篇文章，終于寫完了 PHP Composer 自動加載的原理與實現(xiàn)，結(jié)下來我們開始講解 laravel 框架下的門面 Facade,這個門面功能和自動加載有著一些聯(lián)系.

云服務(wù)器 GPU云服務(wù)器 Flutter的搭建與運(yùn)行主要更新了工具鏈、運(yùn)行時和庫的實現(xiàn) 棧的實現(xiàn)與應(yīng)用回調(diào)的原理、實現(xiàn)與應(yīng)用

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/22927.html

發(fā)表評論

登陸后可評論

0條評論

wanghui

男|高級講師

我要關(guān)注我要私信

TA的文章

代理模式C++實現(xiàn)

閱讀 1948·2021-11-25 09:43
Hadoop 入門筆記—核心組件 YARN

閱讀 1441·2021-11-22 14:56
【C++】list詳解

閱讀 3306·2021-11-22 09:34
Python爬蟲案例50篇-第8篇- 抓取某訊招聘的北京工作崗位

閱讀 2050·2021-11-15 11:37
WPTao淘寶客插件配置淘寶聯(lián)盟和京東聯(lián)盟API信息

閱讀 2324·2021-09-01 10:46
react知識點(diǎn)整理50問（未完待續(xù)）

閱讀 1428·2019-08-30 15:44
CSS背景與邊框

閱讀 2323·2019-08-30 13:15
使用原生js實現(xiàn)輪播圖效果

閱讀 2418·2019-08-29 13:07

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

Composer的Autoload源碼實現(xiàn)——注冊與運(yùn)行

相關(guān)文章

Composer的Autoload源碼實現(xiàn)——啟動與初始化

thinkphp源碼分析（三）—自動加載篇（Loader的分析）

Symfony2.8 源碼分析之類的加載

ThinkPHP5.1 源碼淺析（二）自動加載機(jī)制

解讀 thinkphp5 源碼（一）：自動加載

發(fā)表評論

0條評論

wanghui

男|高級講師

TA的文章

代理模式C++實現(xiàn)

Hadoop 入門筆記—核心組件 YARN

【C++】list詳解

Python爬蟲案例50篇-第8篇- 抓取某訊招聘的北京工作崗位

WPTao淘寶客插件配置淘寶聯(lián)盟和京東聯(lián)盟API信息

react知識點(diǎn)整理50問（未完待續(xù)）

CSS背景與邊框

使用原生js實現(xiàn)輪播圖效果

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

Composer的Autoload源碼實現(xiàn)——注冊與運(yùn)行

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！