一面徽、Root Package(根目錄包)
根目錄包就是在你的項目的根目錄由 composer.json 定義的包。主要就是由 composer.json 來定義你的項目的依賴。
某些字段只能在根目錄包的中使用宴胧,比如 config 字段晶姊,只有根目錄包能定義自己的配置。依賴包中的 config 字段是被忽略的崩瓤。所以 config 字段是 root-only 的袍啡。
如果你克隆了其中一個依賴包并在上面工作,那么這個包就是根目錄包却桶。composer.json 還是一樣的境输,但上下文不同蔗牡。
(注:一個包是不是根目錄包,取決于上下文嗅剖。)
二辩越、composer.json 中的各個屬性(字段)
1、name
包的名字信粮。由供應(yīng)方(vendor)名和項目名組成黔攒,用 / 分隔。
在發(fā)布包的時候需要填蒋院。
2亏钩、description
對包的一個簡短描述,通常是一行的長度欺旧。
在發(fā)布包的時候需要填姑丑。
3、version
包的版本辞友。
格式必須是 X.Y.Z栅哀,選擇性后綴:-dev、-alphaN称龙、-betaN留拾、-RCN。
4鲫尊、type
包的類型痴柔,默認為 library。
包類型用于定制安裝邏輯疫向。如果你的包的安裝需要一些特殊的邏輯咳蔚,你可以定義一個定制的類型。它可以是一個 symfony-bundle 的類型搔驼,或者 wordpress-plugin谈火,或者 typo3-module。這些類型將被特定的項目所用舌涨,它們將提供安裝器來安裝這些類型的包糯耍。
Composer 支持 3 種類型:
library:默認值。它將復(fù)制文件到 vendor 目錄囊嘉。
project:它表示這是個項目温技,而不是庫。比如像 Symfony 標準版這種應(yīng)用扭粱。
metapackage:一個含有依賴的空包舵鳞,能觸發(fā)安裝,但不包含文件焊刹,不會向文件系統(tǒng)寫任何東西。
composer-install:為其他的定制類型的包提供安裝器的包。
5虐块、keywords
一個與包相關(guān)的關(guān)鍵詞數(shù)組俩滥。用于包的搜索和過濾。
可選贺奠。
6霜旧、homepage
項目的網(wǎng)站 URL。
可選儡率。
7挂据、time
版本發(fā)布時間。必須是 YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS 格式儿普。
可選崎逃。
8、license
包的許可證眉孩「錾埽可以是字符串或字符串數(shù)組。
可選浪汪,但強烈建議加上巴柿。
9、authors
包的作者死遭。是個對象數(shù)組广恢。
每個 author 對象有這些屬性:
name:作者名字
email:作者郵箱
homepage:作者網(wǎng)站 URL
role:作者在項目中的角色(如:developer 或 translator)
10、support
各種關(guān)于該項目如何獲取支持的信息呀潭。包含這些屬性:
email:獲取支持的郵箱
issues:問題跟蹤的 URL
forum:論壇的 URL
wiki:Wiki 的 URL
irc:IRC 的頻道
source:查看或下載源碼的 URL
可選钉迷。
11、Package links
依賴包的映射表蜗侈,由包名映射版本約束篷牌。如:
{
? ? "require": {
? ? ? ? "monolog/monolog": "1.0.*"
? ? }
}
(1)require
列出包所依賴的包。除非這些依賴已經(jīng)存在踏幻,否則這個包不會被安裝枷颊。
(2)require-dev(root-only)
列出開發(fā)這個包(或跑測試等等)所依賴的包。在使用 install 命令時该面,只有帶上 “–dev” 參數(shù)才能安裝 dev 包夭苗。在使用 update 命令時,帶上 “–no-dev” 則不更新隔缀。
(3)conflict
列出包會和哪些包發(fā)生沖突题造。它們將不被允許和你的包一起安裝。如果約束了版本猾瘸,則只會針對特定的版本界赔。
(4)replace
列出哪些包要被這個包替代丢习。
(5)provide
這個包所推薦的包列表。這個對公共接口最有用淮悼,一個包可以依賴一個虛擬的 logger 包咐低,而實現(xiàn) logger 接口的庫可以放到 provide 字段中。
12袜腥、suggest
建議一些能讓這個包工作的更好或得到增強的包列表见擦。這些信息只在包安裝完成時給出,暗示用戶可以添加更多包羹令,雖然不是必須要安裝的鲤屡。
格式是,包名映射文字說明福侈,如:
{
? ? "suggest": {
? ? ? ? "monolog/monolog": "Allows more advanced logging of the application flow"
? ? }
}
13酒来、autoload
提供給 PHP autoloader 的自動加載映射。
目前支持的有:PSR-0 自動加載規(guī)范癌刽,classmap 生成器役首,還有 files。
PSR-0 是比較推薦的显拜,因為它的優(yōu)秀的擴展性(在添加新的類的適合衡奥,不需要重新生成自動加載器)。
(1)PSR-0
在 psr-0 鍵名下远荠,定義一個命名空間到路徑的映射表矮固,相對于包的根目錄。注意譬淳,這也同樣支持 PEAR-style 的沒有命名空間的風(fēng)格档址。
請注意命名空間的聲明得以 \\ 結(jié)尾,確保自動加載器正確響應(yīng)邻梆。
PSR-0 的引用可以在安裝或更新時生成的文件中查看:
vendor/composer/autoload_namespaces.php
例子:
{
? ? "autoload": {
? ? ? ? "psr-0": {
? ? ? ? ? ? "Monolog\\": "src/",
? ? ? ? ? ? "Vendor\\Namespace\\": "src/",
? ? ? ? ? ? "Vendor_Namespace_": "src/"
? ? ? ? }
? ? }
}
如果你需要在多個目錄里查找同一個前綴的命名空間守伸,你可以用數(shù)組,如:
{
? ? "autoload": {
? ? ? ? "psr-0": { "Monolog\\": ["src/", "lib/"] }
? ? }
}
PSR-0 風(fēng)格并不局限于加載命名空間的聲明的東西浦妄,也可以用于類這個層級尼摹。當庫中只有一個在全局命名空間中的類時,這種方式就能用上剂娄。比如你有個 PHP 源文件放在項目的根目錄蠢涝,你可以這樣聲明:
{
? ? "autoload": {
? ? ? ? "psr-0": { "UniqueGlobalClass": "" }
? ? }
}
如果你有個目錄下全是用命名空間組織的,你可以用空前綴:
{
? ? "autoload": {
? ? ? ? "psr-0": { "": "src/" }
? ? }
}
(2)Classmap
classmap 的引用可以在安裝或更新時生成的文件中查看:
vendor/composer/autoload_classmap.php
類映射表是通過掃描指定的目錄或文件下的所有的 .php 和 .inc 文件生成的阅懦。
你可以給任何不支持 PSR-0 的庫用 classmap 生成器實現(xiàn)自動加載和二。配置上只要指定類所在的目錄或文件即可:
{
? ? "autoload": {
? ? ? ? "classmap": ["src/", "lib/", "Something.php"]
? ? }
}
(3)files
如果你確定需要在任何請求中都加載某些文件,你可以使用 files 自動加載機制耳胎。對于那些包中有些 PHP 函數(shù)但不能自動加載時特別有用惯吕。例如:
{
? ? "autoload": {
? ? ? ? "files": ["src/MyLibrary/functions.php"]
? ? }
}
14惕它、include-path
(將被棄用,它的功能由 autoload 代替废登。其實就是設(shè)置 include_path怠缸,可選)
15、target-dir
指定安裝目標路徑钳宪。
如果包的根目錄是在命名空間下,自動加載就不正確了扳炬,所以才有 target-dir 來解決這個問題吏颖。
Symfony 就是個例子。它由很多組件包組成恨樟。Yaml 組件是在
Symfony\Component\Yaml
??命名空間下的半醉,它的根目錄是 Yaml 目錄。要讓自動加載正常工作劝术,我們要確保它不是安裝在
vendor/symfony/yaml
?缩多,而是在
vendor/symfony/yaml/Symfony/Component/Yaml
?,這樣自動加載器才能從 vendor/symfony/yaml 加載它养晋。
所以要定義 target-dir 如下:
{
? ? "autoload": {
? ? ? ? "psr-0": { "Symfony\\Component\\Yaml\\": "" }
? ? },
? ? "target-dir": "Symfony/Component/Yaml"
}
16衬吆、minimum-stability(root-only)
定義根據(jù)穩(wěn)定性如何過濾包。默認是 stable绳泉,如果你信賴一個 dev 包逊抡,你需要指明。
17零酪、prefer-stable(root-only)
如果開啟冒嫡,Composer 會在穩(wěn)定包和不穩(wěn)定包中選擇前者。
18四苇、repositories(root-only)
定制包的倉庫地址孝凌。
默認的,Composer 只使用 Packagist 倉庫月腋。通過指定倉庫地址蟀架,你可以從任何地方獲取包。
倉庫不能遞歸罗售。你只能將它們添加到主的 composer.json 中辜窑。所依賴包中 composer.json 文件中的倉庫定義是被忽略的。
支持的倉庫的類型有:
(1)composer
composer 倉庫通過網(wǎng)絡(luò)提供 packages.json 文件寨躁,它包含一個 composer.json 對象的列表穆碎,還有額外的 dist 或 source 信息。packages.json 文件通過 PHP 流加載职恳。
(2)vcs
版本控制系統(tǒng)倉庫所禀,如:git方面、svn、hg色徘。
(3)pear
通過它恭金,你可以導(dǎo)入任何 pear 倉庫到你的項目中。
(4)package
如果你依賴一個不支持 composer 的項目褂策,你可以定義一個 package 類型的倉庫横腿,然后將 composer.json 對象直接寫入。
完整的例子:
{
? ? "repositories": [
? ? ? ? {
? ? ? ? ? ? "type": "composer",
? ? ? ? ? ? "url": "http://packages.example.com"
? ? ? ? },
? ? ? ? {
? ? ? ? ? ? "type": "composer",
? ? ? ? ? ? "url": "https://packages.example.com",
? ? ? ? ? ? "options": {
? ? ? ? ? ? ? ? "ssl": {
? ? ? ? ? ? ? ? ? ? "verify_peer": "true"
? ? ? ? ? ? ? ? }
? ? ? ? ? ? }
? ? ? ? },
? ? ? ? {
? ? ? ? ? ? "type": "vcs",
? ? ? ? ? ? "url": "https://github.com/Seldaek/monolog"
? ? ? ? },
? ? ? ? {
? ? ? ? ? ? "type": "pear",
? ? ? ? ? ? "url": "http://pear2.php.net"
? ? ? ? },
? ? ? ? {
? ? ? ? ? ? "type": "package",
? ? ? ? ? ? "package": {
? ? ? ? ? ? ? ? "name": "smarty/smarty",
? ? ? ? ? ? ? ? "version": "3.1.7",
? ? ? ? ? ? ? ? "dist": {
? ? ? ? ? ? ? ? ? ? "url": "http://www.smarty.net/files/Smarty-3.1.7.zip",
? ? ? ? ? ? ? ? ? ? "type": "zip"
? ? ? ? ? ? ? ? },
? ? ? ? ? ? ? ? "source": {
? ? ? ? ? ? ? ? ? ? "url": "http://smarty-php.googlecode.com/svn/",
? ? ? ? ? ? ? ? ? ? "type": "svn",
? ? ? ? ? ? ? ? ? ? "reference": "tags/Smarty_3_1_7/distribution/"
? ? ? ? ? ? ? ? }
? ? ? ? ? ? }
? ? ? ? }
? ? ]
}
19斤寂、config(root-only)
針對項目的一些配置耿焊。
process-timeout:默認 300 秒,Composer 進程執(zhí)行超時時間遍搞;
use-include-path:默認 false罗侯,如果是 true,Composer 自動加載器也會到 PHP 的 include_path 中查找溪猿;
preferred-install:默認 auto钩杰,設(shè)置 Composer 安裝方式;
github-protocols:默認 [“git”, “https”]诊县,設(shè)置與 github 通信協(xié)議讲弄;
github-oauth:設(shè)置 oauth;
vendor-dir:默認 vendor依痊,你可以換成別的垂睬;
bin-dir:默認 vendor/bin,如果項目有二進制文件抗悍,會鏈接到這驹饺;
cache-dir:默認 $home/cache,存放 Composer 運行時產(chǎn)生的緩存缴渊;
cache-files-dir:默認 $cache-dir/files赏壹,存放包的 zip 文件;
cache-repo-dir:默認 $cache-dir/repo衔沼,存放倉庫元數(shù)據(jù)蝌借;
cache-vcs-dir:默認 $cache-dir/vcs,存放 vcs 克轮敢稀菩佑;
cache-files-ttl:默認六個月,緩存的過期時間凝化;
cache-files-maxsize:默認 300M稍坯;
notify-no-install:默認 true,從倉庫安裝包會有個通知,可以關(guān)掉瞧哟;
discard-changes:默認false混巧,如何處理臟的更新;
20勤揩、scripts(root-only)
Composer 允許你在安裝進程中安裝鉤子腳本咧党,鉤子是基于事件的;
21陨亡、extra
供 scripts 消費的額外數(shù)據(jù)傍衡;
22、bin
指定哪些文件必須被當做二進制文件處理的负蠕;
23聪舒、archive
設(shè)置創(chuàng)建包時的選項,exclude 屬性可以設(shè)置排除哪些目錄虐急,例如:
{
? ? "archive": {
? ? ? ? "exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"]
? ? }
}