Composer 的結構詳解

Composer 的結構

Root Package(根目錄包)

根目錄包就是在你的項目的根目錄由 composer.json 定義的包。主要就是由 composer.json 來定義你的項目的依賴。
某些字段只能在根目錄包的中使用,比如 config 字段,只有根目錄包能定義自己的配置。依賴包中的 config 字段是被忽略的。所以 config 字段是 root-only 的。
如果你克隆了其中一個依賴包并在上面工作,那么這個包就是根目錄包。composer.json 還是一樣的,但上下文不同。
(注:一個包是不是根目錄包,取決于上下文。)

composer.json 中的各個屬性(字段)

  • name。包的名字。由供應方(vendor)名和項目名組成,用 / 分隔。==在發布包的時候需要填==。
  • description 對包的一個簡短描述,通常是一行的長度。==在發布包的時候需要填==。
  • version 包的版本。格式必須是 X.Y.Z,選擇性后綴:-dev、-alphaN、-betaN、-RCN。
  • type包的類型,默認為 library。==包類型用于定制安裝邏輯==。如果你的包的安裝需要一些特殊的邏輯,你可以定義一個定制的類型。它可以是一個 symfony-bundle 的類型,或者 wordpress-plugin,或者 typo3-module。這些類型將被特定的項目所用,它們將提供安裝器來安裝這些類型的包。

Composer 支持 3 種類型:

  • library:默認值。它將復制文件到 vendor 目錄。
  • project:它表示這是個項目,而不是庫。比如像 Symfony 標準版這種應用。
  • metapackage:一個含有依賴的空包,能觸發安裝,但不包含文件,不會向文件系統寫任何東西。
  • composer-install:為其他的定制類型的包提供安裝器的包。
  • keywords 一個與包相關的關鍵詞數組。用于包的搜索和過濾。可選。

homepage

  • 項目的網站 URL。
  • 可選。

time

  • 版本發布時間。
  • 必須是 YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS 格式。
  • 可選。

license

  • 包的許可證。
  • 可以是字符串或字符串數組。
  • 可選,但強烈建議加上。

authors包的作者。是個對象數組。每個 author 對象有這些屬性:

  •  name:作者名字 
    
  •  email:作者郵箱 
    
  •  homepage:作者網站 URL 
    
  •  role:作者在項目中的角色(如:developer 或 translator)
    

support各種關于該項目如何獲取支持的信息。包含這些屬性:

  •  email:獲取支持的郵箱 
    
  •  issues:問題跟蹤的 URL 
    
  •  forum:論壇的 URL 
    
  •  wiki:Wiki 的 URL 
    
  •  irc:IRC 的頻道 
    
  •  source:查看或下載源碼的 URL
    
  •  可選。
    

Package links

依賴包的映射表,由包名映射版本約束。如:

{
    "require": {
        "monolog/monolog": "1.0.*"
    }
}

require列出包所依賴的包。

除非這些依賴已經存在,否則這個包不會被安裝。

require-dev(root-only)列出開發這個包(或跑測試等等)所依賴的包。

在使用 install 命令時,只有帶上 “–dev” 參數才能安裝 dev 包。在使用 update 命令時,帶上 “–no-dev” 則不更新。

conflict列出包會和哪些包發生沖突。

它們將不被允許和你的包一起安裝。如果約束了版本,則只會針對特定的版本。

replace列出哪些包要被這個包替代。

provide這個包所推薦的包列表。

這個對公共接口最有用,一個包可以依賴一個虛擬的 logger 包,而實現 logger 接口的庫可以放到 provide 字段中。

suggest建議一些能讓這個包工作的更好或得到增強的包列表。

這些信息只在包安裝完成時給出,暗示用戶可以添加更多包,雖然不是必須要安裝的。
格式是,包名映射文字說明,如:

{
    "suggest": {
        "monolog/monolog": "Allows more advanced logging of the application flow"
    }
}

autoload

提供給 PHP autoloader 的自動加載映射。
目前支持的有:PSR-0 自動加載規范,classmap 生成器,還有 files。
PSR-0 是比較推薦的,因為它的優秀的擴展性(在添加新的類的適合,不需要重新生成自動加載器)。
PSR-0
在 psr-0 鍵名下,定義一個命名空間到路徑的映射表,相對于包的根目錄。注意,這也同樣支持 PEAR-style 的沒有命名空間的風格。
請注意命名空間的聲明得以 \ 結尾,確保自動加載器正確響應。
PSR-0 的引用可以在安裝或更新時生成的文件中查看:
vendor/composer/autoload_namespaces.php
例子:

