详解composer的自动加载机制

composer是一个用PHP开发的用来管理项目依赖的工具，当你在项目中声明了依赖关系后，composer可以自动帮你下载和安装这些依赖库，并实现自动加载代码。

 

 

安装composer

composer的安装非常的容易

1.下载安装脚本，这里把安装脚本保存为 composer-setup.php

 

2. [root@localhost composer]# php -r "copy('https://install.phpcomposer.com/installer', 'composer-setup.php');"
3. [root@localhost composer]# ls
4. composer-setup.php

2. 然后执行运行安装脚本，然后会生成一个可执行的phar包文件composer.phar（类似java中的.jar包）

 

2. [root@localhost composer]# php composer-setup.php
3. All settings correct for using Composer
4. Downloading...
5.  
6. Composer (version 1.5.2) successfully installed to: /root/composer/composer.phar
7. Use it: php composer.phar
8.  
9. [root@localhost composer]# ls
10. composer.phar composer-setup.php

 

3.执行命令: php composer.phar,  显示如下信息说明安装成功，注意最好不要使用root账户来执行composer命令，否则会报警告：

Do not run Composer as root/super user! See https://getcomposer.org/root for details

 

2. [root@localhost composer]# php composer.phar
3. Do not run Composer as root/super user! See https://getcomposer.org/root for details
4. ______
5. / ____/___ ____ ___ ____ ____ ________ _____
6. / / / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
7. / /___/ /_/ / / / / / / /_/ / /_/ (__ ) __/ /
8. \____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
9. /_/
10. Composer version 1.5.2 2017-09-11 16:59:25
11.  
12. Usage:
13. command [options] [arguments]
14.  
15. Options:
16. -h, --help Display this help message
17. .....
18.  

4. 如果想让composer在任意目录下都可以执行，可以执行命令：mv composer.phar /usr/local/bin/composer ，将 composer.phar 放到系统环境变量之下并重命名为composer,  之后便可以在任意目录使用 composer 来代替 php composer.phar 命令

 

2. [root@localhost composer]# mv composer.phar /usr/local/bin/composer
3. [root@localhost composer]# cd ~
4. [root@localhost ~]# composer
5. Do not run Composer as root/super user! See https://getcomposer.org/root for details
6. ______
7. / ____/___ ____ ___ ____ ____ ________ _____
8. / / / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
9. / /___/ /_/ / / / / / / /_/ / /_/ (__ ) __/ /
10. \____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
11. .....
12.  

 

配置composer使用国内镜像库

由于国内特殊的网络环境，访问国外的官方镜像库往往速度很慢，甚至无响应，所以我们配置使用composer中文网（​​http://www.phpcomposer.com​​）提供的国内镜像库，执行以下命令即可

 

[zyee@localhost root]$ composer config -g repo.packagist composer https://packagist.phpcomposer.com

 

简单的composer.json

