当前位置：首页 > PHP教程 > php高级应用 > 列表

PHP管理依赖(dependency)关系工具 Composer的自动加载（autoload）

发布:smiling　来源: PHP粉丝网 　添加日期：2021-04-02 16:17:39　浏览: 评论：0　

Composer 是PHP的一个包依赖管理工具，类似Ruby中的RubyGems或者Node中的NPM，它并非官方，但现在已经非常流行。此文并不介绍如何使用Composer，而是关注于它的autoload的内容吧。

举例来说，假设我们的项目想要使用 monolog 这个日志工具，就需要在composer.json里告诉composer我们需要它：

  1. { 
  2.  "require": { 
  3.   "monolog/monolog": "1.*" 
  4.  } 
  5. } 

之后执行：

php composer.phar install

好，现在安装完了，该怎么使用呢？Composer自动生成了一个autoload文件，你只需要引用它

require '/path/to/vendor/autoload.php';

然后就可以非常方便的去使用第三方的类库了，是不是感觉很棒啊！对于我们需要的monolog，就可以这样用了：

  1. use Monolog\Logger; 
  2. use Monolog\Handler\StreamHandler; 
  3. // create a log channel 
  4. $log = new Logger('name'); 
  5. $log->pushHandler(new StreamHandler('/path/to/log/log_name.log', Logger::WARNING)); 
  6. // add records to the log 
  7. $log->addWarning('Foo'); 
  8. $log->addError('Bar'); 

在这个过程中，Composer做了什么呢？它生成了一个autoloader，再根据各个包自己的autoload配置，从而帮我们进行自动加载的工作。（如果对autoload这部分内容不太了解，可以看我之前的 一篇文章）接下来让我们看看Composer是怎么做的吧。

对于第三方包的自动加载，Composer提供了四种方式的支持，分别是 PSR-0和PSR-4的自动加载（我的一篇文章也有介绍过它们)，生成class-map，和直接包含files的方式。

PSR-4是composer推荐使用的一种方式，因为它更易使用并能带来更简洁的目录结构。在composer.json里是这样进行配置的：

  1. { 
  2.   "autoload": { 
  3.     "psr-4": { 
  4.       "Foo\\": "src/", 
  5.     } 
  6.   } 
  7. } 

key和value就定义出了namespace以及到相应path的映射。按照PSR-4的规则，当试图自动加载 "Foo\\Bar\\Baz" 这个class时，会去寻找 "src/Bar/Baz.php" 这个文件，如果它存在则进行加载。注意， "Foo\\"

并没有出现在文件路径中，这是与PSR-0不同的一点，如果PSR-0有此配置，那么会去寻找

"src/Foo/Bar/Baz.php"

这个文件。

另外注意PSR-4和PSR-0的配置里，"Foo\\"结尾的命名空间分隔符必须加上并且进行转义，以防出现"Foo"匹配到了"FooBar"这样的意外发生。

在composer安装或更新完之后，psr-4的配置换被转换成namespace为key，dir path为value的Map的形式，并写入生成的 vendor/composer/autoload_psr4.php 文件之中。

  1. { 
  2.   "autoload": { 
  3.     "psr-0": { 
  4.       "Foo\\": "src/", 
  5.     } 
  6.   } 
  7. } 

最终这个配置也以Map的形式写入生成的

vendor/composer/autoload_namespaces.php

文件之中。

Class-map方式，则是通过配置指定的目录或文件，然后在Composer安装或更新时，它会扫描指定目录下以.php或.inc结尾的文件中的class，生成class到指定file path的映射，并加入新生成的 vendor/composer/autoload_classmap.php 文件中，。

  1. { 
  2.   "autoload": { 
  3.     "classmap": ["src/", "lib/", "Something.php"] 
  4.   } 
  5. } 

例如src/下有一个BaseController类，那么在autoload_classmap.php文件中，就会生成这样的配置:

'BaseController' => $baseDir . '/src/BaseController.php'

Files方式，就是手动指定供直接加载的文件。比如说我们有一系列全局的helper functions，可以放到一个helper文件里然后直接进行加载

  1. { 
  2.   "autoload": { 
  3.     "files": ["src/MyLibrary/functions.php"] 
  4.   } 
  5. } 

它会生成一个array，包含这些配置中指定的files，再写入新生成的

vendor/composer/autoload_files.php

