PHP包管理器Composer实现原理


PHP包管理器Composer实现原理

文章插图
【PHP包管理器Composer实现原理】 
 
Composer是用php开发的用来管理项目依赖的工具,当你在项目中声明了依赖关系后,composer可以自动帮你下载和安装这些依赖库,并实现自动加载代码 。
定义一个composer.json:
{ "name": "gitlib/composer", "require":{"predis/predis":"1.1.1" }}输入命令 composer install,composer会帮我们自动下载predis库,依赖库会默认放在项目的vendor目录下 。
├── composer.json├── composer.lock├── index.php└── vendor ├── autoload.php ├── composer │ ├── ClassLoader.php │ ├── LICENSE │ ├── autoload_classmap.php │ ├── autoload_namespaces.php │ ├── autoload_psr4.php │ ├── autoload_real.php │ ├── autoload_static.php │ └── installed.json └── predis └── prediscomposer不仅仅帮我们处理依赖,还帮我们实现了自动加载 。在vendor目录下有一个autoload.php, 只要在我们的项目中引入这个文件就可以自动加载依赖库 。
<?phprequire 'vendor/autoload.php';$client = new PredisClient();$client->set('foo', 'bar');$value = https://www.isolves.com/it/cxkf/yy/php/2019-10-15/$client->get('foo');echo $value;可以看到Predis库完全不需要我们手动去加载,只需要require 'vendor/autoload.php',composer的自动加载机制会帮我们找到对应的文件并加载 。
对于依赖库,composer帮我们处理好了自动加载, 那对于其他的类库,如何实现自动加载呢?
composer支持四种自动加载的方式:Files/Classmap/PSR-0/ PSR-4, 其中PSR-4是当前推荐的加载方式 。
FilesFiles 是最简单的加载方式,这种方式不管加载的文件是否用到始终都会加载,而不是按需加载, 修改项目根目下的composer.json, 加入 “autoload” 项:
{ "name": "gitlib/composer", "require":{"predis/predis":"1.1.1" }, "autoload":{"files":["Controller/User.php"] }}files键对应的值是一个数组,数组元素是文件的路径,路径是相对于应用的根目录 。加上上述内容后,运行命令:
composer dump-autoload
让composer重建自动加载的信息,composer会把配置值写入与 Files加载方式对应的 verndorcomposerautoload_files.php配置文件中:
<?php// autoload_files.php @generated by Composer$vendorDir = dirname(dirname(__FILE__));$baseDir = dirname($vendorDir);return array( '7efd69bb86214589340b40039fd363f7' => $baseDir . '/Controller/User.php',);现在就可以在代码中里调用User类了 。
<?phprequire 'vendor/autoload.php';$client = new PredisClient();$user = new ControllerUser();$user->login();Classmapclassmap引用的所有组合,都会在 install/update 过程中生成,并存储到vendor/composer/autoload_classmap.php 文件中 。这个 map 是经过扫描指定目录(同样支持直接精确到文件)中所有的 .php 和 .inc 文件里内置的类而得到的 。
{ "name": "gitlib/composer", "require":{"predis/predis":"1.1.1" }, "autoload":{"classmap":["Controller"] }}Composer会扫描Controller目录下的所有.php和.inc文件,存储到vendor/composer/autoload_classmap.php文件中:
<?php// autoload_classmap.php @generated by Composer$vendorDir = dirname(dirname(__FILE__));$baseDir = dirname($vendorDir);return array( 'Controller\User' => $baseDir . '/Controller/User.php',);PSR-0PSR-0自动加载规范是已经废弃的标准, 不再做说明 。
PSR-4PSR-4是Composer推荐使用的一种方式(关于PSR规范可参考:PHP标准规范PSR),因为它更易使用并能带来更简洁的目录结构 。对于上面的Controller目录我们先改名src:
├── composer.json├── composer.json.bk├── composer.lock├── index.php├── src│ └── User.php└── vendor ├── autoload.php ├── composer └── predis在composer.json中我们将Controller命名空间和src关联起来:
{ "name": "gitlib/composer", "require":{"predis/predis":"1.1.1" }, "autoload":{"psr-4": {"Controller\":"src/"} }}
PSR-4 的命名空间前缀也必须以 \ 结尾,以避免类似前缀间的冲突 。
psr-4中的key和value定义了namespace以及其对应的目录映射 。按照PSR-4的规则,当试图自动加载”ControllerUser”类的使用,会去寻找”src/User.php”这个文件,此时Controller并不会出现在文件路径中 。


推荐阅读