深入解讀PHP包管理器Composer實(shí)現(xiàn)原理

Composer是用php開(kāi)發(fā)的用來(lái)管理項(xiàng)目依賴的工具，當(dāng)你在項(xiàng)目中聲明了依賴關(guān)系后，composer可以自動(dòng)幫你下載和安裝這些依賴庫(kù)，并實(shí)現(xiàn)自動(dòng)加載代碼。

定義一個(gè)composer.json:

{
	"name": "gitlib/composer",
	"require":{
		"predis/predis":"1.1.1"
	}
}

輸入命令 composer install，composer會(huì)幫我們自動(dòng)下載predis庫(kù)，依賴庫(kù)會(huì)默認(rèn)放在項(xiàng)目的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不僅僅幫我們處理依賴，還幫我們實(shí)現(xiàn)了自動(dòng)加載。在vendor目錄下有一個(gè)autoload.php, 只要在我們的項(xiàng)目中引入這個(gè)文件就可以自動(dòng)加載依賴庫(kù)。

<?php
require 'vendor/autoload.php';
$client = new PredisClient();
$client->set('foo', 'bar');
$value = $client->get('foo');
echo $value;

可以看到Predis庫(kù)完全不需要我們手動(dòng)去加載，只需要require 'vendor/autoload.php'，composer的自動(dòng)加載機(jī)制會(huì)幫我們找到對(duì)應(yīng)的文件并加載。

對(duì)于依賴庫(kù)，composer幫我們處理好了自動(dòng)加載, 那對(duì)于其他的類庫(kù)，如何實(shí)現(xiàn)自動(dòng)加載呢？

composer支持四種自動(dòng)加載的方式：Files/Classmap/PSR-0/ PSR-4, 其中PSR-4是當(dāng)前推薦的加載方式。

Files

Files 是最簡(jiǎn)單的加載方式，這種方式不管加載的文件是否用到始終都會(huì)加載，而不是按需加載, 修改項(xiàng)目根目下的composer.json, 加入 “autoload” 項(xiàng)：

{
	"name": "gitlib/composer",
	"require":{
		"predis/predis":"1.1.1"
	},
	"autoload":{
		"files":["Controller/User.php"]
	}
}

files鍵對(duì)應(yīng)的值是一個(gè)數(shù)組，數(shù)組元素是文件的路徑，路徑是相對(duì)于應(yīng)用的根目錄。加上上述內(nèi)容后，運(yùn)行命令：

composer dump-autoload

讓composer重建自動(dòng)加載的信息，composer會(huì)把配置值寫入與 Files加載方式對(duì)應(yīng)的 verndorcomposerautoload_files.php配置文件中：

<?php
// autoload_files.php @generated by Composer
$vendorDir = dirname(dirname(__FILE__));
$baseDir = dirname($vendorDir);
return array(
 '7efd69bb86214589340b40039fd363f7' => $baseDir . '/Controller/User.php',
);

現(xiàn)在就可以在代碼中里調(diào)用User類了。

<?php
require 'vendor/autoload.php';
$client = new PredisClient();
$user = new ControllerUser();
$user->login();

Classmap

classmap引用的所有組合，都會(huì)在 install/update 過(guò)程中生成，并存儲(chǔ)到vendor/composer/autoload_classmap.php 文件中。這個(gè) map 是經(jīng)過(guò)掃描指定目錄（同樣支持直接精確到文件）中所有的 .php 和 .inc 文件里內(nèi)置的類而得到的。

{
	"name": "gitlib/composer",
	"require":{
		"predis/predis":"1.1.1"
	},
	"autoload":{
		"classmap":["Controller"]
	}
}

Composer會(huì)掃描Controller目錄下的所有.php和.inc文件，存儲(chǔ)到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自動(dòng)加載規(guī)范是已經(jīng)廢棄的標(biāo)準(zhǔn), 不再做說(shuō)明。

PSR-4

PSR-4是Composer推薦使用的一種方式(關(guān)于PSR規(guī)范可參考：PHP標(biāo)準(zhǔn)規(guī)范PSR)，因?yàn)樗资褂貌⒛軒?lái)更簡(jiǎn)潔的目錄結(jié)構(gòu)。對(duì)于上面的Controller目錄我們先改名src:

├── composer.json
├── composer.json.bk
├── composer.lock
├── index.php
├── src
│ └── User.php
└── vendor
 ├── autoload.php
 ├── composer
 └── predis

在composer.json中我們將Controller命名空間和src關(guān)聯(lián)起來(lái)：

{
	"name": "gitlib/composer",
	"require":{
		"predis/predis":"1.1.1"
	},
	"autoload":{
		"psr-4": {
			"Controller\":"src/"
		}
	}
}

PSR-4 的命名空間前綴也必須以 \ 結(jié)尾，以避免類似前綴間的沖突。

psr-4中的key和value定義了namespace以及其對(duì)應(yīng)的目錄映射。按照PSR-4的規(guī)則，當(dāng)試圖自動(dòng)加載”ControllerUser”類的使用，會(huì)去尋找”src/User.php”這個(gè)文件，此時(shí)Controller并不會(huì)出現(xiàn)在文件路徑中。

自動(dòng)加載原理

下面我們通過(guò)源碼分析composer是如何實(shí)現(xiàn)自動(dòng)加載功能。

入口

<?php
require 'vendor/autoload.php';

我們通過(guò)require ‘vendor/autoload.php實(shí)現(xiàn)自動(dòng)加載，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是自動(dòng)加載引導(dǎo)類，程序主要調(diào)用了引導(dǎo)類的靜態(tài)方法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;
 }
 // 調(diào)用spl_autoload_register加載ComposerAutoloadClassLoader
 spl_autoload_register(array('ComposerAutoloaderInitb84761f57e62a6a534584b91ca213591', 'loadClassLoader'), true, true);
 // 實(shí)例化ComposerAutoloadClassLoader類
 self::$loader = $loader = new ComposerAutoloadClassLoader();
 spl_autoload_unregister(array('ComposerAutoloaderInitb84761f57e62a6a534584b91ca213591', 'loadClassLoader'));
 // 靜態(tài)初始化只支持 PHP5.6 以上版本并且不支持 HHVM 虛擬機(jī)
 $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
 if ($useStaticLoader) {
 // 使用 autoload_static 進(jìn)行靜態(tài)初始化
 require_once __DIR__ . '/autoload_static.php';
 call_user_func(ComposerAutoloadComposerStaticInitb84761f57e62a6a534584b91ca213591::getInitializer($loader));
 } else {
 // 如果PHP版本低于 5.6 或者使用 HHVM 虛擬機(jī)環(huán)境，那么就要使用核心類的接口進(jìn)行初始化
 // PSR0 標(biāo)準(zhǔn)
 $map = require __DIR__ . '/autoload_namespaces.php';
 foreach ($map as $namespace => $path) {
 $loader->set($namespace, $path);
 }
 // PSR4 標(biāo)準(zhǔn)
 $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);
 }
}

靜態(tài)初始化類的核心就是 getInitializer() 函數(shù)，它將自己類中的頂級(jí)命名空間映射給了 ClassLoader 類。

PSR4 標(biāo)準(zhǔn)頂級(jí)命名空間映射用了兩個(gè)數(shù)組，第一個(gè)是用命名空間第一個(gè)字母作為前綴索引，然后是頂級(jí)命名空間，但是最終并不是文件路徑，而是頂級(jí)命名空間的長(zhǎng)度。為什么呢？

因?yàn)?PSR4 標(biāo)準(zhǔn)是用頂級(jí)命名空間目錄替換頂級(jí)命名空間，所以獲得頂級(jí)命名空間的長(zhǎng)度很重要。

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() 函數(shù)將 loadClass() 函數(shù)注冊(cè)到 PHP 的 SPL 函數(shù)堆棧中，每當(dāng) PHP 遇到不認(rèn)識(shí)的命名空間時(shí)就會(huì)調(diào)用函數(shù)堆棧的每個(gè)函數(shù)，直到加載命名空間成功。所以 loadClass() 函數(shù)就是自動(dòng)加載的關(guān)鍵了。