文件中，以供autoloader直接进行加载。

下面来看看composer autoload的代码吧

  1. <?php 
  2. // autoload_real.php @generated by Composer 
  3. class ComposerAutoloaderInit73612b48e6c3d0de8d56e03dece61d11 
  4. { 
  5.   private static $loader; 
  6.   public static function loadClassLoader($class) 
  7.   { 
  8.  if ('Composer\Autoload\ClassLoader' === $class) { 
  9.    require __DIR__ . '/ClassLoader.php'; 
  10.  } 
  11.   } 
  12.   public static function getLoader() 
  13.   { 
  14.  if (null !== self::$loader) { 
  15.    return self::$loader; 
  16.  } 
  17.  spl_autoload_register(array('ComposerAutoloaderInit73612b48e6c3d0de8d56e03dece61d11', 'loadClassLoader'), true, true); 
  18.  self::$loader = $loader = new \Composer\Autoload\ClassLoader(); 
  19.  spl_autoload_unregister(array('ComposerAutoloaderInit73612b48e6c3d0de8d56e03dece61d11', 'loadClassLoader')); 
  20.  $vendorDir = dirname(__DIR__); //verdor第三方类库提供者目录 
  21.  $baseDir = dirname($vendorDir); //整个应用的目录 
  22.  $includePaths = require __DIR__ . '/include_paths.php'; 
  23.  array_push($includePaths, get_include_path()); 
  24.  set_include_path(join(PATH_SEPARATOR, $includePaths)); 
  25.  $map = require __DIR__ . '/autoload_namespaces.php'; 
  26.  foreach ($map as $namespace => $path) { 
  27.    $loader->set($namespace, $path); 
  28.  } 
  29.  $map = require __DIR__ . '/autoload_psr4.php'; 
  30.  foreach ($map as $namespace => $path) { 
  31.    $loader->setPsr4($namespace, $path); 
  32.  } 
  33.  $classMap = require __DIR__ . '/autoload_classmap.php'; 
  34.  if ($classMap) { 
  35.    $loader->addClassMap($classMap); 
  36.  } 
  37.  $loader->register(true); 
  38.  $includeFiles = require __DIR__ . '/autoload_files.php'; 
  39.  foreach ($includeFiles as $file) { 
  40.    composerRequire73612b48e6c3d0de8d56e03dece61d11($file); 
  41.  } 
  42.  return $loader; 
  43.   } 
  44. } 
  45. function composerRequire73612b48e6c3d0de8d56e03dece61d11($file) 
  46. { 
  47.   require $file; 
  48. } 

