首页 后端开发 php教程 PHP管理依赖(dependency)关系工具 Composer的自动加载(autoload)_php技巧

PHP管理依赖(dependency)关系工具 Composer的自动加载(autoload)_php技巧

May 16, 2016 pm 08:38 PM
autoload composer php 自动加载

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

{
 "require": {
  "monolog/monolog": "1.*"
 }
}
登录后复制

之后执行:

php composer.phar install

登录后复制

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

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

登录后复制

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

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

登录后复制

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

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

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

{
  "autoload": {
    "psr-4": {
      "Foo\\": "src/",
    }
  }
}
登录后复制

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 文件之中。

{
  "autoload": {
    "psr-0": {
      "Foo\\": "src/",
    }
  }
}
登录后复制

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

vendor/composer/autoload_namespaces.php

文件之中。

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

{
  "autoload": {
    "classmap": ["src/", "lib/", "Something.php"]
  }
}
登录后复制

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

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

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

{
  "autoload": {
    "files": ["src/MyLibrary/functions.php"]
  }
}
登录后复制

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

vendor/composer/autoload_files.php

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

下面来看看composer autoload的代码吧

<&#63;php
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit73612b48e6c3d0de8d56e03dece61d11
{
  private static $loader;
  public static function loadClassLoader($class)
  {
 if ('Composer\Autoload\ClassLoader' === $class) {
   require __DIR__ . '/ClassLoader.php';
 }
  }
  public static function getLoader()
  {
 if (null !== self::$loader) {
   return self::$loader;
 }
 spl_autoload_register(array('ComposerAutoloaderInit73612b48e6c3d0de8d56e03dece61d11', 'loadClassLoader'), true, true);
 self::$loader = $loader = new \Composer\Autoload\ClassLoader();
 spl_autoload_unregister(array('ComposerAutoloaderInit73612b48e6c3d0de8d56e03dece61d11', 'loadClassLoader'));
 $vendorDir = dirname(__DIR__); //verdor第三方类库提供者目录
 $baseDir = dirname($vendorDir); //整个应用的目录
 $includePaths = require __DIR__ . '/include_paths.php';
 array_push($includePaths, get_include_path());
 set_include_path(join(PATH_SEPARATOR, $includePaths));
 $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);
 $includeFiles = require __DIR__ . '/autoload_files.php';
 foreach ($includeFiles as $file) {
   composerRequire73612b48e6c3d0de8d56e03dece61d11($file);
 }
 return $loader;
  }
}
function composerRequire73612b48e6c3d0de8d56e03dece61d11($file)
{
  require $file;
}

登录后复制

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

/**
  * @param array $classMap Class to filename map
  */
 public function addClassMap(array $classMap)
 {
  if ($this->classMap) {
   $this->classMap = array_merge($this->classMap, $classMap);
  } else {
   $this->classMap = $classMap;
  }
 }
 /**
  * Registers a set of PSR-0 directories for a given prefix,
  * replacing any others previously set for this prefix.
  *
  * @param string  $prefix The prefix
  * @param array|string $paths The PSR-0 base directories
  */
 public function set($prefix, $paths)
 {
  if (!$prefix) {
   $this->fallbackDirsPsr0 = (array) $paths;
  } else {
   $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
  }
 }
 /**
  * Registers a set of PSR-4 directories for a given namespace,
  * replacing any others previously set for this namespace.
  *
  * @param string  $prefix The prefix/namespace, with trailing '\\'
  * @param array|string $paths The PSR-4 base directories
  *
  * @throws \InvalidArgumentException
  */
 public function setPsr4($prefix, $paths)
 {
  if (!$prefix) {
   $this->fallbackDirsPsr4 = (array) $paths;
  } else {
   $length = strlen($prefix);
   if ('\\' !== $prefix[$length - 1]) {
    throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
   }
   $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
   $this->prefixDirsPsr4[$prefix] = (array) $paths;
  }
 }
 /**
  * Registers this instance as an autoloader.
  *
  * @param bool $prepend Whether to prepend the autoloader or not
  */
 public function register($prepend = false)
 {
  spl_autoload_register(array($this, 'loadClass'), true, $prepend);
 }
 /**
  * Loads the given class or interface.
  *
  * @param string $class The name of the class
  * @return bool|null True if loaded, null otherwise
  */
 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)
 {
  //这是PHP5.3.0 - 5.3.2的一个bug 详见https://bugs.php.net/50731
  if ('\\' == $class[0]) {
   $class = substr($class, 1);
  }
  // class map 方式的查找
  if (isset($this->classMap[$class])) {
   return $this->classMap[$class];
  }
  //psr-0/4方式的查找
  $file = $this->findFileWithExtension($class, '.php');
  // Search for Hack files if we are running on HHVM
  if ($file === null && defined('HHVM_VERSION')) {
   $file = $this->findFileWithExtension($class, '.hh');
  }
  if ($file === null) {
   // Remember that this class does not exist.
   return $this->classMap[$class] = false;
  }
  return $file;
 }
 private function findFileWithExtension($class, $ext)
 {
  // PSR-4 lookup
  $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;
  $first = $class[0];
  if (isset($this->prefixLengthsPsr4[$first])) {
   foreach ($this->prefixLengthsPsr4[$first] as $prefix => $length) {
    if (0 === strpos($class, $prefix)) {
     foreach ($this->prefixDirsPsr4[$prefix] as $dir) {
      if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
       return $file;
      }
     }
    }
   }
  }
  // PSR-4 fallback dirs
  foreach ($this->fallbackDirsPsr4 as $dir) {
   if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
    return $file;
   }
  }
  // PSR-0 lookup
  if (false !== $pos = strrpos($class, '\\')) {
   // namespaced class name
   $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
    . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
  } else {
   // PEAR-like class name
   $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
  }
  if (isset($this->prefixesPsr0[$first])) {
   foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
    if (0 === strpos($class, $prefix)) {
     foreach ($dirs as $dir) {
      if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
       return $file;
      }
     }
    }
   }
  }
  // PSR-0 fallback dirs
  foreach ($this->fallbackDirsPsr0 as $dir) {
   if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
    return $file;
   }
  }
  // PSR-0 include paths.
  if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
   return $file;
  }
 }

