Composer自動(dòng)裝載機(jī)制入門(mén)

剛剛學(xué)習(xí)Composer,覺(jué)得自動(dòng)裝載機(jī)制很神奇,就學(xué)習(xí)了一下,下面是學(xué)習(xí)過(guò)程的記錄,供大家參考,不當(dāng)之處,多多包涵。

一、Composer的安裝

Windows10環(huán)境,在線方式安裝和簡(jiǎn)單了,這里就不說(shuō)了。我是采用離線方式安裝成功的,記錄一下過(guò)程。

(1)下載composer.phar,這是二進(jìn)制程序,在Composer的官網(wǎng)https://www.phpcomposer.com/就可以下載最新版本。

(2)在C:盤(pán)新建一個(gè)composer目錄,并將composer.phar拷貝到該目錄下。

(3)在composer目錄下,創(chuàng)建composer.bat文件,文件內(nèi)容如下:

@php "%~dp0composer.phar" %*

(4)添加系統(tǒng)環(huán)境的路徑變量,添加composer目錄和PHP的執(zhí)行目錄。

(5)執(zhí)行composer --version命令,顯示成功即安裝成功,效果如圖所示。

需要說(shuō)明的是,如果在任意目錄下要執(zhí)行composer命令,就需要確保php的目錄在操作系統(tǒng)環(huán)境的路徑變量中。

二、composer.json文件簡(jiǎn)介

Composer工具通過(guò)composer.json文件來(lái)生成所需要的依賴(lài),并生成自動(dòng)裝載所需要的代碼。

該文件內(nèi)容由一對(duì)大括號(hào){}包含,是json格式,其中核心的要素包括require鍵和autoload鍵,當(dāng)然了,對(duì)于程序員而言autoload鍵尤其重要,它決定程序自動(dòng)裝載的方式,也是本文介紹的重點(diǎn)。

(1)require鍵

核心鍵值require,描述系統(tǒng)的依賴(lài)關(guān)系,如要求的php版本,其他的PHP程序包等。

一個(gè)例子如下,第一條說(shuō)明本程序依賴(lài)monolog程序包,版本是1.0版本;第二條說(shuō)明本程序依賴(lài)的PHP版本號(hào)。

? "require": {

? "monolog/monolog": "1.0.*"

???? ???"php": ">=7.2.0"

??? }

(2)autoload鍵

核心鍵autoload決定程序自動(dòng)裝載的方式,有4種裝載方式(PSR-4方式、PSR-0方式、classmap方式、靜態(tài)文件方式),例如一個(gè)PSR-4標(biāo)準(zhǔn)的裝載要求如下描述。后面再詳細(xì)解釋其中的含義。

"autoload":? {

??????? "psr-4": {

???????????????? "comtest\\":? "src/"

??????? }

},

一個(gè)完整的示例composer.json文件內(nèi)容如下:

{

??????? "name":"haha/website",

??????? "description":"Project? haha",

??????? "minimum-stability":? "stable",

??????? "autoload": {

???????????????? "psr-4": {

???????????????? ??? "haha\\": "src/"

??????? ??????? }??????

??????? },

???????????????? "require":{

???????????????? "php":? ">=7.2.0"

??????? }

}

三、生成Composer自動(dòng)裝載文件

在haha目錄下,執(zhí)行命令composer dumpautoload -o,生成自動(dòng)裝載PHP程序,命令如圖所示。

生成程序后的情況,如圖所示,多了vendor目錄,在該目錄下有一個(gè)文件autoload.php。

四、PSR-4標(biāo)準(zhǔn)自動(dòng)裝載

最簡(jiǎn)單來(lái)講就是可以把PSR-4的namespace直接成文件結(jié)構(gòu)。

一個(gè)完整的類(lèi)名需具有以下結(jié)構(gòu): \<命名空間>(\<子命名空間>)*\<類(lèi)名>,其中子命令空間是可選的。

(1)完整的類(lèi)名必須要有一個(gè)頂級(jí)命名空間,被稱(chēng)為 “vendor namespace”;

(2)完整的類(lèi)名可以有一個(gè)或多個(gè)子命名空間;

(3)完整的類(lèi)名必須有一個(gè)最終的類(lèi)名;

(4)完整的類(lèi)名中任意一部分中的下滑線都是沒(méi)有特殊含義的;

(5)完整的類(lèi)名可以由任意大小寫(xiě)字母組成;

(6)所有類(lèi)名都必須是大小寫(xiě)敏感的。

當(dāng)根據(jù)完整的類(lèi)名載入相應(yīng)的文件時(shí),要求如下:

(1)完整的類(lèi)名中,去掉最前面的命名空間分隔符,前面連續(xù)的一個(gè)或多個(gè)命名空間和子命名空間,作為“命名空間前綴”,其必須與至少一個(gè)“文件基目錄”相對(duì)應(yīng);(這句話的意思就是目錄結(jié)構(gòu)和命令空間前綴一致)

(2)緊接命名空間前綴后的子命名空間必須與相應(yīng)的”文件基目錄“相匹配,其中的命名空間分隔符將作為目錄分隔符。

(3)末尾的類(lèi)名必須與對(duì)應(yīng)的以.php為后綴的文件同名。

(4)自動(dòng)加載器(autoloader)的實(shí)現(xiàn)一定不能拋出異常、一定不能觸發(fā)任一級(jí)別的錯(cuò)誤信息以及不應(yīng)該有返回值。

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

