程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> 關於PHP編程 >> 【轉】Composer入門,composer入門

【轉】Composer入門,composer入門

編輯:關於PHP編程

【轉】Composer入門,composer入門


Java有Maven, Node.js有npm, ROR有gem, 這些語言的程序員在開心地使用包管理工具加速開發效率時,PHPer們還在復制粘貼的黑暗中。PHP在Composer之前,包管理的歷史不堪回首。

在相當長的一段時間內,如果應用依賴於第三方庫,PHPer需要拷貝這些庫的源代碼, 或者通過PEAR、PECL安裝。如果第三方庫又依賴於更多的第三方庫,那麼很快就會進入依賴的黑洞。直到Composer出現,PHPer們看到了屬於PHP的包管理的曙光。

下面將以創建一個電商網站為例,介紹Composer的使用方法。

配置文件

在我們開始一個項目的時候,首先會給項目取一個名字,我們暫且叫絲綢之路吧,代號silk。首先要寫一個Composer的配置文件,來描述項目,為此,在項目的根目錄下,建立文件名為composer.json的配置文件。內容如下:

<!-- lang: js -->
{
"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":        "[email protected]",
        "homepage":     "http://www.xxx.com",
        "role":         "Engineer"
    }
]}

如果您熟悉JSON格式,那麼上面這段內容不言而喻。事實上,這些鍵值對都是可選的。也就是說,可以都不寫。但是如果要把項目打包成公共包發布,那麼這些還是需要寫上的,給你的包取個名字總不為過。讓我們來過一下這些鍵值對的意義吧。

<!-- lang: js -->
"name":             "meta/silk",

name, 表示包的名稱。如果你經常在Github上混,那這個值的表達方式一定非常熟悉啦。解釋下,通常包名包含兩部分,並且以 / 分隔。斜桿前面部分,代表包的所有者。目前大部分的包作者都喜歡用Github的用戶名作為這部分的值。斜桿後面部分代表包的名稱。盡量保持簡單和有意義 些,便於記憶和傳播。大部分情況下,很多人會用Github的代碼庫名稱來命名,當然,這種情況下,代碼要存在Github比較有意義。

<!-- lang: js -->
"description":      "another e-commerce website",

應用簡介,這部分盡量簡潔介紹下項目,別長篇大論。如果確實有很多話要說,那麼可以寫在README.md文件裡。

<!-- lang: js -->
"keywords":         ["silk", "online shop", "good"],

關鍵詞的值是一個字符串數組,在發布成公用庫的是時候,作為元數據信息,有利於包的搜索和發現。

<!-- lang: js -->
"homepage":         "http://www.xxx.com ",

主頁,可以放你想放的任何頁面地址。

<!-- lang: js -->
"license": "MIT",

如果你決定將包公開發布,那麼記得選擇一個合適的許可證。這樣別的程序員在引用包的時候,通過查看許可證,確保沒有法律上的問題。

<!-- lang: js -->
 "authors":[{}]

作者字段可以包含一個對象數組,也就是說可以提供多個作者信息。

目前為止,都是關於包本身的信息描述。作為一個電商網站,能夠發送電子郵件、導出訂單到Excel表是基本需求,這個時候自然想到了使用現有的庫來 實現這些功能。要獲取這些庫,最簡單的方式是,搜索下這些庫,找到下載地址,下載個zip包,然後解壓到相應目錄下,根據文檔引入相應的文件。使用 Composer,可以更加自動和優雅地完成這個過程,這就是Composer的依賴管理。

依賴管理

在composer.json文件裡增加一個新的字段:require。這個字段的值是一個對象,同樣以鍵值對的形式構成。以上述提到的兩個依賴位置,寫成composer管理的方式如下:

<!-- lang: js -->
“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包更新命令,看看效果啦。

<!-- lang: shell -->
composer install

成功運行完畢,會在根目錄下發現vendor文件夾,裡面包含了剛剛我們列出來的兩個包文件代碼。

require-dev

有時候,我們會發現,有些包依賴只會在開發過程中使用,正式發布的程序不需要這些包,這個時候,就需要用到另外一個鍵,即require-dev。例如,我們想用codeception進行單元測試,那麼就可以通過require-dev引入這個開發環境下的依賴包:

<!-- lang: js -->
“require-dev”: {
"codeception/codeception": "2.0.0 "
}

加了這個依賴後,再運行下命令看看效果。

<!-- lang: shell -->
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裡加入下面的內容:

<!-- lang: js -->
“autoload”:{
    "files":["lib/OrderManager.php"]
}

files鍵對應的值是一個數組,數組元素是文件的路徑,路徑是相對於應用的根目錄。加上上述內容後,運行命令:

<!-- lang: js -->
composer dump-autoload

讓composer重建自動加載的信息,完成之後,就可以在index.php裡調用OrderManager類啦。

通過文件引入的方法雖然直觀,但是很費勁,每個文件都得引入一次,實在不是好的解決辦法。有沒有更好的辦法呢?嘗試將autoload的值改成:

<!-- lang: js -->
 "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部分如下:

<!-- lang: js -->
"autoload":{
    "psr-0":{
        "SilkLib":"lib/"
    }
}

這裡需要注意的是,SlikLib是命名空間,lib是目錄名,他們的組合告訴composer,文件搜索是在:lib/SilkLib/ 目錄下,而不是在 SilkLib/lib 目錄下,這一點要特別注意,有點繞,容易弄錯。

如果我們把命名空間改成 Slik\lib, 相應的目錄結構要改成:應用根目錄\lib\Silk\lib\OrderManager.php,autoload部分的寫法相應的也要改成:

<!-- lang: js -->
"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. 提示要加上分隔符,那就加上吧:

<!-- lang: js -->
"autoload":{
    "psr-4":{
        "Silk\\":"lib"
    }
}

再次composer dump-autoload,運行測試,OK通過!

掌握require和autoload部分,其實就算Compoer入門啦,在詳細的內容,可以通過查看composer文檔來了解。Happy Coding!

原文轉於:http://my.oschina.net/u/248080/blog/359008

感謝原著

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved