Composer 自动加载

composer自动加载的原理先简单描述如下,而后再通过例子说明:

通过在 composer.json 文件中配置需要加载的类、命名空间,通过执行 composer install 命令自动生成类名和对应的类文件的映射,而后通过注册 loadClass 方法,实现对 composer 管理的诸多类的自动加载;

如何在 composer.json 文件中配置类和命名空间 ?

共有四种方式:
PSR-0(网上查到的例子和 PSR-4 没有看出太大区别,且已不推荐使用);
PSR-4;
Class-map;
Files;
在 composer.json 文件中添加以下代码块:

"autoload": {
    "psr-4": {
        "src\\darren\\": "src/",
        "project\\darren\\": "project"
        },
    "files": ["common/Darren.php", "common/Since.php"],
    "classmamp": [lib]
}

测试代码目录结构如下:

common
    Darren.php
    Since.php
lib
    Darren.php
    Since.php
project
    Darren.php
src
    Darren.php
vendor
composer.json
index.php

代码中的命名空间习惯为:目录名 /Darren
当我们配置好 composer.json 文件,并执行 compoer install 命令后,在 vendor/composer 目录下会自动生成一些 php 文件,这些文件实际上记录了类、命名空间和对应的类文件的映射,下面一一举例说明;

PSR-4

如上所述,通过 psr-4 方式配置了两个命名空间的自动加载,分别是 src\daren 和 projecr\darren;vendor/composer 目录下自动生成了 autoload_psr4.php 文件,具体代码如下所示:

<?php

// autoload_psr4.php @generated by Composer

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

return array(
'src\\darren\\' => array($baseDir . '/src'),
'project\\darren\\' => array($baseDir . '/project'),
);
Classmap方式

classmap 方式只需要我们配置需要自动加载的目录,compoer 会自动扫描目录下的的 .php 文件或 .inc 文件中的 class,并自动生成这些类和其对应的类文件的映射关系,保存在 vendor/composer 目录下的 autoload_classmap.php 文件中,具体代码如下:

<?php

// autoload_classmap.php @generated by Composer

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

return array(
'lib\\darren\\Darren' => $baseDir . '/lib/Darren.php',
'lib\\since\\Since' => $baseDir . '/lib/Since.php',
);

其中 lib\darren 为命名空间,Darren 为类名;

Files

files 方式其实就是手动指定要加载的文件,这通常适用于一些全局的 functions,可以将这些 functions 统一放在一个文件里,然后直接进行加载;
上述的配置文件通过files方式加载了两个文件 common/Darren.php 和 common/Since.php,vendor/composer 目录下自动生成了autoload_files.php 文件,具体代码如下所示:

<?php

// autoload_files.php @generated by Composer

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

return array(
'b704865b506bf33e8097e6f62604fc7f' => $baseDir . '/common/Darren.php',
'603921ee67f9053beb44a88f05b115d2' => $baseDir . '/common/Since.php',
);
composer是如何实现自动加载的 ?

配置完 compoer.json 文件,跑完了 composer install 命令,在文件的开始引用 vendor/autolaod.php 即可实现类的自动加载,那么 composer 是如何实现自动加载的呢?


这里先插叙一点php的特性:当调用不存在的类时,系统会自动调用 __autoload( )方法来加载相应的类;

举例子说明如下:
我们在 index.php 文件中调用 Darren 类中的 testAutoload( ) 方法【Darren 类与 index.php 文件在同级目录】,这里我们没有在 index.php 文件中引入 Darren 类,那么肯定是会报错的;但是我们可以重写 __autoload( )方法实现 Darren 类的加载,具体代码如下:

//当调用不存在的类时,系统自动调用__autolaod()查找
function __autolaod($class)
{
    $file = $class . '.php';
    if (is_file($file)) {
        require_once($file);
    }
}
Darren::testAutoload();

我们也可以通过 spl_autoload_register( ) 方法来注册一个其它方法来替代 __autoload( );

举例如下:

function loader($class)
{
    $file = $class . '.php';
    if (is_file($file)) {
        require_once($file);
    }
}
spl_autoload_register('loader');
Darren::testAutoload();

这样,loader方法就取代了 __autoload;


接下来我们继续研究 composer 背后的加载机制,autoload.php 中引入了autoload_real.php 然后调用了getLoader( )方法,getLoader( )方法具体代码如下:

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

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

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

    //整理通过psr-4方式配置的类
    $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配置的类
    $includeFiles = require __DIR__ . '/autoload_files.php';
    foreach ($includeFiles as $fileIdentifier => $file) {
        composerRequire0a8197b9e4da93df051721eff8ed7b28($fileIdentifier, $file);
    }

    return $loader;
}

该方法先是创建了一个 ClassLoader 类的对象,然后加载 composer 自动生成的那些记录类、命名空间与文件映射关系的文件,调用 ClassLoader 中的方法对这些文件整理,并将映射关系通过数组保存,数组的键为类名或者命名空间加类名,数组的值为类对应的类文件地址;这里值得注意的一点是,我们通过files配置的那些需要自动加载的类,是直接将类文件引入进来,并不是在调用时才去加载,代码如下:

function composerRequire0a8197b9e4da93df051721eff8ed7b28($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;//直接引入类文件
        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
     }
}

ClassLoader类中值得注意的方法:

通过 register 方法注册 loadClass 方法,取代 __autoload( )方法,实现类的加载

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

loadClass 方法查找类对应的文件,并引入:

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

具体如何查找数组从而得到该类对应的类文件,可以通过 xdebug 跟一遍代码,并不难理解;

资源里上传了示例代码,也可以通过百度云盘自取pan.baidu.com/s/1i6eEHLz

本作品采用《CC 协议》,转载必须注明作者和本文链接
本帖由系统于 5年前 自动加精
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 2

谢谢楼主提供的demo, "classmap":["lib"] 少了引号

{
  "require": {
    "monolog/monolog": "1.0.*"
  },

  "autoload": {
    "psr-4": {
      "src\\darren\\": "src/",
      "project\\darren\\": "project"
    },
    "files":["common/Darren.php", "common/Since.php"],
    "classmap":["lib"]
  }
}
6年前 评论

这里有问题
{
"require": {
"monolog/monolog": "1.0.*"
},

"autoload": {
"psr-4": {
"src\darren\": "src/",
"project\darren\": "project"
},
"files":["common/Darren.php", "common/Since.php"],
"classmap":["lib"]
}
}

改成
{
"require": {
"monolog/monolog": "1.0.*"
},

"autoload": {
"psr-4": {
"src\": "src/",
"project\": "project"
},
"files":["common/Darren.php", "common/Since.php"],
"classmap":["lib"]
}
}

才行,目录有点问题。

file
这是我的目录结构

5年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!