【Composer】PHP開發者必須瞭解！

Composer是一個很是流行的PHP包依賴管理工具,已經取代PEAR包管理器,對於PHP開發者來講掌握Composer是必須的.

對於使用者來講Composer很是的簡單,經過簡單的一條命令將須要的代碼包下載到vendor目錄下,而後開發者就能夠引入包並使用了.

其中的關鍵在於你項目定義的composer.json,能夠定義項目須要依賴的包(可能有多個),而依賴的包可能又依賴其餘的包(這就是組件的好處),這些都不用你煩心,Composer會自動下載你須要的一切,一切在於composer.json的定義.

Composer對於使用者來講是很透明,可是其背後的理念仍是須要了解一下的,其的誕生也不是偶然的,得益於Github的快速發展,PHP語言也愈來愈現代化,顯得更高大上了.

更多PHP相關知識請關注個人專欄PHP​zhuanlan.zhihu.com

爲了理解Composer,先大概瞭解下其結構:

Composer的結構

Composer命令行工具:

這個理解就比較簡單了,經過使用者定義的Composer.json去下載你須要的代碼,假如只是簡單的使用Composer,那麼掌握一些具體命令就徹底能夠了

Autoloading代碼加載器:

經過Composer,開發者能夠經過多種方式去使用,而其中的關鍵在於PHP的命名空間概念,以及PSR-4標準的發展,Composer只是根據這兩者開發了一個代碼自動加載器

Github:

有了Github,PHP開發人員能夠將開源的代碼託管在這上面,而Composer的發展源於Github,Composer本質上就是將Github上的代碼下載到本地.

Packagist:

對於使用者來講使用的是Composer的命令行工具,那麼命令行工具怎麼知道有多少包能夠被用戶使用呢,這主要就是依賴於Packagist,Packagist是Composer主要的一個包信息存儲庫,包開發者將具體代碼託管到Github上,將包信息提交到Packagist上,這樣使用者就能夠經過Composer去使用.

Composer根據本地定義的composer.json信息去查詢Packagist,Packagist根據Composer.json/Package.json信息解析,最終對應到github倉庫,Composer最終下載代碼的時候還要依賴於Github倉庫上的Composer.json,這裏涉及到三種類型的composer.json,含義是不同的.

Composer.json:

這是Composer的核心,是Composer的規則,上面也提到了三種類型的Composer.json,在使用的時候必定要注意區分,我初學的時候就老是搞亂.

Composer命令行工具

composer init

使用者能夠在本身的項目下建立composer.json以便定義你項目的依賴包,也能夠經過composer init交互式的建立composer.json.

composer install

應該是最經常使用的命令,composer會根據本地的composer.json安裝包,將下載的包放入項目下的vendor目錄下,同時將安裝時候的包版本信息放入到composer.lock,以便鎖定版本.

其實在install的時候,假如發現composer.lock版本和目前vendor目錄下的代碼版本是一致的,則Composer會什麼也不作,composer.lock的目的就是讓你安心在目前這個版本下工做,而不獲取最新版本的包.

composer update

那麼如何更新composer.lock以便獲取到最新版本的包呢?經過這個命令便可更新最新版本的包

composer config

這個命令仍是建議瞭解下,全局的配置保存在COMPOSER_HOME/config.json,非全局的配置信息則存儲在本項目目錄下.

composer config --list -g

composer config -g notify-on-install false

composer global config bin-dir --absolute

composer create-project

這個命令不經常使用,可是我的以爲仍是很重要的,使用普通的install命令是將項目全部的依賴包下載到本項目vendor目錄下.而經過這個命令則是將全部的代碼及其依賴的包放到一個目錄下,至關於執行了一個git clone命令,通常是包的開發者可能爲了修復bug會使用該命令.

composer global

這是一個全局的安裝命令,它容許你在COMPOSER_HOME目錄下執行Composer的命令,好比install,update.固然你的COMPOSER_HOME要在$PATH環境下.

好比執行composer global require fabpot/php-cs-fixer,如今php-cs-fixer命令行能夠全局運行了,若是稍後想更新它,只須要運行composer global update

composer dump-autoload

當你修改項目下的composer.json的文件,並不必定要運行composer update命令進行更新,有的時候可使用該命令來更新加載器,好比你要引用本地自定義的包(不是來自於packagist),後面會經過實踐來講明該命令.

composer require

假如手動或者交互式建立composer.json文件,能夠直接使用該命令來安裝包

composer require  cerdic/css-tidy:1.5.2

composer require "ywdblog/phpcomposer:dev-master"

–prefer-source和–prefer-dist參數

–prefer-dist:對於穩定的包來講,通常Composer安裝默認使用該參數,這也能加快安裝,好比有可能直接從packagist安裝了相應的包,而不用實際去Github上下載包.

–prefer-source:假如使用該參數,則會直接從Github上安裝,安裝包後vendor目錄下還含有.git信息

composer require "ywdblog/phpcomposer:dev-master" --prefer-source 

#在vendor/ywdblog/phpcomposer目錄下含有.git信息

