PHP建立自己Composer包的方法

這篇文章主要給大家介紹了PHP建立自己的Composer包方法，有需要的朋友可以看一看

倉庫（Repository）

倉庫是軟體開發中常見的概念，與源（sources）意義相近，主要指託管資源的場所。許多軟體都有倉庫的概念，例如yum、npm、maven、Git，以及本文的主角Composer。倉庫以中心化的方式託管資源，為軟體的正常工作提供保障。

Packagist 是Composer預設的中央倉庫，PHP社區的絕大部分Composer包都託管在該網站上。Packagist提供公開的、免費的託管服務，任何人均可註冊、自由發布包，無需審核。Packagist由Private Packagist提供託管和維護，兩者的主要區別為：Packagist的官網是https://packagist.org，託管...，託管的代碼無需開源，倉程式庫伺服器可位於內網，提供更快、更高效的包代碼託管服務。

可以配置多個倉庫，Composer會自動找出最適合項目的依賴包。搜尋包的流程如下：首先檢查當前項目是否配置額外倉庫，有則優先在額外倉庫中檢索；無結果向上到全域配置中的額外倉庫檢索；未配置或搜尋無結果的情況下，回退到預設的Packagist中央倉庫檢索。除非禁用了預設的倉庫，Packagist中的包總會被檢索到。因為這個原因，Composer推薦PHP開發人員將包託管在Packagist網站上，方便他人檢索和引用。

配置倉庫

有兩種方法對Composer的倉庫進行配置：命令列和編輯設定檔。composer config是Composer配置的命令，可以用來設定項目或全域的倉庫資訊，例如：

composer config [-g] repo.packagist composer https://packagist.phpcomposer.com

第二種方法是編輯設定檔。編輯項目的composer.json或~/.config/composer/config.json，增加repositories一項配置，例如：

"repositories": {  "packagist": {    "type": "composer",    "url": "https://packagist.phpcomposer.com"  }}

以上配置使用 Packagist中國全量鏡像 網站作為預設中央倉庫。在大陸地區部署PHP項目，建議使用該倉庫目錄，能加速依賴包的下載。

倉庫配置最重要的兩個參數是type和url。type指明倉庫的類型，url則指向具體網址。根據倉庫的位置，常用的type可選值有：

1. composer，Composer包託管倉庫，例如 Packagist中國全量鏡像；

2. vcs，版本控制管理系統，例如Github上的項目地址；

3. pear，PEAR上的包；

4. package，位於互連網上包；

5. artifact，代碼zip包合集；

6. path，指向代碼具體位置。
   

互連網上的倉庫，type的常見值是composer和vcs；本地的項目，常見值是artifact和path。具體用例，可參考Composer官方文檔。

掌握了倉庫的概念和其配置，接下來我們建立自己的包。

建立自己的Composer包

建立一個Composer包只需兩步：1. 填寫包描述資訊；2. 寫代碼。本文建立一個hello-composer的包來示範建立過程。該包功能只有一個：輸出字串“Hello, Composer!”。

Composer包的描述資訊存放在composer.json檔案中，可直接建立（或從其他項目拷貝）composer.json檔案，手動填充必要的欄位資訊；也可以用composer init命令，互動輸入包資訊，產生composer.json檔案後再補全其他欄位資訊。我們採取直接編輯檔案的方式，在composer.json中輸入如下內容：

{  "name": "tlanyan/hello-composer",  "description": "Hello, Composer!",  "type": "library",  "require": {    "php": ">=7.0"  },  "license": "MIT",  "authors": [    {      "name": "tlanyan",      "email": "tlanyan@hotmail.com"    }  ],  "minimum-stability": "stable",  "autoload": {    "psr-4": {      "tlanyan\\": "src/"    }  }}

以上內容基本上是一個Composer包的必備欄位。其他欄位可參考Composer官網的composer.json說明。需注意標記為root-only的欄位，root-only表示當前包為主專案時才生效。例如require-dev欄位，在當前項目中開發，欄位內的包會下載放到vendor檔案夾內；如果該項目被其他項目引用，則該欄位的值被忽略，引用的包不會被下載。

接下來編寫代碼。在src目錄下建立HelloComposer.php：

namespace tlanyan;class HelloComposer{  public static function greet()  {    echo "Hello, Composer!", PHP_EOL;  }}

代碼風格建議參考PSR-2規範，檔案命名和路徑規範建議參考PSR-4規範。另外需注意檔案的路徑需與composer.json中autoload的值相匹配。

通過簡單兩步，我們建立的自己的Composer包。接下來在其他項目中引用該包。

引用Composer包

建立一個test項目，引用上文建立的包並查看效果，步驟如下：

1.建立test檔案夾，拷貝或者建立composer.json檔案，配置如下：

  {    ....    "require": {      "tlanyan/hello-composer": "*"    },    "minimum-stability": "dev",    "repositories": {      "local": {        "type": "path",        "url": "/path/to/hello-composer"      }    },    ....  }

設定檔需要注意兩點： 1. 如果hello-composer的composer.json檔案沒有version欄位（或不是穩定版），minimum-stability值要是dev（預設是stable），否則無法安裝； 2. 需添加自訂倉庫，type值為path。

2.執行composer install -vvv安裝依賴包，安裝完成後vendor目錄下產生tlanyan/hello-composer目錄。

3.在test中建立Test.php檔案，引用HelloComposer類：

  namespace test;    require "vendor/autoload.php";    use tlanyan\HelloComposer;    class Test  {    public static main()    {      HelloComposer::greet();    }  }    Test::main();

.執行Test.php：php Test.php，輸出"Hello, Composer!"。

通過配置Composer倉庫，我們成功引用了建立的hello-composer包。測試沒問題後，就發行就緒到網上供其他人使用。下面簡要說是發布流程。

發布Composer包

將Composer包發布到互連網的方式有幾種：

1. 打包成zip，上傳到任意一個可公開訪問的網站；

2. 通過版本控制軟體，上傳到代碼倉庫；

3. 提交到PEAR社區；

4. 提交到私人的Composer倉庫；

5. 提交到Packagist。
   

前四種方式，需要使用者配置倉庫資訊才能檢索到包（PEAR社區幾乎已死，可以忽略）。如果代碼開源，建議提交到Packagist，方便全世界的PHP開發人員檢索和使用，為Composer生態做貢獻。

提交包到Packagist，要經曆以下過程：

1. 在Github建立項目並提交代碼；

2. 在Packagist輸入項目地址提交包；

3. 在Github設定項目，觸發Packagist自動更新。
   

前兩步是必須的，第三步可選。本著為提交的包負責的態度，強烈建議完成第三步操作。

提交包的過程涉及到Github和Packagist兩個網站，Github和Packagist之間的關係為：Github託管實際的代碼和檔案；Packagist託管包的作者、包名、版本號碼、下載量等中繼資料保。簡要說Packagist是索引，Github是內容提供方。

詳細步驟可參考官網指引或網上教程，網上相關內容太多，本文不再重複。

總結

本文介紹了Composer倉庫的概念，建立了一個完整的Composer包，並給出提交包到Packagist的指引。使用者掌握相關概念和運行機制後，可提交代碼為社區做貢獻，也可跳出Packagist自由的引用和安裝依賴包。