Laravel核心技术解析（1）—— Composer 组件管理与自动加载

Composer作为PHP的组件化管理工具，实现了laravel框架的组件安装、更新、移除，以及自动加载功能，下面就深入解析这是如何实现的。

使用Composer安装组件，首先需要创建composer.json文件，composer.json示例如下：
在这里插入图片描述
我的个人博客：逐步前行STEP

该文件定义了项目的基本信息以及所依赖组件的名称、版本、再执行composer install将所依赖组件安装到项目的vendor目录中。完成安装后会自动生成 composer.lock 文件，该文件罗列了各个组件确切的版本以及安装方式：
在这里插入图片描述
当执行composer install时首先检查是否存在该文件，如果存在就下载该文件中能够规定的组件以及版本。

我的个人博客：逐步前行STEP

在安装好组件之后，vendor目录下除了组件目录还会生成一个composer目录，以及自动加载文件autoload.php：
在这里插入图片描述
引入这个文件，就可以实现自动加载了，可以直接在项目中使用组件。看一下该文件的具体内容：

仅仅2行代码，只做了一件事：引入composer/autoload_real.php文件，也就是说，实际上实现了自动加载的代码都在composer目录中，进入该目录：
在这里插入图片描述
先查看autoload_real.php，其中被audoload.php 执行的静态函数代码如下：

我的个人博客：逐步前行STEP

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

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

    ......
    }

在这个方法中，spl_autoload_register 函数用于注册给定的函数作为 __autoload 的实现，上述代码注册的__autoload实现是loadClassLoader方法：

    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }

该方法引入了ClassLoader.php，随后 getLoader() 方法实例化ClassLoader 并且使用spl_autoload_unregister注销了该__autoload实现，之后的二十多行代码实现了自动加载，在解析这部分代码之前，需要先了解php规范：

PSR 是 PHP Standard Recommendations （PHP 推荐标准）的简写，由 PHP FIG 组织制定的 PHP 规范，是 PHP 开发的实践标准。其中：
   PSR-0：自动加载标准，2014-10-21该标准已经被废弃，使用PSR-4替    代，不再细讲
   PSR-4：自动加载

PSR-0 和 PSR-4 的自动加载规范，虽然PSR-0已经弃用，但是Composer仍然兼容PSR-0，具体规范如下：
1、PSR-0

一个标准的命名空间 (namespace) 与类 (class) 名称的定义必须符合以下结构： <Vendor Name>(<Namespace>)*<Class Name>；

其中 Vendor Name 为每个命名空间都必须要有的一个顶级命名空间名；
需要的话，每个命名空间下可以拥有多个子命名空间；
当根据完整的命名空间名从文件系统中载入类文件时，每个命名空间之间的分隔符都会被转换成文件夹路径分隔符；
类名称中的每个 字符也会被转换成文件夹路径分隔符，而命名空间中的 字符则是无特殊含义的。
当从文件系统中载入标准的命名空间或类时，都将添加 .php 为目标文件后缀；
组织名称(Vendor Name)、命名空间(Namespace) 以及类的名称(Class Name) 可由任意大小写字母组成。

范例：

DoctrineCommonIsolatedClassLoader => /path/to/project/lib/vendor/Doctrine/Common/IsolatedClassLoader.php
namespacepackageClass_Name => /path/to/project/lib/vendor/namespace/package/Class/Name.php

namespacepackage_nameClass_Name => /path/to/project/lib/vendor/namespace/package_name/Class/Name.php

2、PSR-4

1、术语「class」指的是类（classes）、接口（interfaces）、特征（traits）和其他类似的结构。
2、全限定类名具有以下形式：

 \<NamespaceName>(\<SubNamespaceNames>)*\<ClassName>
 2.1、全限定类名必须拥有一个顶级命名空间名称，也称为供应商命名空间（vendor namespace）。
