Composer 是 PHP 的一個依賴管理工具。我們可以在項目中聲明所依賴的外部工具庫,Composer 會幫你安裝這些依賴的庫文件,有了它,我們就可以很輕鬆的使用一個命令將其他人的優秀代碼引用到我們的項目中來。
Composer 默認情況下不是全局安裝,而是基於指定的項目的某個目錄中(例如 vendor)進行安裝。
Composer 需要 PHP 5.3.2+ 以上版本,且需要開啓 openssl。
Composer 可運行在 Windows 、 Linux 以及 OSX 平臺上。
Composer 的安裝
Wondows 平臺
Wondows 平臺上,我們只需要下載 Composer-Setup.exe 後,一步步安裝即可。
需要注意的是你需要開啓 openssl 配置,我們打開 php 目錄下的 php.ini,將 extension=php_openssl.dll 前面的分號去掉就可以了。
安裝成功後,我們可以通過命令窗口(cmd) 輸入 composer --version 命令來查看是否安裝成功:
接下來我們可以更改 Packagist 爲國內鏡像:
composer config -g repo.packagist composer https://packagist.phpcomposer.com
Linux 平臺
Linux 平臺可以使用以下命令來安裝:
# php -r "copy('https://install.phpcomposer.com/installer', 'composer-setup.php');" # php composer-setup.php All settings correct for using Composer Downloading... Composer (version 1.6.5) successfully installed to: /root/composer.phar Use it: php composer.phar
移動 composer.phar,這樣 composer 就可以進行全局調用:
# mv composer.phar /usr/local/bin/composer
切換爲國內鏡像:
# composer config -g repo.packagist composer https://packagist.phpcomposer.com
更新 composer:
# composer selfupdate
Mac OS 系統
Mac OS 系統可以使用以下命令來安裝:
$ curl -sS https://getcomposer.org/installer | php $ sudo mv composer.phar /usr/local/bin/composer $ composer --version Composer version 1.7.2 2018-08-16 16:57:12
切換爲國內鏡像:
$ composer config -g repo.packagist composer https://packagist.phpcomposer.com
更新 composer:
$ composer selfupdate
Composer 的使用
要使用 Composer,我們需要先在項目的目錄下創建一個 composer.json 文件,文件描述了項目的依賴關係。
文件格式如下:
{ "require": { "monolog/monolog": "1.2.*" } }
以上文件說明我們需要下載從 1.2 開始的任何版本的 monolog。
接下來只要運行以下命令即可安裝依賴包:
composer install
require 命令
除了使用 install 命令外,我們也可以使用 require 命令快速的安裝一個依賴而不需要手動在 composer.json 裏添加依賴信息:
$ composer require monolog/monolog
Composer 會先找到合適的版本,然後更新composer.json文件,在 require 那添加 monolog/monolog 包的相關信息,再把相關的依賴下載下來進行安裝,最後更新 composer.lock 文件並生成 php 的自動加載文件。
update 命令
update 命令用於更新項目裏所有的包,或者指定的某些包:
# 更新所有依賴 $ composer update # 更新指定的包 $ composer update monolog/monolog # 更新指定的多個包 $ composer update monolog/monolog symfony/dependency-injection # 還可以通過通配符匹配包 $ composer update monolog/monolog symfony/*
需要注意的時,包能升級的版本會受到版本約束的約束,包不會升級到超出約束的版本的範圍。例如如果 composer.json 裏包的版本約束爲 ^1.10,而最新版本爲 2.0。那麼 update 命令是不能把包升級到 2.0 版本的,只能最高升級到 1.x 版本。關於版本約束請看後面的介紹。
remove 命令
remove 命令用於移除一個包及其依賴(在依賴沒有被其他包使用的情況下),如果依賴被其他包使用,則無法移除:
$ composer remove monolog/monolog Loading composer repositories with package information Updating dependencies (including require-dev) Package operations: 0 installs, 0 updates, 2 removals - Removing psr/log (1.0.2) - Removing monolog/monolog (1.23.0) Generating autoload files
search 命令
search 命令可以搜索包:
$ composer search monolog
該命令會輸出包及其描述信息,如果只想輸出包名可以使用 --only-name 參數:
$ composer search --only-name monolog
show 命令
show 命令可以列出當前項目使用到包的信息:
# 列出所有已經安裝的包 $ composer show # 可以通過通配符進行篩選 $ composer show monolog/* # 顯示具體某個包的信息 $ composer show monolog/monolog
基本約束
精確版本
我們可以告訴 Composer 安裝的具體版本,例如:1.0.2,指定 1.0.2 版本。
範圍
通過使用比較操作符來指定包的範圍。這些操作符包括:>,>=,<,<=,!=。
你可以定義多個範圍,使用空格或者逗號 , 表示邏輯上的與,使用雙豎線 || 表示邏輯上的或。其中與的優先級會大於或。 實例:
- >=1.0
- >=1.0 <2.0
- >=1.0 <1.1 || >=1.2
我們也可以通過使用連字符 - 來指定版本範圍。
連字符的左邊表明了 >=
的版本,如果右邊的版本不是完整的版本號,則會被使用通配符進行補全。例如1.0 - 2.0
等同於>=1.0.0 <2.1
(2.0
相當於2.0.*
),而1.0.0 - 2.1.0
則等同於>=1.0.0 <=2.1.0
。
通配符
可以使用通配符來設置版本。1.0.*
相當於>=1.0 <1.1
。
例子:1.0.*
波浪號 ~
我們先通過後面這個例子去解釋~操作符的用法:~1.2
相當於>=1.2 <2.0.0
,而~1.2.3
相當於>=1.2.3 <1.3.0
。對於使用Semantic Versioning
作爲版本號標準的項目來說,這種版本約束方式很實用。例如~1.2
定義了最小的小版本號,然後你可以升級2.0以下的任何版本而不會出問題,因爲按照Semantic Versioning
的版本定義,小版本的升級不應該有兼容性的問題。簡單來說,~
定義了最小的版本,並且允許版本的最後一位版本號進行升級(沒懂得話,請再看一邊前面的例子)。
例子:~1.2
需要注意的是,如果~作用在主版本號上,例如
~1
,按照上面的說法,Composer可以安裝版本1以後的主版本,但是事實上是~1
會被當作~1.0
對待,只能增加小版本,不能增加主版本。
折音號 ^
^
操作符的行爲跟Semantic Versioning
有比較大的關聯,它允許升級版本到安全的版本。例如,^1.2.3
相當於>=1.2.3 <2.0.0
,因爲在2.0版本前的版本應該都沒有兼容性的問題。而對於1.0之前的版本,這種約束方式也考慮到了安全問題,例如^0.3
會被當作>=0.3.0 <0.4.0
對待。
例子:^1.2.3
版本穩定性
如果你沒有顯式的指定版本的穩定性,Composer會根據使用的操作符,默認在內部指定爲-dev
或者-stable
。例如:
約束 | 內部約束 |
---|---|
1.2.3 |
=1.2.3.0-stable |
>1.2 |
>1.2.0.0-stable |
>=1.2 |
>=1.2.0.0-dev |
>=1.2-stable |
>=1.2.0.0-stable |
<1.3 |
<1.3.0.0-dev |
<=1.3 |
<=1.3.0.0-stable |
1 - 2 |
>=1.0.0.0-dev <3.0.0.0-dev |
~1.3 |
>=1.3.0.0-dev <2.0.0.0-dev |
1.4.* |
>=1.4.0.0-dev <1.5.0.0-dev |
例子:1.0 - 2.0
如果你想指定版本只要穩定版本,你可以在版本後面添加後綴-stable
。
minimum-stability
配置項定義了包在選擇版本時對穩定性的選擇的默認行爲。默認是stable
。它的值如下(按照穩定性排序):dev
,alpha
,beta
,RC
和stable
。除了修改這個配置去修改這個默認行爲,我們還可以通過穩定性標識(例如@stable
和@dev
)來安裝一個相比於默認配置不同穩定性的版本。例如:
{ "require": { "monolog/monolog": "1.0.*@beta", "acme/foo": "@dev" } }