如何配置composer.json

這篇文章給大家分享的是有關如何配置composer.json的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

配置文件的值為 key:val 必須雙引號包裹

一、配置文件

名字 name
包名稱由用戶名名稱和倉庫名稱組成
包版本限制來請求Monolog軟件包 1.0.*。這意味著1.0開發分支中的任何版本，或大于或等于1.0且小于1.1（>=1.0 <1.1）的任何版
本。

描述 description
簡短描述包裝。通常這只是一行長。

包的版本 version
如果軟件包存儲庫可以從某處推斷版本，例如VCS存儲庫中的VCS標記名稱，則可選。在這種情況下，建議省略它。

類型 type
建議省略此字段，并將其默認為library

關鍵字 keywords
這些可用于搜索和過濾,數組形式例如keywords: ["xunsearch", "search engine", "yii", "yii2"]

主頁 homepage
項目網站的網址。

時間 time
版本發布日期，必須在YYYY-MM-DD或YYYY-MM-DD HH:MM:SS格式。

許可證 license
對于一個包，當許可證之間有一個選擇（“分離許可”）時，可以將多個指定為數組。
分離許可證示例：

{
    　　"license": [
       　　　　"LGPL-2.1",
       　　　　"GPL-3.0+"
    　　]
}

或者，它們可以用“或”分隔并括在括號中;

{
    　　"license": "(LGPL-2.1 or GPL-3.0+)"
}

作者 authors

每個作者對象可以具有以下屬性：
名稱：作者姓名 通常他們的真名。 name 
電子郵件：作者的電子郵件地址。 email
主頁：作者網站的網址。   　　　homepage
作用：作者在項目中的作用（如開發者或翻譯者） role
"authors": [
        　　{
            　　　　"name": "Nils Adermann",
            　　　　"email": "naderman@naderman.de",
            　　　　"homepage": "http://www.naderman.de",
            　　　　"role": "Developer"
        　　},
        　　{
            　　　　"name": "Jordi Boggiano",
            　　　　"email": "j.boggiano@seld.be",
            　　　　"homepage": "http://seld.be",
            　　　　"role": "Developer"
        　　}
    ]

支持 support
各種信息獲得項目支持，支持信息包括以下內容：

電子郵件：電子郵件地址支持。email
問題：問題跟蹤器的URL。 issues
論壇：論壇的 URL。  forum:
wiki：維基的 URL。 wiki
irc： IRC通道支持，如irc：// server / channel。 irc:
來源：瀏覽或下載源的 URL。 source
docs：文檔的 URL。  docs
rss： RSS提要的URL。 rss
一個例子：

{
    　　"support": {
        　　　　"email": "support@example.org",
        　　　　"irc": "irc://irc.freenode.org/composer"
    　　}
}

建議 suggest

"suggest": {
        　　"monolog/monolog": "Allows more advanced logging of the application flow",
        　　"ext-xml": "Needed to support XML format in class Foo"
    }

archive 歸檔

此命令用來對指定包的指定版本進行 zip/tar 歸檔。它也可以用來歸檔你的整個項目，不包括 excluded/ignored（排除/忽略）的文件。

composer 命令：php composer.phar archive vendor/package 2.0.21 --format=zip

exclude：允許配置排除路徑的模式列表。模式語法匹配.gitignore文件。領先的感嘆號（！）將導致任何匹配的文件被包括，即使
以前的模式排除它們。領先的斜杠只能在項目相對路徑的開始處匹配。星號不會擴展到目錄分隔符。

設置創建包時的選項，exclude 屬性可以設置排除哪些目錄，例如：

"archive": {
　　"exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"]
}

bin文件
一組應該被視為二進制文件并符號鏈接到bin-dir （從config）的文件。
bin 文件相對于倉庫包的目錄地址
"bin": [
　　　　"util/xs"
　　]

二、依賴管理
軟件包鏈接 require
require告訴composer你的項目所依賴的包

"require": {
　　"php" : "^5.5 || ^7.0",
　　"monolog/monolog": "1.0.*"
}

require需要將包名稱（例如monolog/monolog）映射 到版本約束（例如 1.0.*）的對象。
composer show --platform命令列出了系統上可用的所有PHP擴展
限制PHP版本[ php 版本要求 ]