假设我们现在的项目根目录为demo，并且我们的项目依赖 monolog(​​https://github.com/Seldaek/monolog​​) 这个php日志库,这时我们可以在项目根目录建立一个 composer.json 文件，并输入以下内容：

 

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

然后输入命令 composer install，composer会帮我们自动下载monolog库，一般依赖库会默认放在项目的vendor目录下

 

2. [root@localhost demo]# ls
3. composer.json
4. [root@localhost demo]# composer install
5. Do not run Composer as root/super user! See https://getcomposer.org/root for details
6. Loading composer repositories with package information
7. Updating dependencies (including require-dev)
8. Package operations: 1 install, 0 updates, 0 removals
9. Failed to download monolog/monolog from dist: The zip extension and unzip command are both missing, skipping.
10. The php.ini used by your command-line PHP is: /etc/php.ini
11. Now trying to download from source
12. - Installing monolog/monolog (1.0.2): Cloning b704c49a30
13. Writing lock file
14. Generating autoload files
15. [root@localhost demo]# ls
16. composer.json composer.lock vendor
17. 
    

composer的自动加载

composer不仅仅帮我们处理依赖，还帮我们实现了自动加载。在vendor目录下有一个autoload.php, 只要在我们的项目中引入这个文件就可以自动加载依赖库。

项目根目录下新建一个index.php, 并输入以下测试代码：

 

2. <?php
3. require 'vendor/autoload.php';
4.  
5. use Monolog\Logger;
6. use Monolog\Handler\StreamHandler;
7.  
8. $log = new Logger('demo');
9. $log->pushHandler(new StreamHandler('app.log', Logger::WARNING));
10. $log->addWarning("this is a warning log!");

测试是否运行正常：

 

2. [root@localhost demo]# php index.php
3. [root@localhost demo]# ls
4. app.log composer.json composer.lock index.php vendor
5. [root@localhost demo]# cat app.log
6. [2017-09-28 00:32:27] demo.WARNING: this is a warning log! [] []

可以看到monolog库完全不需要我们手动去加载，只需要使用正确的命名空间，composer的自动加载机制会帮我们找到对应的文件并加载。

对于依赖库，composer帮我们处理好了自动加载，那对于我们自己的项目文件该怎么实现自动加载呢，比如现在在我的项目根目下创建一个 controllers 目录存放控制器，并在该目录下新建一个Controller.php, 代码如下：

 

2. <?php
3. namespace controllers;
4.  
5. class Controller
6. {
7. public function test()
8. {
9. echo "Controller::test\n";
10. }
11. }

现在如何在index.php中自动加载这个 Controller 类呢，如果我们直接在index.php写

 

2. <?php
3. require 'vendor/autoload.php';
4. use controllers\Controller;
5.  
6. $c = new Controller();
7. $c->test();

 

上面代码肯定是无法找到Controller类的：

2. [root@localhost demo]# php index.php
3. PHP Fatal error: Uncaught Error: Class 'controllers\Controller' not found in /root/demo/index.php:6
4. Stack trace:
5. #0 {main}
6. thrown in /root/demo/index.php on line 6

 

要想解决上述这个问题我们首先需要了解下composer的自动加载机制。

composer支持四种自动加载的方式：PSR-0 / PSR-4 /Classmap / Files , 其中 PSR-4 是当前推荐的加载方式。

 

什么是 PSR ?

PSR 是 PHP Standards Recommendations（PHP 标准建议）的缩写，这是一个叫做 PHP Framework Interop Group(​​http://www.php-fig.org/​​) 的组织所推出的关于PHP编程方面的一些标准建议，这个组织的成员包括一些知名的框架和项目，比如 CakePHP，Drupal，Magento，Symfony，Yii framework，Zend Framework 2等等，当然也包括这里说的 composer，该组织曾推出了一系列的 PSR, 具体的有哪些请参考 ​ ​http://www.php-fig.org/psr/​​ ， 其中 PSR-0 （​​http://www.php-fig.org/psr/psr-0/​​）和 PSR-4（​​http://www.php-fig.org/psr/psr-4/​​）是关于自动加载方面做出的一些规范

 

1. Files 是最简单的加载方式，这种方式不管加载的文件是否用到始终都会加载，而不是按需加载

修改项目根目下的composer.json, 加入 "autoload" 项：

 

2. {
3. "require": {
4. "monolog/monolog": "1.0.*"
5. },
6. "autoload": {
7. "files": ["controllers/Controller.php"]
8. }
9. }

需要加载哪个文件，直接写入文件路径即可，路径相对项目的根目录。然后执行composer dump-autoload，该命令可以遍历我们项目根目录以及各依赖库下的 composer.json 文件然后重新生成 vendor/composer/autoload_* 跟自动加载相关的配置文件

 

2. [root@localhost demo]# composer dump-autoload
3. Do not run Composer as root/super user! See https://getcomposer.org/root for details
4. Generating autoload files

此时composer会帮我们更新自动加载相关的配置文件，composer dump-autoload 之后composer会把配置值写入与 Files加载方式对应的 vendor/composer/autoload_files.php 配置文件中：

2. [root@localhost demo]# cat vendor/composer/autoload_files.php
3. <?php
4.  
5. // autoload_files.php @generated by Composer
6.  
7. $vendorDir = dirname(dirname(__FILE__));
8. $baseDir = dirname($vendorDir);
9.  
10. return array(
11. '0b001b283842589bdffd092a1d29de66' => $baseDir . '/controllers/Controller.php',
12. );

此时再运行index.php就一切正常了

 

2. [root@localhost demo]# php index.php
3. Controller::test

 

2. Classmap 加载方式也很简单，composer会搜寻我们指定的目录或文件，并把搜寻到的结果写到Classmap对应的 vendor/composer/autoload_classmap.php 配置文件中。 修改composer.json :

 

2. {
3. "require": {
4. "monolog/monolog": "1.0.*"
5. },
6. "autoload": {
7. "classmap": ["controllers/"]
8. }
9. }

以上配置会让composer搜寻 controllers 目录下的所有类，并生成配置文件，同样先 composer dump-autoload 下：

 

2. [root@localhost demo]# composer dump-autoload
3. Do not run Composer as root/super user! See https://getcomposer.org/root for details
4. Generating autoload files
5.  
6. [root@localhost demo]# cat vendor/composer/autoload_classmap.php
7. <?php
8.  
9. // autoload_classmap.php @generated by Composer
10.  
11. $vendorDir = dirname(dirname(__FILE__));
12. $baseDir = dirname($vendorDir);
13.  
14. return array(
15. 'controllers\\Controller' => $baseDir . '/controllers/Controller.php',
16. );

 

此时发现之前生成的 vendor/composer/autoload_files.php 配置文件也被 composer 删除了（由于项目中没再使用到Files的加载方式）

 

2. [root@localhost demo]# ll vendor/composer/
3. 总用量 44
4. -rw-r--r-- 1 root root 222 9月 28 01:59 autoload_classmap.php
5. -rw-r--r-- 1 root root 210 9月 28 01:59 autoload_namespaces.php
6. -rw-r--r-- 1 root root 143 9月 28 01:59 autoload_psr4.php
7. -rw-r--r-- 1 root root 1762 9月 28 01:59 autoload_real.php
8. -rw-r--r-- 1 root root 867 9月 28 01:59 autoload_static.php
9. -rw-r--r-- 1 root root 13451 9月 28 01:59 ClassLoader.php
10. -rw-r--r-- 1 root root 1375 9月 28 01:59 installed.json
11. -rw-r--r-- 1 root root 1070 9月 28 01:59 LICENSE

测试结果：

2. [root@localhost demo]# php index.php
3. Controller::test

3. PSR-0 ，这种加载方式已经过时，所以不推荐在新项目中使用，请用 PSR-4 来代替它。修改composer.json 如下, 然后执行composer dump-autoload

2. {
3. "require": {
4. "monolog/monolog": "1.0.*"
5. },
6. "autoload": {
7. "psr-0": {"controllers\\": ""}
8. }
9. }

以上配置的意思是指定 controllers命名空间 所在的父级目录，由于controllers命名空间所在的父级目录就是项目根目录， 所以配置值用 "" ，composer dump-autoload后配置会写入 PSR-0对应的 vendor/composer/autoload_namespaces.php 配置文件中，而且从配置文件中可以看到之前使用的 monolog 也是使用 遵循PSR-0 规范的自动加载

 

2. [root@localhost demo]# composer dump-autoload
3. Do not run Composer as root/super user! See https://getcomposer.org/root for details
4. Generating autoload files
5.  
6. [root@localhost demo]# cat vendor/composer/autoload_namespaces.php
7. <?php
8.  
9. // autoload_namespaces.php @generated by Composer
10.  
11. $vendorDir = dirname(dirname(__FILE__));
12. $baseDir = dirname($vendorDir);
13.  
14. return array(
15. 'controllers\\' => array($baseDir . '/'),
16. 'Monolog' => array($vendorDir . '/monolog/monolog/src'),
17. );
18. [root@localhost demo]# php index.php
19. Controller::test

4. PSR-4  是 PSR-0 的升级版，是目前推荐的自动加载方式，这种方式使用的是按需加载。

修改composer.json　如下：

 

2. {
3. "require": {
4. "monolog/monolog": "1.0.*"
5. },
6. "autoload": {
7. "psr-4": {"controllers\\": "controllers/"}
8. }
9. }

注意和PSR-0 的 composer.json 做对比，PSR-4 和 PSR-0 的主要区别是，PSR-4指定的就当作当前命名空间的目录， 而PSR-0 指定的是当前命名空间的父目录。composer dump-autoload 一下， 配置会写入PSR-4对应的 vendor/composer/autoload_psr4.php 文件中

 

2. [root@localhost demo]# cat vendor/composer/autoload_psr4.php
3. <?php
4.  
5. // autoload_psr4.php @generated by Composer
6.  
7. $vendorDir = dirname(dirname(__FILE__));
8. $baseDir = dirname($vendorDir);
9.  
10. return array(
11. 'controllers\\' => array($baseDir . '/controllers'),
12. );
13.  
14. [root@localhost demo]# php index.php
15. Controller::test

以上就是对composer的四种自动加载方式的简单介绍，这里主要偏向于使用，至于代码的实现，大家可以阅读 vendor/autoload.php 以及 vendor/composer/ 目录下的相关代码，有时间我再单独写一篇composer自动加载机制实现的源码分析^^

That's it!

 

非学，无以致疑；非问，无以广识