首先初始化ClassLoader类，然后依次用上面提到的4种加载方式来注册/直接加载，ClassLoader的一些核心代码如下：

  1. /** 
  2.   * @param array $classMap Class to filename map 
  3.   */ 
  4.  public function addClassMap(array $classMap) 
  5.  { 
  6.   if ($this->classMap) { 
  7.    $this->classMap = array_merge($this->classMap, $classMap); 
  8.   } else { 
  9.    $this->classMap = $classMap; 
  10.   } 
  11.  } 
  12.  /** 
  13.   * Registers a set of PSR-0 directories for a given prefix, 
  14.   * replacing any others previously set for this prefix. 
  15.   * 
  16.   * @param string  $prefix The prefix 
  17.   * @param array|string $paths The PSR-0 base directories 
  18.   */ 
  19.  public function set($prefix, $paths) 
  20.  { 
  21.   if (!$prefix) { 
  22.    $this->fallbackDirsPsr0 = (array) $paths; 
  23.   } else { 
  24.    $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths; 
  25.   } 
  26.  } 
  27.  /** 
  28.   * Registers a set of PSR-4 directories for a given namespace, 
  29.   * replacing any others previously set for this namespace. 
  30.   * 
  31.   * @param string  $prefix The prefix/namespace, with trailing '\\' 
  32.   * @param array|string $paths The PSR-4 base directories 
  33.   * 
  34.   * @throws \InvalidArgumentException 
  35.   */ 
  36.  public function setPsr4($prefix, $paths) 
  37.  { 
  38.   if (!$prefix) { 
  39.    $this->fallbackDirsPsr4 = (array) $paths; 
  40.   } else { 
  41.    $length = strlen($prefix); 
  42.    if ('\\' !== $prefix[$length - 1]) { 
  43.     throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator."); 
  44.    } 
  45.    $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length; 
  46.    $this->prefixDirsPsr4[$prefix] = (array) $paths; 
  47.   } 
  48.  } 
  49.  /** 
  50.   * Registers this instance as an autoloader. 
  51.   * 
  52.   * @param bool $prepend Whether to prepend the autoloader or not 
  53.   */ 
  54.  public function register($prepend = false) 
  55.  { 
  56.   spl_autoload_register(array($this, 'loadClass'), true, $prepend); 
  57.  } 
  58.  /** 
  59.   * Loads the given class or interface. 
  60.   * 
  61.   * @param string $class The name of the class 
  62.   * @return bool|null True if loaded, null otherwise 
  63.   */ 
  64.  public function loadClass($class) 
  65.  { 
  66.   if ($file = $this->findFile($class)) { 
  67.    includeFile($file); 
  68.    return true; 
  69.   } 
  70.  } 
  71.  /** 
  72.   * Finds the path to the file where the class is defined. 
  73.   * 
  74.   * @param string $class The name of the class 
  75.   * 
  76.   * @return string|false The path if found, false otherwise 
  77.   */ 
  78.  public function findFile($class) 
  79.  { 
  80.   //这是PHP5.3.0 - 5.3.2的一个bug 详见https://bugs.php.net/50731 
  81.   if ('\\' == $class[0]) { 
  82.    $class = substr($class, 1); 
  83.   } 
  84.   // class map 方式的查找 
  85.   if (isset($this->classMap[$class])) { 
  86.    return $this->classMap[$class]; 
  87.   } 
  88.   //psr-0/4方式的查找 
  89.   $file = $this->findFileWithExtension($class, '.php'); 
  90.   // Search for Hack files if we are running on HHVM 
  91.   if ($file === null && defined('HHVM_VERSION')) { 
  92.    $file = $this->findFileWithExtension($class, '.hh'); 
  93.   } 
  94.   if ($file === null) { 
  95.    // Remember that this class does not exist. 
  96.    return $this->classMap[$class] = false; 
  97.   } 
  98.   return $file; 
  99.  } 
  100.  private function findFileWithExtension($class, $ext) 
  101.  { 
  102.   // PSR-4 lookup 
  103.   $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext; 
  104.   $first = $class[0]; 
  105.   if (isset($this->prefixLengthsPsr4[$first])) { 
  106.    foreach ($this->prefixLengthsPsr4[$first] as $prefix => $length) { 
  107.     if (0 === strpos($class, $prefix)) { 
  108.      foreach ($this->prefixDirsPsr4[$prefix] as $dir) { 
  109.       if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) { 
  110.        return $file; 
  111.       } 
  112.      } 
  113.     } 
  114.    } 
  115.   } 
  116.   // PSR-4 fallback dirs 
  117.   foreach ($this->fallbackDirsPsr4 as $dir) { 
  118.    if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) { 
  119.     return $file; 
  120.    } 
  121.   } 
  122.   // PSR-0 lookup 
  123.   if (false !== $pos = strrpos($class, '\\')) { 
  124.    // namespaced class name 
  125.    $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1) 
  126.     . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR); 
  127.   } else { 
  128.    // PEAR-like class name 
  129.    $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext; 
  130.   } 
  131.   if (isset($this->prefixesPsr0[$first])) { 
  132.    foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) { 
  133.     if (0 === strpos($class, $prefix)) { 
  134.      foreach ($dirs as $dir) { 
  135.       if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { 
  136.        return $file; 
  137.       } 
  138.      } 
  139.     } 
  140.    } 
  141.   } 
  142.   // PSR-0 fallback dirs 
  143.   foreach ($this->fallbackDirsPsr0 as $dir) { 
  144.    if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) { 
  145.     return $file; 
  146.    } 
  147.   } 
  148.   // PSR-0 include paths. 
  149.   if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) { 
  150.    return $file; 
  151.   } 
  152.  } 
  153.  
  154. /** 
  155.  * Scope isolated include. 
  156.  * 
  157.  * Prevents access to $this/self from included files. 
  158.  */ 
  159. function includeFile($file) 
  160. { 
  161.  include $file; 
  162. } 

 

Tags: dependency Composer autoload

分享到：

相关文章

推荐文章

热门文章

最新评论文章