Composer自动装载机制入门

刚刚学习Composer,觉得自动装载机制很神奇,就学习了一下,下面是学习过程的记录,供大家参考,不当之处,多多包涵。

一、Composer的安装

Windows10环境,在线方式安装和简单了,这里就不说了。我是采用离线方式安装成功的,记录一下过程。

(1)下载composer.phar,这是二进制程序,在Composer的官网https://www.phpcomposer.com/就可以下载最新版本。

(2)在C:盘新建一个composer目录,并将composer.phar拷贝到该目录下。

(3)在composer目录下,创建composer.bat文件,文件内容如下:

@php "%~dp0composer.phar" %*

(4)添加系统环境的路径变量,添加composer目录和PHP的执行目录。

(5)执行composer --version命令,显示成功即安装成功,效果如图所示。

需要说明的是,如果在任意目录下要执行composer命令,就需要确保php的目录在操作系统环境的路径变量中。

二、composer.json文件简介

Composer工具通过composer.json文件来生成所需要的依赖,并生成自动装载所需要的代码。

该文件内容由一对大括号{}包含,是json格式,其中核心的要素包括require键和autoload键,当然了,对于程序员而言autoload键尤其重要,它决定程序自动装载的方式,也是本文介绍的重点。

(1)require键

核心键值require,描述系统的依赖关系,如要求的php版本,其他的PHP程序包等。

一个例子如下,第一条说明本程序依赖monolog程序包,版本是1.0版本;第二条说明本程序依赖的PHP版本号。

  "require": {

  "monolog/monolog": "1.0.*"

        "php": ">=7.2.0"

    }

(2)autoload键

核心键autoload决定程序自动装载的方式,有4种装载方式(PSR-4方式、PSR-0方式、classmap方式、静态文件方式),例如一个PSR-4标准的装载要求如下描述。后面再详细解释其中的含义。

"autoload":  {

        "psr-4": {

                 "comtest\\":  "src/"

        }

},

一个完整的示例composer.json文件内容如下:

{

        "name":"haha/website",

        "description":"Project  haha",

        "minimum-stability":  "stable",

        "autoload": {

                 "psr-4": {

                     "haha\\": "src/"

                }      

        },

                 "require":{

                 "php":  ">=7.2.0"

        }

}

三、生成Composer自动装载文件

在haha目录下,执行命令composer dumpautoload -o,生成自动装载PHP程序,命令如图所示。

生成程序后的情况,如图所示,多了vendor目录,在该目录下有一个文件autoload.php。

四、PSR-4标准自动装载

最简单来讲就是可以把PSR-4的namespace直接成文件结构。

一个完整的类名需具有以下结构: \<命名空间>(\<子命名空间>)*\<类名>,其中子命令空间是可选的。

(1)完整的类名必须要有一个顶级命名空间,被称为 “vendor namespace”;

(2)完整的类名可以有一个或多个子命名空间;

(3)完整的类名必须有一个最终的类名;

(4)完整的类名中任意一部分中的下滑线都是没有特殊含义的;

(5)完整的类名可以由任意大小写字母组成;

(6)所有类名都必须是大小写敏感的。

当根据完整的类名载入相应的文件时,要求如下:

(1)完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为“命名空间前缀”,其必须与至少一个“文件基目录”相对应;(这句话的意思就是目录结构和命令空间前缀一致)

(2)紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配,其中的命名空间分隔符将作为目录分隔符。

(3)末尾的类名必须与对应的以.php为后缀的文件同名。

(4)自动加载器(autoloader)的实现一定不能抛出异常、一定不能触发任一级别的错误信息以及不应该有返回值。

文件composer.json中的"psr-4":

{"haha\\": "src/"}表示,安装PSR-4标准,顶级名字空间是haha,对应的根目录是haha项目根目录(也就是haha目录)下的src目录。

一个PSR-4的例子,就是在src目录下新建一个文件Haha.php(因为类Haha首字母大写),在该文件中建立一个Haha类,文件内容如下:

namespace haha;

class Haha{

        public  function hello(){

                 return  "Hello world !!";

        }

}

这里用了名字空间haha,表示是haha名字空间下的类。这个类就可以在其他地方开始用了。

在开始用Haha类之前,必须先启动Composer的自动装载程序,这里在Web目录下创建一个index.php文件,内容如下:

require __DIR__ .  "\../vendor/autoload.php";

use haha\Haha;

$obj=new Haha();

echo $obj->hello();

访问index.php,效果如图所示。

五、文件方式自动装载

文件方式自动装载就是在composer.json文件中的autoload项添加files选项,一个例子如下:

{

        "name":"haha/website",

        "description":"Project  haha",

        "minimum-stability":  "stable",

        "autoload":  {

                 "psr-4":  {

                     "haha\\": "src/"

                 },

                 "files":["functions/f1.php"]

        },

                 "require":{

                 "php":  ">=7.2.0"

        }

}

在autoload配置项目中有"files":["functions/f1.php"],指明了包含文件functions/f1.php,就是包含路径为haha/functions/f1.php的文件。

