【轉】Composer入門,composer入門
Java有Maven, Node.js有npm, ROR有gem, 這些語言的程式員在開心地使用包管理工具加速開發效率時,PHPer們還在複製粘貼的黑暗中。PHP在Composer之前,包管理的曆史不堪回首。
在相當長的一段時間內,如果應用依賴於第三方庫,PHPer需要拷貝這些庫的原始碼, 或者通過PEAR、PECL安裝。如果第三方庫又依賴於更多的第三方庫,那麼很快就會進入依賴的黑洞。直到Composer出現,PHPer們看到了屬於PHP的包管理的曙光。
下面將以建立一個電商網站為例,介紹Composer的使用方法。
設定檔
在我們開始一個項目的時候,首先會給項目取一個名字,我們暫且叫絲綢之路吧,代號silk。首先要寫一個Composer的設定檔,來描述項目,為此,在項目的根目錄下,建立檔案名稱為composer.json的設定檔。內容如下:
{"name": "meta/silk","description": "another e-commerce website","keywords": ["silk", "online shop", "good"],"homepage": "http://www.xxx.com ","time": "2014-12-30","license": "MIT","authors": [ { "name": "Elvis Lim", "email": "elvis@xxx.com", "homepage": "http://www.xxx.com", "role": "Engineer" }]}
如果您熟悉JSON格式,那麼上面這段內容不言而喻。事實上,這些索引值對都是可選的。也就是說,可以都不寫。但是如果要把項目打包成公用包發布,那麼這些還是需要寫上的,給你的包取個名字總不為過。讓我們來過一下這些索引值對的意義吧。
"name": "meta/silk",
name, 表示包的名稱。如果你經常在Github上混,那這個值的表達方式一定非常熟悉啦。解釋下,通常包名包含兩部分,並且以 / 分隔。斜杆前面部分,代表包的所有者。目前大部分的包作者都喜歡用Github的使用者名稱作為這部分的值。斜杆後面部分代表包的名稱。盡量保持簡單和有意義 些,便於記憶和傳播。大部分情況下,很多人會用Github的程式碼程式庫名稱來命名,當然,這種情況下,代碼要存在Github比較有意義。
"description": "another e-commerce website",
應用簡介,這部分盡量簡潔介紹下項目,別長篇大論。如果確實有很多話要說,那麼可以寫在README.md檔案裡。
"keywords": ["silk", "online shop", "good"],
關鍵詞的值是一個字串數組,在發布成公用庫的是時候,作為中繼資料資訊,有利於包的搜尋和發現。
"homepage": "http://www.xxx.com ",
首頁,可以放你想放的任何頁面地址。
"license": "MIT",
如果你決定將包公開發布,那麼記得選擇一個合適的許可證。這樣別的程式員在引用包的時候,通過查看許可證,確保沒有法律上的問題。
"authors":[{}]
作者欄位可以包含一個對象數組,也就是說可以提供多個作者資訊。
目前為止,都是關於包本身的資訊描述。作為一個電商網站,能夠寄送電子郵件、匯出訂單到Excel表是基本需求,這個時候自然想到了使用現有的庫來 實現這些功能。要擷取這些庫,最簡單的方式是,搜尋下這些庫,找到下載地址,下載個zip包,然後解壓到相應目錄下,根據文檔引入相應的檔案。使用 Composer,可以更加自動和優雅地完成這個過程,這就是Composer的依賴管理。
依賴管理
在composer.json檔案裡增加一個新的欄位:require。這個欄位的值是一個對象,同樣以索引值對的形式構成。以上述提到的兩個依賴位置,寫成composer管理的方式如下:
“require”: {"swiftmailer/swiftmailer": 5.3.*@dev,"phpoffice/phpexcel": "dev-master"}
以swiftmailer為例,swiftmailer/swiftmailer 代表的是包名稱,5.3.@dev , 是版本資訊。合起來的意思就是說,我們將要開發的應用,依賴於swiftmailer的5.3.版本。其中:
5.3.*表示,可以使用5.3.1版本,也可以使用5.3.2版本,composer在擷取的時候,將尋找5.3版本下最新的版本。版本號碼支援一 些更加寬泛的約束,比如>=1.0, >=1.0, <2.0,更加具體的資訊可以查看:http://docs.phpcomposer.com/01-basic-usage.md#The- require-Key
@dev表示可以擷取開發版本。通常,開發版本意味非穩定版本,很可能存在bug。穩定性標籤可以作用於特定的依賴項,也可以作用於全域。
作用特定依賴項:預設情況下,composer只會擷取穩定版本,如果這個例子我們不加@dev約束,而5.3.*版本都是開發版本,那麼在擷取的時候composer就會報錯,指出改版本不符合要求。如果確定這個開發版本沒有問題,那麼就可以通過加@dev ,讓Composer擷取這個開發版本。
全域穩定性設定:通過設定minimum-stability的值,來告訴Composer當前開發的項目的依賴要求的包的全域穩定性層級,它的值包括:dev、alpha、beta、RC、stable,stable是預設值。
至此,兩個依賴添加完畢,我們可以運行下Composer封裝更新命令,看看效果啦。
composer install
成功運行完畢,會在根目錄下發現vendor檔案夾,裡麵包含了剛剛我們列出來的兩個包檔案代碼。
require-dev
有時候,我們會發現,有些包依賴只會在開發過程中使用,正式發布的程式不需要這些包,這個時候,就需要用到另外一個鍵,即require-dev。例如,我們想用codeception進行單元測試,那麼就可以通過require-dev引入這個開發環境下的依賴包:
“require-dev”: {"codeception/codeception": "2.0.0 "}
加了這個依賴後,再運行下命令看看效果。
composer install
自動載入
自此,composer已經幫我們把需要的庫檔案下載下來啦,接下去想到的就是如何引用這些庫檔案。最簡單的方式就是require或者 include,但這就不夠高大上了啊,需要花時間去庫檔案裡查看需要引入哪些檔案,費事而且容易出錯。好在composer可以幫我們解決這個問題。那 就是autoload。
在運行完composer install命令後,怎麼調用PHPExcel庫呢?很簡單,只要引入vendor目錄下的autoload.php檔案就可以了。可以在根目錄下,建一個index.php檔案,加入一下內容:
include “vendor/autoload.php”$excel = new PHPExcel();var_dump($excel);
用瀏覽器訪問一下這個頁面,就會發現PHPExcel對象已經被成功建立啦,是不是很方便?
其實到目前為止,我們並沒用在composer.json檔案裡加入autoload欄位,那麼什麼時候需要加入呢? 那就是當我們想讓composer幫我們自動載入我們自己定義的類的時候。例如,我們自己寫了個訂單管理類,取名OrderManager,放在lib目 錄下的OrderManager.php檔案裡。內容如下:
class OrderManager{ public function test() { echo "hello"; }}
那麼如何讓composer幫我們自動載入這個類呢? 在composer.json裡加入下面的內容:
“autoload”:{ "files":["lib/OrderManager.php"]}
files鍵對應的值是一個數組,數組元素是檔案的路徑,路徑是相對於應用的根目錄。加上上述內容後,運行命令:
composer dump-autoload
讓composer重建自動載入的資訊,完成之後,就可以在index.php裡調用OrderManager類啦。
通過檔案引入的方法雖然直觀,但是很費勁,每個檔案都得引入一次,實在不是好的解決辦法。有沒有更好的辦法呢?嘗試將autoload的值改成:
"classmap":["lib"]
再此運行composer dump-autoload,嘗試調用,依然能夠成功建立OrderManager類。其實,classmap通過建立類到檔案的對應關係,當程式需要 OrderManager類時,compoer的自動載入類通過尋找OrderManager類所在的檔案,然後再將改檔案include進來。因此,這 又導致了一個問題,那就是每加一個新類,就需要運行一次composer dump-autoload來建立類到檔案到對應關係,比files方法雖然好一點,但是還是很不夠舒爽啊!於是,PSR-0出場了。先瞭解下什麼是 PSR-0。
FIG組織制定的一組PHP相關規範,簡稱PSR,其中
PSR-0自動載入
PSR-1基本代碼規範
PSR-2代碼樣式
PSR-3日誌介面
PSR-4 自動載入
目前就這五個規範,乍一看,PSR-0和PSR-4是重複了,實際上,在功能上確實有所重複。區別在於PSR-4的規範比較乾淨,去除了相容PHP 5.3以前版本的內容,有一點PSR-0升級版的感覺。當然,PSR-4也不是要完全替代PSR-0,而是在必要的時候補充PSR-0——當然,如果你願意,PSR-4也可以替代PSR-0。PSR-4可以和包括PSR-0在內的其他自動載入機制共同使用。
PSR-0規範的具體內容見:https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-0.md
PSR-4規範的具體內容見:https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-4-autoloader.md
簡而言之,就是希望通過一組約定的目錄,檔案名稱,類名定義方式,來實現快速通過類尋找到檔案,然後包含進來,實現自動載入。
PSR-4和PSR-0最大的區別是對底線(underscore)的定義不同。PSR-4中,在類名中使用底線沒有任何特殊含義。而PSR-0則規定類名中的底線_會被轉化成目錄分隔字元。
不管是PSR-0還是PSR-4,都要求有個命名空間,所以我們需要對OrderManager類進行一些小的修改,加上命名空間:
namespace SilkLib;class OrderManager{ public function test() { echo "hello"; } }
同時,檔案夾的結構也要修改成:應用根目錄\lib\SilkLib\OrderManager.php
然後修改composer.json裡的autoload部分如下:
"autoload":{ "psr-0":{ "SilkLib":"lib/" }}
這裡需要注意的是,SlikLib是命名空間,lib是目錄名,他們的組合告訴composer,檔案搜尋是在:lib/SilkLib/ 目錄下,而不是在 SilkLib/lib 目錄下,這一點要特別注意,有點繞,容易弄錯。
如果我們把命名空間改成 Slik\lib, 相應的目錄結構要改成:應用根目錄\lib\Silk\lib\OrderManager.php,autoload部分的寫法相應的也要改成:
"autoload":{ "psr-0":{ "Silk\\lib":"lib/" }}
注意Silk\lib是雙斜杆。好了,那我們試試再加一個類,然後不用運行composer dump-autoload命令,看看新類是否能載入上。在lib目錄下,新增一個ShipManager.php檔案,內容如下:
namespace Silk\lib;class ShipManager{ public function test() { echo 'hello ship class'; }}
嘗試在index.php檔案中調用:
$orderMgr = new Silk\lib\OrderManager();$orderMgr->test();$shipMgr = new Silk\lib\ShipManager();$shipMgr->test();
運行成功,說明使用psr-0規範進行自動載入,比classmap更加方便。下面試試psr-4方式,整理下目錄結構,改成:應用根目錄\lib\OrderManager.php,修改命名空間為Silk, 修改autoload部分為:
"autoload":{ "psr-4":{ "Silk":"lib" }}
嘗試調用,發現報錯Fatal error: Uncaught exception 'InvalidArgumentException' with message 'A non-empty PSR-4 prefix must end with a namespace separator. 提示要加上分隔字元,那就加上吧:
"autoload":{ "psr-4":{ "Silk\\":"lib" }}
再次composer dump-autoload,運行測試,OK通過!
掌握require和autoload部分,其實就算Compoer入門啦,在詳細的內容,可以通過查看composer文檔來瞭解。Happy Coding!
原文轉於:http://my.oschina.net/u/248080/blog/359008
感謝原著
http://www.bkjia.com/PHPjc/1104656.htmlwww.bkjia.comtruehttp://www.bkjia.com/PHPjc/1104656.htmlTechArticle【轉】Composer入門,composer入門 Java有Maven, Node.js有npm, ROR有gem, 這些語言的程式員在開心地使用包管理工具加速開發效率時,PHPer們還在複製...