2.2、全限定类名可以有一个或者多个子命名空间名称。
2.3、全限定类名必须有一个最终的类名（我想意思应该是你不能这样 \<NamespaceName>(\<SubNamespaceNames>)*\ 来表示一个完整的类）。
2.4、下划线在全限定类名中没有任何特殊含义（在 PSR-0 中下划是有含义的）。
2.5、全限定类名可以是任意大小写字母的组合。
2.6、所有类名的引用必须区分大小写。

我的个人博客：逐步前行STEP

范例：

全限定类名	命名空间前缀	根目录	对应的文件路径
AcmeLogWriterFile_Writer	AcmeLogWriter	./acme-log-writer/lib/	./acme-log-writer/lib/File_Writer.php
AuraWebResponseStatus	AuraWeb	/path/to/aura-web/src/	/path/to/aura-web/src/Response/Status.php

而在composer.josn文件中，autoload 键下定义了当前组件的自动加载实现方式，就包含了psr-4、psr-0：

    "autoload": {
        ......
        "psr-4": {
            "App\\": "app/",
            "ApolloPY\\Flysystem\\AliyunOss\\": "packages/apollopy/flysystem-aliyun-oss/src/",
            "Thrift\\": "packages/php/lib/",
        },
        "psr-0": {
          "Maatwebsite\\Excel\\": "src/"
        }
        ......
    },

了解上述PSR规范的基础后，我们再回到Composer自动加载的引导类的getLoader() 方法来，接着看实例化了核心类 ClassLoader 之后的代码：

public static function getLoader()
    {
        ......

        $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';

            call_user_func(\Composer\Autoload\ComposerStaticInit67db7509c61e60a4f92e012c704d3566::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);

        if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInit67db7509c61e60a4f92e012c704d3566::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequire67db7509c61e60a4f92e012c704d3566($fileIdentifier, $file);
        }

        return $loader;
    }

这部分代码先是判断当前版本是否>=5.6 ，且不是HHVM虚拟机，满足条件则引入autoload_static.php 进行初始化：

call_user_func(\Composer\Autoload\ComposerStaticInit67db7509c61e60a4f92e012c704d3566::getInitializer($loader));

autoload_static.php文件中，定义了5个数组：

在这里插入图片描述
我的个人博客：逐步前行STEP

依次是：
1、全局文件列表