执行composer命令composer dumpautoload -o,生成所需要的自动装载代码,这时候,查看文件autoload_static.php中多了如下的代码:

public static $files = array (

        '0e3a8ced368a654b8e2d0a6b9a3fdb1f'  => __DIR__ . '/../..' . '/functions/f1.php',

  );

显然就是将文件/functions/f1.php包含到项目中来了,项目中就不要在添加包含文件的操作了。

在functions目录下,新建f1.php代码如下:

function f1(){

        print("
functions,f1....
");

        return;

}

修改index.php文件,访问函数f1,修改后的代码如下:

require __DIR__ .  "\../vendor/autoload.php";

use haha\Haha;

$obj=new Haha();

echo $obj->hello();

f1();

访问index.php,效果如图所示。

六、PSR-0标准自动装载

PSR-0自动装载也是一种自动装载方式,只是标准和PSR-4不一样。PSR-0标准的要求如下:

(1)命名空间必须与绝对路径一致

(2)类名首字母必须大写

(3)除去入口文件外,其他“.php”必须只有一个类

(4)php类文件必须自动载入,不采用include等

(5)单一入口

包含PSR-0标准的composer.json文件内容如下,这里指定了haha\\other名字空间按照psr-0标准,对应的代码根目录在othersrc目录里。

{

        "name":"haha/website",

        "description":"Project  haha",

        "minimum-stability":  "stable",

        "autoload": {

                 "psr-4": {

                     "haha\\": "src/"

                 },

                 "files":["functions/f1.php"],

                 "psr-0":{"haha\\other\\":"othersrc"}

        },

                 "require":{

                 "php":  ">=7.2.0"

        }

}

执行composer命令composer dumpautoload -o,生成所需要的自动装载代码,这时候,查看文件autoload_static.php中多了如下的代码:

public  static $prefixesPsr0 = array (

    'h' =>

  array (

        'haha\\other\\' =>

        array (

  0 => __DIR__ . '/../..' . '/othersrc',

  ),

    ),

);

创建一个新的othersrc目录,如果想创建一个命名空间为haha\other的类Aclass,则需要再othersrc目录下创建haha目录,然后在haha目录下创建other目录,这里可以看出来,haha和other目录有些重复了,这就是psr-4优化的地方。在other目录下创建新的文件Aclass.php,内容如下:

namespace haha\other;

class Aclass{

        public  function testa(){

                 print("haha\other\class,Aclass,testa......
");

        }

}

这时候,可以在index.php文件中使用Aclass了,修改后的index.php代码如下:

require  __DIR__ . "\../vendor/autoload.php";

use  haha\Haha;

use  haha\other\Aclass;

$obj=new  Haha();

echo  $obj->hello();

f1();

$a=new  Aclass();

$a->testa();

访问index.php,效果如图所示。

六、Class-map方式自动装载

Class-map方式顾名思义就是为类和其定义文件建立一个映射,这样的方式非常简单了。

通过composer.json中的Class-map方式配置一个根目录,Composer自动遍历该目录,并建立类和文件的映射关系。一个包含Class-map自动装载的composer.json文件内容如下:

{

        "name":"haha/website",

        "description":"Project  haha",

        "minimum-stability":  "stable",

        "autoload":  {

                 "psr-4":  {

                     "haha\\": "src/"

                 },

                 "files":["functions/f1.php"],

                 "psr-0":{"haha\\other\\":"othersrc"},

                 "classmap":["classmap/"]

        },

                 "require":{

                 "php":  ">=7.2.0"

        }

}

在项目根目录haha下,创建一个新的目录classmap,并在该目录下创建两个文件test1.php和test2.php。

文件test1.php内容如下:

class  Test1{

        public function test(){

                 print("classmap,Test1,test......
");

        }

}

文件test2.php内容如下:

class Test2{

        public  function test(){

                 print("classmap,Test2,test......
");

        }

}

执行composer命令composer dumpautoload -o,生成所需要的自动装载代码,这时候,查看文件autoload_static.php中多了如下的代码:

public  static $classMap = array (

    'Test1' => __DIR__ . '/../..' .  '/classmap/test1.php',

    'Test2' => __DIR__ . '/../..' .  '/classmap/test2.php',

    'haha\\Haha' => __DIR__ . '/../..' .  '/src/Haha.php',

    'haha\\other\\Aclass' => __DIR__ .  '/../..' . '/othersrc/haha/other/Aclass.php',

);

此时,两个文件可以使用了而不需要使用include方式包含进来,修改后的index.php代码如下:

require __DIR__ .  "\../vendor/autoload.php";

use haha\Haha;

use haha\other\Aclass;

$obj=new Haha();

echo $obj->hello();

f1();

$a=new Aclass();

$a->testa();

$t1=new Test1();

$t1->test();

$t2=new Test2();

$t2->test();

访问index.php,效果如图所示。

你可能感兴趣的:(Composer自动装载机制入门)