PHP回顧之建立自己的Composer包

tlanyan發表於2019-03-04
PHP

轉載請註明文章出處：tlanyan.me/php-review-…

PHP回顧系列目錄

前文 PHP回顧之Composer 簡要介紹了Composer的相關概念和簡要用法，應付日常開發已無大礙。想要更好的利用Composer協同工作，學會建立自己的Composer包是一項必不可少的技能。本文先講解Composer倉庫的概念，再給出建立和釋出Composer包的步驟。

倉庫（Repository）

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

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

可以配置多個倉庫，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。

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

  2. 在test中新建Test.php檔案，引用HelloComposer類：


    namespace test;
    
    require "vendor/autoload.php";
    
    use tlanyanHelloComposer;
    
    class Test
    {
        public static main()
        {
            HelloComposer::greet();
        }
    }
    
    Test::main();
複製程式碼
  1. 執行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自由的引用和安裝依賴包。

參考

  1. getcomposer.org/doc/
  2. packagist.org/about
  3. www.phpcomposer.com/

相關文章