{"haha\\": "src/"}表示,安裝PSR-4標(biāo)準(zhǔn),頂級(jí)名字空間是haha,對(duì)應(yīng)的根目錄是haha項(xiàng)目根目錄(也就是haha目錄)下的src目錄。

一個(gè)PSR-4的例子,就是在src目錄下新建一個(gè)文件Haha.php(因?yàn)轭?lèi)Haha首字母大寫(xiě)),在該文件中建立一個(gè)Haha類(lèi),文件內(nèi)容如下:

namespace haha;

class Haha{

??????? public? function hello(){

???????????????? return? "Hello world !!";

??????? }

}

這里用了名字空間haha,表示是haha名字空間下的類(lèi)。這個(gè)類(lèi)就可以在其他地方開(kāi)始用了。

在開(kāi)始用Haha類(lèi)之前,必須先啟動(dòng)Composer的自動(dòng)裝載程序,這里在Web目錄下創(chuàng)建一個(gè)index.php文件,內(nèi)容如下:

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

use haha\Haha;

$obj=new Haha();

echo $obj->hello();

訪問(wèn)index.php,效果如圖所示。

五、文件方式自動(dòng)裝載

文件方式自動(dòng)裝載就是在composer.json文件中的autoload項(xiàng)添加files選項(xiàng),一個(gè)例子如下:

{

??????? "name":"haha/website",

??????? "description":"Project? haha",

??????? "minimum-stability":? "stable",

??????? "autoload":? {

???????????????? "psr-4":? {

???????????????? ??? "haha\\": "src/"

???????????????? },

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

??????? },

???????????????? "require":{

???????????????? "php":? ">=7.2.0"

??????? }

}

在autoload配置項(xiàng)目中有"files":["functions/f1.php"],指明了包含文件functions/f1.php,就是包含路徑為haha/functions/f1.php的文件。

執(zhí)行composer命令composer dumpautoload -o,生成所需要的自動(dòng)裝載代碼,這時(shí)候,查看文件autoload_static.php中多了如下的代碼:

public static $files = array (

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

? );

顯然就是將文件/functions/f1.php包含到項(xiàng)目中來(lái)了,項(xiàng)目中就不要在添加包含文件的操作了。

在functions目錄下,新建f1.php代碼如下:

function f1(){

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

??????? return;

}

修改index.php文件,訪問(wèn)函數(shù)f1,修改后的代碼如下:

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

use haha\Haha;

$obj=new Haha();

echo $obj->hello();

f1();

訪問(wèn)index.php,效果如圖所示。

六、PSR-0標(biāo)準(zhǔn)自動(dòng)裝載

PSR-0自動(dòng)裝載也是一種自動(dòng)裝載方式,只是標(biāo)準(zhǔn)和PSR-4不一樣。PSR-0標(biāo)準(zhǔn)的要求如下:

(1)命名空間必須與絕對(duì)路徑一致

(2)類(lèi)名首字母必須大寫(xiě)

(3)除去入口文件外,其他“.php”必須只有一個(gè)類(lèi)

(4)php類(lèi)文件必須自動(dòng)載入,不采用include等

(5)單一入口

包含PSR-0標(biāo)準(zhǔn)的composer.json文件內(nèi)容如下,這里指定了haha\\other名字空間按照psr-0標(biāo)準(zhǔn),對(duì)應(yīng)的代碼根目錄在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"

??????? }

}

執(zhí)行composer命令composer dumpautoload -o,生成所需要的自動(dòng)裝載代碼,這時(shí)候,查看文件autoload_static.php中多了如下的代碼:

public? static $prefixesPsr0 = array (

??? 'h' =>

? array (

? ??????'haha\\other\\' =>

? ??????array (

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

? ),

??? ),

);

創(chuàng)建一個(gè)新的othersrc目錄,如果想創(chuàng)建一個(gè)命名空間為haha\other的類(lèi)Aclass,則需要再othersrc目錄下創(chuàng)建haha目錄,然后在haha目錄下創(chuàng)建other目錄,這里可以看出來(lái),haha和other目錄有些重復(fù)了,這就是psr-4優(yōu)化的地方。在other目錄下創(chuàng)建新的文件Aclass.php,內(nèi)容如下:

namespace haha\other;

class Aclass{

??????? public? function testa(){

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

??????? }

}

這時(shí)候,可以在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();

訪問(wèn)index.php,效果如圖所示。

六、Class-map方式自動(dòng)裝載

Class-map方式顧名思義就是為類(lèi)和其定義文件建立一個(gè)映射,這樣的方式非常簡(jiǎn)單了。

通過(guò)composer.json中的Class-map方式配置一個(gè)根目錄,Composer自動(dòng)遍歷該目錄,并建立類(lèi)和文件的映射關(guān)系。一個(gè)包含Class-map自動(dòng)裝載的composer.json文件內(nèi)容如下:

{

??????? "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"

??????? }

}

在項(xiàng)目根目錄haha下,創(chuàng)建一個(gè)新的目錄classmap,并在該目錄下創(chuàng)建兩個(gè)文件test1.php和test2.php。

文件test1.php內(nèi)容如下:

class? Test1{

??????? public function test(){

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

??????? }

}

文件test2.php內(nèi)容如下:

class Test2{

??????? public? function test(){

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

??????? }

}

執(zhí)行composer命令composer dumpautoload -o,生成所需要的自動(dòng)裝載代碼,這時(shí)候,查看文件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',

);

此時(shí),兩個(gè)文件可以使用了而不需要使用include方式包含進(jìn)來(lái),修改后的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();

訪問(wèn)index.php,效果如圖所示。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容