......
    public static $files = array (
        '0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => __DIR__ . '/..' . '/symfony/polyfill-mbstring/bootstrap.php',
        '1d1b89d124cc9cb8219922c9d5569199' => __DIR__ . '/..' . '/hamcrest/hamcrest-php/hamcrest/Hamcrest.php',
        '667aeda72477189d0494fecd327c3641' => __DIR__ . '/..' . '/symfony/var-dumper/Resources/functions/dump.php',
        'a0edc8309cc5e1d60e3047b5df6b7052' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/functions_include.php',
......

2、PSR-4规范的顶级命名空间=》路径映射的索引列表，这个列表是二维数组，第一维以首字母为键，第二维以命名空间为为键，值是命名空间的长度：

    ......
    public static $prefixLengthsPsr4 = array (
        'p' => 
        array (
            'phpDocumentor\\Reflection\\' => 25,
        ),
        'h' => 
        array (
            'hegzh\\AliyunCore\\' => 17,
            'h4cc\\WKHTMLToPDF\\' => 17,
        ),
        ......

该数组以首字母为键是为了方便查找，而最终的值是命名空间长度则是为了在$prefixDirsPsr4数组中查找到命名空间之后替换
3、PSR-4规范的顶级命名空间=》路径的映射列表

    ......
    public static $prefixDirsPsr4 = array (
        'phpDocumentor\\Reflection\\' => 
        array (
            0 => __DIR__ . '/..' . '/phpdocumentor/reflection-common/src',
            1 => __DIR__ . '/..' . '/phpdocumentor/reflection-docblock/src',
            2 => __DIR__ . '/..' . '/phpdocumentor/type-resolver/src',
        ),
    ......

4、PSR-0规范的顶级命名空间与路径的映射列表，该列表同样是以首字母为键：

    ......
    public static $prefixesPsr0 = array (
        'S' => 
        array (
            'SimpleSoftwareIO\\QrCode\\' => 
            array (
                0 => __DIR__ . '/..' . '/simplesoftwareio/simple-qrcode/src',
            ),
        ),
    ......

5、composer.json中classmap方式定义的自动加载目录：

    public static $classMap = array (
        'Adbar\\Dot' => __DIR__ . '/..' . '/adbario/php-dot-notation/src/Dot.php',

否则，引入autoload_namespaces.php、autoload_psr4.php、autoload_classmap.php 这三个文件。

autoload_namespaces.php 文件文件指定了顶级命名空间到file path的映射：
在这里插入图片描述
autoload_psr4.php文件同样是指定了顶级命名空间到file path的映射，和autoload_namespaces.php的区别在于，autoload_namespaces.php是写入了composer.json中设置了psr-0规范的命名空间与路径映射，如：

......
"autoload": {
    "classmap": [
      "src/Maatwebsite/Excel"
    ],
    "psr-0": {
      "Maatwebsite\\Excel\\": "src/"
    }
  },
......

autoload_psr4.php是写入了composer.json中设置了psr-4规范的命名空间与路径映射，如：

......
    "autoload": {
        "psr-4": {
            "ProductAI\\": "src/"
        }
    },
......

而autoload_classmap.php文件，则是在Composer安装、更新或者执行composer dump-autoload 时会扫描autoload_psr4.php、autoload_namespaces.php文件中定义的顶级命名空间对应的目录以及composer.json中设置了classmap自动加载方式的目录，如：

    ......
    "autoload": {
        "classmap": [
            "database",
            "app/Interfaces"
        ],
    ......

扫描各个目录下的php文件并且将文件中的类名与当前目录映射写入该文件，如：

<?php

// autoload_classmap.php @generated by Composer

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

return array(
    ......
    'AlibabaCloud\\Aas\\V20150701\\AasApiResolver' => $vendorDir . '/alibabacloud/sdk/src/Aas/V20150701/AasApiResolver.php',
    'AlibabaCloud\\Aas\\V20150701\\CreateAccessKeyForAccount' => $vendorDir . '/alibabacloud/sdk/src/Aas/V20150701/AasApiResolver.php',
    'AlibabaCloud\\Aas\\V20150701\\CreateAliyunAccount' => $vendorDir . '/alibabacloud/sdk/src/Aas/V20150701/AasApiResolver.php',
    'AlibabaCloud\\Aas\\V20150701\\CreateAliyunAccountWithBindHid' => $vendorDir . '/alibabacloud/sdk/src/Aas/V20150701/AasApiResolver.php',
    ......
);

引入这三个文件之后，ClassLoader对象将文件中的映射设置到对应的属性中：

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

接着，ClassLoader对象调用了register()方法注册了__autoload实现：

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

而这个loadClass()方法的工作原理其实是在ClassLoader对象的设置了类名与路径的属性中查找并且引入文件：

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

            return true;
        }
    }
......

到这一步，自动加载的主要工作已经完成了，但是Composer 不止可以自动加载命名空间，还可以加载全局函数，根据是否版本>=5.6且不是HHVM虚拟机，分为静态初始化和动态初始化：

if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInit67db7509c61e60a4f92e012c704d3566::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequire67db7509c61e60a4f92e012c704d3566($fileIdentifier, $file);
        }

我的个人博客：逐步前行STEP

以上就是自动加载的核心功能，总结一下，主要流程如下：
1、引入autoload.php
2、引入autoload_real.php
3、注册loadClassLoader作为自动加载实现，并实例化 ClassLoader，而后注销loadClassLoader
4、版本>=5.6且未使用HHVM则使用静态初始化，否则引入autoload_namespaces.php、autoload_psr4.php、autoload_classmap.php将类名=》路径的映射设置到ClassLoader对象属性中
5、注册 loadClass 作为自动加载实现，loadClass的实现原理就是在类名=》路径的映射中查找并引入文件
6、将全局函数文件遍历引入

Laravel核心技术解析（1）—— Composer 组件管理与自动加载

添加新评论

最新文章

最近回复

分类

归档

其它