/**
 * Scope isolated include.
 *
 * Prevents access to $this/self from included files.
 */
function includeFile($file)
{
 include $file;
}

登录后复制

本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

AI Hentai Generator

AI Hentai Generator

免费生成ai无尽的。

热门文章

R.E.P.O.能量晶体解释及其做什么(黄色晶体)
1 个月前 By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O.最佳图形设置
1 个月前 By 尊渡假赌尊渡假赌尊渡假赌
威尔R.E.P.O.有交叉游戏吗?
1 个月前 By 尊渡假赌尊渡假赌尊渡假赌

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

如何使用Composer快速搭建LaravelCMS:mki-labs/espresso的实战经验 如何使用Composer快速搭建LaravelCMS:mki-labs/espresso的实战经验 Apr 18, 2025 am 07:36 AM

在开发一个新的Laravel项目时,我遇到了一个棘手的问题:如何快速搭建一个功能齐全且易于管理的内容管理系统(CMS)。我尝试了多种解决方案,但都因为复杂的配置和不便的维护而放弃。直到我发现了mki-labs/espresso这个LaravelCMS包,它不仅安装简单,还提供了强大的功能和直观的管理界面,彻底解决了我的问题。

解决数据库连接问题:使用minii/db库的实际案例 解决数据库连接问题:使用minii/db库的实际案例 Apr 18, 2025 am 07:09 AM

在开发一个小型应用时,我遇到了一个棘手的问题:需要快速集成一个轻量级的数据库操作库。尝试了多个库后,我发现它们要么功能过多,要么兼容性不佳。最终,我找到了minii/db,这是一个基于Yii2的简化版本,完美地解决了我的问题。

使用Symfony/Console库创建高效命令行接口的实践经验 使用Symfony/Console库创建高效命令行接口的实践经验 Apr 18, 2025 am 07:30 AM

在项目开发中,经常需要创建命令行工具来简化日常任务或自动化流程。然而,创建一个美观且易于测试的命令行接口并非易事。最近,我在开发一个需要命令行工具的项目时遇到了这个问题。经过一番探索,我找到了Symfony/Console库,它大大简化了命令行接口的创建过程。

使用Composer解决依赖注入:PSR-11容器接口的应用 使用Composer解决依赖注入:PSR-11容器接口的应用 Apr 18, 2025 am 07:39 AM

在开发一个大型PHP项目时,我遇到了一个常见但棘手的问题:如何有效地管理和注入依赖。最初,我尝试使用全局变量和手动注入,但这不仅增加了代码的复杂度,还容易导致错误。最终,我通过使用PSR-11容器接口,并借助Composer的强大功能,成功解决了这个问题。

如何使用Composer解决Yii框架下的数据批量处理问题 如何使用Composer解决Yii框架下的数据批量处理问题 Apr 18, 2025 am 07:54 AM

在开发Yii框架项目时,常常会遇到需要从数据库中获取大量数据的情况。如果不采取适当的措施,直接获取所有数据可能会导致内存溢出,影响程序性能。最近在处理一个大型电商平台的项目时,我遇到了这种问题,经过一番研究和尝试,最终通过pavle/yii-batch-result这个扩展库解决了难题。

如何使用 Composer 解决 HTTP 请求问题:yiche/http 库的实用指南 如何使用 Composer 解决 HTTP 请求问题:yiche/http 库的实用指南 Apr 18, 2025 am 08:06 AM

在开发过程中,经常需要处理HTTP请求,这可能是为了获取数据、发送数据或者与外部API交互。然而,当面对复杂的网络环境和多变的请求需求时,如何高效地处理HTTP请求成为了一个挑战。我曾在一个项目中遇到过这样的问题:需要频繁地向不同的API发送请求,同时还要记录这些请求的日志,以便于后续的调试和分析。尝试了几种方法后,我发现了yiche/http这个库,它不仅简化了HTTP请求的处理,还提供了动态日志记录的功能,极大地提升了开发效率。

使用Composer解决对象枚举问题:Sebastian/Object-Enumerator的实践 使用Composer解决对象枚举问题:Sebastian/Object-Enumerator的实践 Apr 18, 2025 am 06:18 AM

在处理复杂的数据结构时,我们常常需要遍历数组和对象图以枚举所有引用的对象。最近在开发一个项目时,我遇到了这样的需求:需要对一个包含多层嵌套的对象结构进行全面的对象枚举。尝试了几种方法后,我发现这些方法效率低下且难以维护。最终,我找到了Sebastian/Object-Enumerator这个库,它完美地解决了我的问题。

如何使用AppErrorManager优雅地处理API错误 如何使用AppErrorManager优雅地处理API错误 Apr 18, 2025 am 06:48 AM

在开发一个RESTAPI项目时,我遇到了一个常见却棘手的问题:如何有效地捕获和处理API调用中的错误和异常。最初,我尝试使用传统的方法在代码中逐个处理错误,但这不仅增加了代码的复杂度,还难以维护和扩展。幸运的是,我找到了一个名为AppErrorManager的工具,它通过集中管理错误信息和错误码,显着简化了我的工作流程。

See all articles