如何給Composer添加代理

在國內使用Composer下載特別慢,能夠經過二個方法進行加速

composer config repo.packagist composer 「https://packagist.phpcomposer.com「

編輯composer.json

"repositories": {

  "packagist": {

      "type": "composer",

      "url": "https://packagist.phpcomposer.com"

  }

}

 

Autoloading代碼加載器

composer自己集成一個autoloader,支持PSR-4,PSR-0,classmap,files autoloading.

這裏經過一個例子來講明經過Composer如何引用classmap,files,本地符合PSR-4標準的代碼

編輯composer.json

"autoload": {

  "classmap": ["othsrc/","classsrc.php"],

  "files": ["othsrc/filesrc.php"],

  "psr-4": {"Foo\Bar\": "src"}  }

composer dump-autoload

 

經過上述的操做,對於PSR-4來講等同註冊了一個PSR-4 autoloader(從FooBar命名空間)

假如不想使用Composer的autoloader,能夠直接包含vendor/composer/autoload_*.php文件,配置本身的加載器.

具體的例子託管在github上,可參考.

Repositories

關於Repositories,瞭解其不是必須的,可是假如掌握則更能理解Composer,對於Repositories,其中文文檔和英文文檔解釋的很好,這裏也進行了一些摘抄.

基本概念

包:

Composer是一個依賴管理工具,它在本地安裝一些資源包和包的描述(好比包名稱和對應的版本),比較重要的元數據描述是dist和source,dist指向一個存檔,該存檔是對一個資源包的某個版本的數據進行的打包.source指向一個開發中的源,這一般是一個源代碼倉庫(好比git)

資源庫:

一個資源庫是一個包的來源.它是一個packages/versions的列表.

Composer將查看全部你定義的repositories以找到項目須要的資源包(這句話很重要).

默認狀況下已經將http://Packagist.org註冊到Composer(或者理解爲http://Packagist.org是Composer資源庫默認的倉庫類型)

Composer資源庫類型

Composer資源庫包括四種類型,默認的是composer類型,也就是http://packagist.org所使用的資源類型.

它使用一個單一的packages.json文件,包含了全部的資源包元數據.當你將包發佈到http://pckagist.org上,則默認系統會建立一個packages.json,不過我沒有找到個人包對應的文件.

VCS資源庫類型

假如你想構建一個私有的Composer私有資源庫類型,可使用該類型,這裏舉一個例子,好比你在本身項目的composer.json定義以下,則就可使用對應的Github上的代碼了.

 

{

    "repositories": [

    {

        "type": "vcs",

        "url": "https://github.com/ywdblog/phpcomposer"

    }

    ],

    "require": {

        "ywdblog/phpcomposer": "dev-master"

    }

}

 

當運行composer update的時候,Comoser其實是從Github上下載包而不是從http://pckagist.org上下載.

另外假如須要使用Package資源庫類型或者PEAR資源庫類型,參考官方文檔便可,通常在composer.json中定義name、version屬性便可.

Composer.json

在本文上面也屢次提到了composer.json,好比你但願使用第三方包則須要在本地定義composer.json,Composer安裝第三方包後,也會在第三方包目錄下發現composer.json,那麼這兩者都叫composer.json,有什麼區別呢?理解這很是的重要.

假如你在本身的項目下面定義一個composer.json,則這個包稱之爲ROOT包,這個composer.json定義你項目須要的條件(好比你的項目可能依賴一個第三方包).

composer.json中有些屬性只能被ROOT包使用,好比config屬性只在ROOT包中生效.

一個資源包是否是ROOT包,取決於它的上下文,好比你git clone ywdblog/phpcomposer,則這時候本地phpcomposer目錄就是ROOT包,假如你在本地phpcomposer目錄下composer require ywdblog/phpcomposer,則這時候你的項目phpcomposer就是ROOT包.

瞭解composer-schema.json可參考該網址,Laravel做爲一個成熟的框架,其定義的composer.json很是經典

關於包的版本

當使用者在本地配置composer.json的時候,能夠指定須要包的特定版本,Composer支持從Github倉庫中下載Tag或者分支下的包.

對於Github上的Tag來講,Packagist會建立對應包的版本,它符合X.Y.Z,vX.Y.Z,X.Y.Z-包類型,就是說Github上雖然只有一個特定版本的包,但Composer支持多種形式的引用方式,好比:

composer require monolog/monolog  1.0.0-RC1 

composer require monolog/monolog  v1.0.0-RC1 

composer require monolog/monolog  1.0.*

composer require monolog/monolog  ~1.10

 

對於Github上的分支來講,Packagist會建立對應包的版本,假如分支名看起來像一個版本,將建立{分支名}-dev的包版本號,若是分支名看起來不像一個版本號,它將會建立dev-{分支名}形式的版本號

總結:

理解Composer,最重要的是實踐,最後也能明白PSR-4和命名空間,也能夠嘗試將你的項目發佈到http://pckagist.org上.

以上就是【Composer】PHP開發者必須瞭解！的詳細內容