PHP創(chuàng)建自己的Composer包方法

倉(cāng)庫(kù)（Repository）

倉(cāng)庫(kù)是軟件開(kāi)發(fā)中常見(jiàn)的概念，與源（sources）意義相近，主要指托管資源的場(chǎng)所。許多軟件都有倉(cāng)庫(kù)的概念，例如yum、npm、maven、Git，以及本文的主角Composer。倉(cāng)庫(kù)以中心化的方式托管資源，為軟件的正常工作提供保障。

Packagist 是Composer默認(rèn)的中央倉(cāng)庫(kù)，PHP社區(qū)的絕大部分Composer包都托管在該網(wǎng)站上。Packagist提供公開(kāi)的、免費(fèi)的托管服務(wù)，任何人均可注冊(cè)、自由發(fā)布包，無(wú)需審核。Packagist由Private Packagist提供托管和維護(hù)，兩者的主要區(qū)別為：Packagist的官網(wǎng)是https://packagist.org，托管...，托管的代碼無(wú)需開(kāi)源，倉(cāng)庫(kù)服務(wù)器可位于內(nèi)網(wǎng)，提供更快、更高效的包代碼托管服務(wù)。

可以配置多個(gè)倉(cāng)庫(kù)，Composer會(huì)自動(dòng)找出最適合項(xiàng)目的依賴包。搜索包的流程如下：首先檢查當(dāng)前項(xiàng)目是否配置額外倉(cāng)庫(kù)，有則優(yōu)先在額外倉(cāng)庫(kù)中檢索；無(wú)結(jié)果向上到全局配置中的額外倉(cāng)庫(kù)檢索；未配置或搜索無(wú)結(jié)果的情況下，回退到默認(rèn)的Packagist中央倉(cāng)庫(kù)檢索。除非禁用了默認(rèn)的倉(cāng)庫(kù)，Packagist中的包總會(huì)被檢索到。因?yàn)檫@個(gè)原因，Composer推薦PHP開(kāi)發(fā)人員將包托管在Packagist網(wǎng)站上，方便他人檢索和引用。

配置倉(cāng)庫(kù)

有兩種方法對(duì)Composer的倉(cāng)庫(kù)進(jìn)行配置：命令行和編輯配置文件。composer config是Composer配置的命令，可以用來(lái)配置項(xiàng)目或全局的倉(cāng)庫(kù)信息，例如：

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

第二種方法是編輯配置文件。編輯項(xiàng)目的composer.json或~/.config/composer/config.json，增加repositories一項(xiàng)配置，例如：

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

以上配置使用 Packagist中國(guó)全量鏡像 網(wǎng)站作為默認(rèn)中央倉(cāng)庫(kù)。在大陸地區(qū)部署PHP項(xiàng)目，建議使用該倉(cāng)庫(kù)目錄，能加速依賴包的下載。

倉(cāng)庫(kù)配置最重要的兩個(gè)參數(shù)是type和url。type指明倉(cāng)庫(kù)的類型，url則指向具體網(wǎng)址。根據(jù)倉(cāng)庫(kù)的位置，常用的type可選值有：

1. composer，Composer包托管倉(cāng)庫(kù)，例如 Packagist中國(guó)全量鏡像；
2. vcs，版本控制管理系統(tǒng)，例如Github上的項(xiàng)目地址；
3. pear，PEAR上的包；
4. package，位于互聯(lián)網(wǎng)上包；
5. artifact，代碼zip包合集；
6. path，指向代碼具體位置。
   

互聯(lián)網(wǎng)上的倉(cāng)庫(kù)，type的常見(jiàn)值是composer和vcs；本地的項(xiàng)目，常見(jiàn)值是artifact和path。具體用例，可參考Composer官方文檔。

掌握了倉(cāng)庫(kù)的概念和其配置，接下來(lái)我們創(chuàng)建自己的包。

創(chuàng)建自己的Composer包

創(chuàng)建一個(gè)Composer包只需兩步：1. 填寫(xiě)包描述信息；2. 寫(xiě)代碼。本文創(chuàng)建一個(gè)hello-composer的包來(lái)演示創(chuàng)建過(guò)程。該包功能只有一個(gè)：輸出字符串“Hello, Composer!”。

Composer包的描述信息存放在composer.json文件中，可直接新建（或從其他項(xiàng)目拷貝）composer.json文件，手動(dòng)填充必要的字段信息；也可以用composer init命令，交互式的輸入包信息，生成composer.json文件后再補(bǔ)全其他字段信息。我們采取直接編輯文件的方式，在composer.json中輸入如下內(nèi)容：

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