"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是默認值。例如："minimum-stability": "stable"

require-dev

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

"require-dev": {
    　　"codeception/codeception": "2.0.0 "
}

加了這個依賴后，再運行下命令看看效果。
composer install

三、自動加載
自動加載lib目錄下的OrderManager.php文件
1.使用Files方式(ps:通常作為函數庫的載入方式（而非類庫）)

"autoload":{
    　　"files":["lib/OrderManager.php"]
}

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

composer dump-autoload

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

2.Classmap方式自動加載

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

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

再此運行composer dump-autoload，嘗試調用，依然能夠成功創建OrderManager類。其實，classmap通過建立類到文件的對應關系，
當程序需要OrderManager類時，compoer的自動加載類通過查找OrderManager類所在的文件，然后再將改文件include進來。因此，這
又導致了一個問題，那就是每加一個新類，就需要運行一次composer dump-autoload來創建類到文件到對應關系。

從classmap中排除文件
如果要從類映射中排除某些文件或文件夾，可以使用“from-classmap”屬性，這些類將從類映射中跳過

"autoload": {
        　　"exclude-from-classmap": ["/Tests/", "/test/", "/tests/"]
    }

3. PSR0/4加載方式
PSR-0，PSR-4，類文件都要求有個命名空間

PSR-0則規定類名中的下劃線_會被轉化成目錄分隔符

namespace SilkLib;
class OrderManager
{
    　　public function test()
    　　{
        　　　　echo "hello";
    　　}
 }

同時，文件夾的結構也要修改成：應用根目錄\lib\SilkLib\OrderManager.php
然后修改composer.json里的autoload部分如下：

"autoload":{
    　　"psr-0":{
        　　　　"SilkLib":"lib/"
    　　}
}

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

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

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

如果您需要在多個目錄中搜索相同的前綴，則可以將它們指定為數組：

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

注意Silk\lib是雙斜桿。好了，那我們試試再加一個類，然后不用運行composer dump-autoload命令，看看新類是否能加載上。在
lib目錄下，新增一個ShipManager.php文件，內容如下：

namespace Silk\lib;
class ShipManager
{
    　　public function test()
    　　{
        　　　　echo 'hello ship class';
    　　}
}

嘗試在vendor 同級目錄下的index.php文件中調用：

$orderMgr = new Silk\lib\OrderManager();
$orderMgr->test();
$shipMgr = new Silk\lib\ShipManager();
$shipMgr->test();

運行成功，說明使用psr-0規范進行自動加載，比classmap更加方便。

可以直接指定到類級別。這對于在全局命名空間中只有一個類的庫很有用，
php源文件也位于包的根目錄中，則可以如下聲明：

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

如果您想要有一個可以使用命名空間的備用目錄，則可以使用空的前綴，如：

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

在psr-4關鍵字下，您可以定義相對于包根的命名空間到路徑的映射

下面試試psr-4方式，整理下目錄結構，改成：應用根目錄\lib\OrderManager.php，類文件修改命名空間為Silk[包根目錄文件夾名/
包里文件夾名稱],
修改autoload

"autoload":{    　　"psr-4":
　　{        　　　　"Silk\\":"lib",  // Silk 代表著--->項目類文件中的命令空間，將Silk 命名空間綁定到  /用戶名/倉庫名/lib 目錄下                         　　　　// 文件夾路徑：  
　　　　　　vedor/
　　　　　　　　用戶名/
　　　　　　　　　　倉庫名稱/
　　　　　　　　　　　　composer.json
　　　　　　　　　　　　lib/ 　
　　　　　　　　　　　　　　Classname.php　 lib這文件夾下的類文件 ----> 類名要和類文件同名， 類文件的命名空間統一為  Silk
　　　　"Monolog\\": "src/",    　　}}//調用是  先引入vendor/autoload.php

使用命名空間：
use   \Silk\類名---->等同于  使用包里的 lib\類文件---->類名

再次運行composer dump-autoload

如果您需要在多個目錄中搜索相同的前綴，則可以將它們指定為數組：

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

如果您想要有一個可以在任何命名空間中查找的備用目錄，您可以使用一個空的前綴，如：

  "autoload": {
        　　"psr-4": { ""exclude" }
  }

感謝各位的閱讀！關于“如何配置composer.json”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！