{
    "autoload": {
        "psr-0": {
            "Monolog\\": "src/",
            "Vendor\\Namespace\\": "src/",
            "Vendor_Namespace_": "src/"
        }
    }
}

如果你需要在多個目錄里查找同一個前綴的命名空間,你可以用數組,如:

{
    "autoload": {
        "psr-0": { "Monolog\\": ["src/", "lib/"] }
    }
}

PSR-0 風格并不局限于加載命名空間的聲明的東西,也可以用于類這個層級。當庫中只有一個在全局命名空間中的類時,這種方式就能用上。比如你有個 PHP 源文件放在項目的根目錄,你可以這樣聲明:

{
    "autoload": {
        "psr-0": { "UniqueGlobalClass": "" }
    }

}

如果你有個目錄下全是用命名空間組織的,你可以用空前綴:

{
    "autoload": {
        "psr-0": { "": "src/" }
    }
}

(2)Classmap

classmap 的引用可以在安裝或更新時生成的文件中查看:
vendor/composer/autoload_classmap.php
類映射表是通過掃描指定的目錄或文件下的所有的 .php 和 .inc 文件生成的。
你可以給任何不支持 PSR-0 的庫用 classmap 生成器實現自動加載。配置上只要指定類所在的目錄或文件即可:

 {
    "autoload": {
        "classmap": ["src/", "lib/", "Something.php"]
    }
}

(3)files

如果你確定需要在任何請求中都加載某些文件,你可以使用 files 自動加載機制。對于那些包中有些 PHP 函數但不能自動加載時特別有用。例如:

{
    "autoload": {
        "files": ["src/MyLibrary/functions.php"]
    }
}

include-path

(將被棄用,它的功能由 autoload 代替。其實就是設置 include_path,可選)

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"
}

minimum-stability(root-only)

定義根據穩定性如何過濾包。默認是 stable,如果你信賴一個 dev 包,你需要指明。

prefer-stable(root-only)

如果開啟,Composer 會在穩定包和不穩定包中選擇前者。

repositories(root-only)

定制包的倉庫地址。

默認的,Composer 只使用 Packagist 倉庫。通過指定倉庫地址,你可以從任何地方獲取包。

倉庫不能遞歸。你只能將它們添加到主的 composer.json 中。所依賴包中 composer.json 文件中的倉庫定義是被忽略的。

支持的倉庫的類型有:

  • composer
    composer 倉庫通過網絡提供 packages.json 文件,它包含一個 composer.json 對象的列表,還有額外的 dist 或 source 信息。packages.json 文件通過 PHP 流加載。
  • vcs
    版本控制系統倉庫,如:git、svn、hg。
  • pear
    通過它,你可以導入任何 pear 倉庫到你的項目中。
  • 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/"
                }
            }
        }
    ]
}

config(root-only)

針對項目的一些配置:

process-timeout:默認 300 秒,Composer 進程執行超時時間;
use-include-path:默認 false,如果是 true,Composer 自動加載器也會到 PHP 的 include_path 中查找;
preferred-install:默認 auto,設置 Composer 安裝方式;
github-protocols:默認 [“git”, “https”],設置與 github 通信協議;
github-oauth:設置 oauth;
vendor-dir:默認 vendor,你可以換成別的;
bin-dir:默認 vendor/bin,如果項目有二進制文件,會鏈接到這;
cache-dir:默認 $home/cache,存放 Composer 運行時產生的緩存;
cache-files-dir:默認 $cache-dir/files,存放包的 zip 文件;
cache-repo-dir:默認 $cache-dir/repo,存放倉庫元數據;
cache-vcs-dir:默認 $cache-dir/vcs,存放 vcs 克隆;
cache-files-ttl:默認六個月,緩存的過期時間;
cache-files-maxsize:默認 300M;
notify-no-install:默認 true,從倉庫安裝包會有個通知,可以關掉;
discard-changes:默認false,如何處理臟的更新;

  • scripts(root-only)Composer 允許你在安裝進程中安裝鉤子腳本,鉤子是基于事件的;
  • extra供 scripts 消費的額外數據;
  • bin指定哪些文件必須被當做二進制文件處理的;
  • archive
    設置創建包時的選項,exclude 屬性可以設置排除哪些目錄,例如:
{
    "archive": {
        "exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"]
    }
}

這篇看下來,再看 Symfony 的標準版中的 composer.json,應該了然了吧。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,001評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,786評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,986評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,204評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,964評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,354評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,410評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,554評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,106評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,918評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,093評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,648評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,342評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,755評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,009評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,839評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,107評論 2 375

推薦閱讀更多精彩內容