Composer自动加载源码解析

1、先看下框架入口文件index.php:
<?php
define('LARAVEL_START', microtime(true));
require __DIR__.'/../vendor/autoload.php';
... ...

Composer 目录文件

根目录 composer/

autoload_namespaces.php 为需要加载的命名空间前缀定义路径
autoload_classmap.php 为所有需要自动加载的类定义路径
autoload_files.php 定义所有需要加载的配置文件
autoload_psr4.php 根据 Psr4 规范定义命名空间前缀和路径
autoload_static.php 包含所有需要加载的文件、类,内容包含以上文件
autoload_real.php 自动加载配置
ClassLoader.php 自动加载类
2、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 的规范。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容