Composer是用php開發的用來管理項目依賴的工具,當你在項目中聲明了依賴關系后,composer可以自動幫你下載和安裝這些依賴庫,并實現自動加載代碼。
定義一個composer.json:
{ "name": "gitlib/composer", "require":{ "predis/predis":"1.1.1" } }
輸入命令 composer install,composer會幫我們自動下載predis庫,依賴庫會默認放在項目的vendor目錄下。
├── composer.json ├── composer.lock ├── index.php └── vendor ├── autoload.php ├── composer │ ├── ClassLoader.php │ ├── LICENSE │ ├── autoload_classmap.php │ ├── autoload_namespaces.php │ ├── autoload_psr4.php │ ├── autoload_real.php │ ├── autoload_static.php │ └── installed.json └── predis └── predis
composer不僅僅幫我們處理依賴,還幫我們實現了自動加載。在vendor目錄下有一個autoload.php, 只要在我們的項目中引入這個文件就可以自動加載依賴庫。
<?php require 'vendor/autoload.php'; $client = new PredisClient(); $client->set('foo', 'bar'); $value = $client->get('foo'); echo $value;
可以看到Predis庫完全不需要我們手動去加載,只需要require 'vendor/autoload.php',composer的自動加載機制會幫我們找到對應的文件并加載。
對于依賴庫,composer幫我們處理好了自動加載, 那對于其他的類庫,如何實現自動加載呢?
composer支持四種自動加載的方式:Files/Classmap/PSR-0/ PSR-4, 其中PSR-4是當前推薦的加載方式。
Files
Files 是最簡單的加載方式,這種方式不管加載的文件是否用到始終都會加載,而不是按需加載, 修改項目根目下的composer.json, 加入 “autoload” 項:
{ "name": "gitlib/composer", "require":{ "predis/predis":"1.1.1" }, "autoload":{ "files":["Controller/User.php"] } }
files鍵對應的值是一個數組,數組元素是文件的路徑,路徑是相對于應用的根目錄。加上上述內容后,運行命令:
composer dump-autoload
讓composer重建自動加載的信息,composer會把配置值寫入與 Files加載方式對應的 verndorcomposerautoload_files.php配置文件中:
<?php // autoload_files.php @generated by Composer $vendorDir = dirname(dirname(__FILE__)); $baseDir = dirname($vendorDir); return array( '7efd69bb86214589340b40039fd363f7' => $baseDir . '/Controller/User.php', );
現在就可以在代碼中里調用User類了。
<?php require 'vendor/autoload.php'; $client = new PredisClient(); $user = new ControllerUser(); $user->login();
Classmap
classmap引用的所有組合,都會在 install/update 過程中生成,并存儲到vendor/composer/autoload_classmap.php 文件中。這個 map 是經過掃描指定目錄(同樣支持直接精確到文件)中所有的 .php 和 .inc 文件里內置的類而得到的。
{ "name": "gitlib/composer", "require":{ "predis/predis":"1.1.1" }, "autoload":{ "classmap":["Controller"] } }
Composer會掃描Controller目錄下的所有.php和.inc文件,存儲到vendor/composer/autoload_classmap.php文件中:
<?php // autoload_classmap.php @generated by Composer $vendorDir = dirname(dirname(__FILE__)); $baseDir = dirname($vendorDir); return array( 'Controller\User' => $baseDir . '/Controller/User.php', );
PSR-0
PSR-0自動加載規范是已經廢棄的標準, 不再做說明。
PSR-4
PSR-4是Composer推薦使用的一種方式(關于PSR規范可參考:PHP標準規范PSR),因為它更易使用并能帶來更簡潔的目錄結構。對于上面的Controller目錄我們先改名src:
├── composer.json ├── composer.json.bk ├── composer.lock ├── index.php ├── src │ └── User.php └── vendor ├── autoload.php ├── composer └── predis
在composer.json中我們將Controller命名空間和src關聯起來:
{ "name": "gitlib/composer", "require":{ "predis/predis":"1.1.1" }, "autoload":{ "psr-4": { "Controller\":"src/" } } }
PSR-4 的命名空間前綴也必須以 \ 結尾,以避免類似前綴間的沖突。
psr-4中的key和value定義了namespace以及其對應的目錄映射。按照PSR-4的規則,當試圖自動加載”ControllerUser”類的使用,會去尋找”src/User.php”這個文件,此時Controller并不會出現在文件路徑中。
自動加載原理
下面我們通過源碼分析composer是如何實現自動加載功能。
入口
<?php require 'vendor/autoload.php';
我們通過require ‘vendor/autoload.php實現自動加載,vendor/autoloaad.php文件引用composer/autoload_real.php。
<?php // autoload.php @generated by Composer require_once __DIR__ . '/composer/autoload_real.php'; return ComposerAutoloaderInitb84761f57e62a6a534584b91ca213591::getLoader();
autoload_real
autoload_real.php是自動加載引導類,程序主要調用了引導類的靜態方法getLoader()。
<?php // autoload_real.php @generated by Composer class ComposerAutoloaderInitb84761f57e62a6a534584b91ca213591 { private static $loader; public static function loadClassLoader($class) { if ('ComposerAutoloadClassLoader' === $class) { require __DIR__ . '/ClassLoader.php'; } } public static function getLoader() { // 返回ComposerAutoloadClassLoader單例 if (null !== self::$loader) { return self::$loader; } // 調用spl_autoload_register加載ComposerAutoloadClassLoader spl_autoload_register(array('ComposerAutoloaderInitb84761f57e62a6a534584b91ca213591', 'loadClassLoader'), true, true); // 實例化ComposerAutoloadClassLoader類 self::$loader = $loader = new ComposerAutoloadClassLoader(); spl_autoload_unregister(array('ComposerAutoloaderInitb84761f57e62a6a534584b91ca213591', 'loadClassLoader')); // 靜態初始化只支持 PHP5.6 以上版本并且不支持 HHVM 虛擬機 $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded()); if ($useStaticLoader) { // 使用 autoload_static 進行靜態初始化 require_once __DIR__ . '/autoload_static.php'; call_user_func(ComposerAutoloadComposerStaticInitb84761f57e62a6a534584b91ca213591::getInitializer($loader)); } else { // 如果PHP版本低于 5.6 或者使用 HHVM 虛擬機環境,那么就要使用核心類的接口進行初始化 // PSR0 標準 $map = require __DIR__ . '/autoload_namespaces.php'; foreach ($map as $namespace => $path) { $loader->set($namespace, $path); } // PSR4 標準 $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 if ($useStaticLoader) { $includeFiles = ComposerAutoloadComposerStaticInitb84761f57e62a6a534584b91ca213591::$files; } else { $includeFiles = require __DIR__ . '/autoload_files.php'; } // files定義的文件,直接require就行了 foreach ($includeFiles as $fileIdentifier => $file) { composerRequireb84761f57e62a6a534584b91ca213591($fileIdentifier, $file); } return $loader; } }
autoload_static
<?php // autoload_static.php @generated by Composer namespace ComposerAutoload; class ComposerStaticInitb84761f57e62a6a534584b91ca213591 { public static $files = array ( '7efd69bb86214589340b40039fd363f7' => __DIR__ . '/../..' . '/Controller/User.php', ); public static $prefixLengthsPsr4 = array ( 'P' => array ( 'Predis\' => 7, ), 'C' => array ( 'Controller\' => 11, ), ); public static $prefixDirsPsr4 = array ( 'Predis\' => array ( 0 => __DIR__ . '/..' . '/predis/predis/src', ), 'Controller\' => array ( 0 => __DIR__ . '/../..' . '/src', ), ); public static function getInitializer(ClassLoader $loader) { return Closure::bind(function () use ($loader) { $loader->prefixLengthsPsr4 = ComposerStaticInitb84761f57e62a6a534584b91ca213591::$prefixLengthsPsr4; $loader->prefixDirsPsr4 = ComposerStaticInitb84761f57e62a6a534584b91ca213591::$prefixDirsPsr4; }, null, ClassLoader::class); } }
靜態初始化類的核心就是 getInitializer() 函數,它將自己類中的頂級命名空間映射給了 ClassLoader 類。
PSR4 標準頂級命名空間映射用了兩個數組,第一個是用命名空間第一個字母作為前綴索引,然后是 頂級命名空間,但是最終并不是文件路徑,而是 頂級命名空間的長度。為什么呢?
因為 PSR4 標準是用頂級命名空間目錄替換頂級命名空間,所以獲得頂級命名空間的長度很重要。
ClassLoader
public function register($prepend = false) { spl_autoload_register(array($this, 'loadClass'), true, $prepend); } public function loadClass($class) { if ($file = $this->findFile($class)) { includeFile($file); return true; } } /** * Finds the path to the file where the class is defined. * * @param string $class The name of the class * * @return string|false The path if found, false otherwise */ public function findFile($class) { // class map lookup if (isset($this->classMap[$class])) { return $this->classMap[$class]; } if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) { return false; } if (null !== $this->apcuPrefix) { $file = apcu_fetch($this->apcuPrefix.$class, $hit); if ($hit) { return $file; } } $file = $this->findFileWithExtension($class, '.php'); // Search for Hack files if we are running on HHVM if (false === $file && defined('HHVM_VERSION')) { $file = $this->findFileWithExtension($class, '.hh'); } if (null !== $this->apcuPrefix) { apcu_add($this->apcuPrefix.$class, $file); } if (false === $file) { // Remember that this class does not exist. $this->missingClasses[$class] = true; } return $file; } function includeFile($file) { include $file; }
ClassLoader 的 register() 函數將 loadClass() 函數注冊到 PHP 的 SPL 函數堆棧中,每當 PHP 遇到不認識的命名空間時就會調用函數堆棧的每個函數,直到加載命名空間成功。所以 loadClass() 函數就是自動加載的關鍵了。