以上內(nèi)容基本上是一個(gè)Composer包的必備字段。其他字段可參考Composer官網(wǎng)的composer.json說(shuō)明。需注意標(biāo)記為root-only的字段，root-only表示當(dāng)前包為主項(xiàng)目時(shí)才生效。例如require-dev字段，在當(dāng)前項(xiàng)目中開(kāi)發(fā)，字段內(nèi)的包會(huì)下載放到vendor文件夾內(nèi)；如果該項(xiàng)目被其他項(xiàng)目引用，則該字段的值被忽略，引用的包不會(huì)被下載。

接下來(lái)編寫(xiě)代碼。在src目錄下新建HelloComposer.php：

namespace tlanyan;

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

代碼風(fēng)格建議參考PSR-2規(guī)范，文件命名和路徑規(guī)范建議參考PSR-4規(guī)范。另外需注意文件的路徑需與composer.json中autoload的值相匹配。

通過(guò)簡(jiǎn)單兩步，我們創(chuàng)建的自己的Composer包。接下來(lái)在其他項(xiàng)目中引用該包。

引用Composer包

新建一個(gè)test項(xiàng)目，引用上文創(chuàng)建的包并查看效果，步驟如下：

1.新建test文件夾，拷貝或者新建composer.json文件，配置如下：

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

配置文件需要注意兩點(diǎn)： 1. 如果hello-composer的composer.json文件沒(méi)有version字段（或不是穩(wěn)定版），minimum-stability值要是dev（默認(rèn)是stable），否則無(wú)法安裝； 2. 需添加自定義倉(cāng)庫(kù)，type值為path。

2.執(zhí)行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();

.執(zhí)行Test.php：php Test.php，輸出"Hello, Composer!"。

通過(guò)配置Composer倉(cāng)庫(kù)，我們成功引用了創(chuàng)建的hello-composer包。測(cè)試沒(méi)問(wèn)題后，就可以發(fā)布到網(wǎng)上供其他人使用。下面簡(jiǎn)要說(shuō)是發(fā)布流程。

發(fā)布Composer包

將Composer包發(fā)布到互聯(lián)網(wǎng)的方式有幾種：

1. 打包成zip，上傳到任意一個(gè)可公開(kāi)訪問(wèn)的網(wǎng)站；
2. 通過(guò)版本控制軟件，上傳到代碼倉(cāng)庫(kù)；
3. 提交到PEAR社區(qū)；
4. 提交到私有的Composer倉(cāng)庫(kù)；
5. 提交到Packagist。
   

前四種方式，需要用戶配置倉(cāng)庫(kù)信息才能檢索到包（PEAR社區(qū)幾乎已死，可以忽略）。如果代碼開(kāi)源，建議提交到Packagist，方便全世界的PHP開(kāi)發(fā)者檢索和使用，為Composer生態(tài)做貢獻(xiàn)。

提交包到Packagist，要經(jīng)歷以下過(guò)程：

1. 在Github創(chuàng)建項(xiàng)目并提交代碼；
2. 在Packagist輸入項(xiàng)目地址提交包；
3. 在Github配置項(xiàng)目，觸發(fā)Packagist自動(dòng)更新。
   

前兩步是必須的，第三步可選。本著為提交的包負(fù)責(zé)的態(tài)度，強(qiáng)烈建議完成第三步操作。

提交包的過(guò)程涉及到Github和Packagist兩個(gè)站點(diǎn)，Github和Packagist之間的關(guān)系為：Github托管實(shí)際的代碼和文件；Packagist托管包的作者、包名、版本號(hào)、下載量等元數(shù)據(jù)保。簡(jiǎn)要說(shuō)Packagist是索引，Github是內(nèi)容提供方。

詳細(xì)步驟可參考官網(wǎng)指引或網(wǎng)上教程，網(wǎng)上相關(guān)內(nèi)容太多，本文不再重復(fù)。

總結(jié)

本文介紹了Composer倉(cāng)庫(kù)的概念，創(chuàng)建了一個(gè)完整的Composer包，并給出提交包到Packagist的指引。用戶掌握相關(guān)概念和運(yùn)行機(jī)制后，可提交代碼為社區(qū)做貢獻(xiàn)，也可跳出Packagist自由的引用和安裝依賴包。