no-image

手把手教你發佈自己的 Composer 包

                                    

一、前言

Composer 是 PHP 用來管理依賴(dependency)關系的工具。我們不僅要學會使用別人提供的包,更要學會制作和分享自己的軟件包,下面演示如何創建一個自己的 Composer 包。

準備工作:

  1. 註冊 Github 賬號
  2. 註冊 Packagist 賬號

二、實踐

本案例演示如何創建一個第三方消息推送(極光推送)的包。

1. 創建 Github 倉庫

登錄 Github,創建倉庫 yanlongma/push,並將代碼克隆到本地:

$ git clone https://github.com/yanlongma/push.git

2. 創建 Composer 配置文件

進入項目根目錄,創建 Composer 配置文件 composer.json,可以使用命令 compser init 創建也可以手動創建,最終文件內容大體如下:

{
    "name": "yanlongma/push",
    "description": "Third party message push",
    "authors": [
        {
            "name": "Yanlong Ma"
        }
    ],
    "license": "MIT",
    "require": {
        "php": ">=5.4"
    },
    "autoload": {
        "psr-4": {
            "YanlongMa\\Push\\": "src/"
        }
    }
}

3. 提交代碼到 Github

根據自己需要實現的功能編寫代碼,本項目最終項目結構如下:

.git/  
.gitignore  
composer.json  
README.md  
src/
    Client.php	
    JPush.php

代碼編寫完成且測試沒問題後提交代碼到 Github。

4. 發佈包到 Packagist

登錄 Packagist,檢出 https://github.com/YanlongMa/push.git 倉庫的代碼,系統會根據倉庫中 composer.json 文件自動設置包的相關信息。

5. 設置 Packagist 中的包自動更新

如果不設置自動同步,每次 Github 中的代碼更新,需要在對應包中手動更新,所以建議設置自動更新。步驟如下:

  1. 進入 yanlongma/push 倉庫,選擇 "Settings -> Integrations & services";
  2. 點擊 "Add service",選擇 “Packagist”;
  3. 填寫你的 Packagist 賬號對應的信息(登錄後點擊查看https://packagist.org/profile/
  4. 配置完成後,點擊右上角的“Test service”,如果出現 “Okay, the test payload is on its way.”,則說明配置成功。

6. 使用共享包

發佈包到 Packagist 後,根據包名就可以搜索和使用該包瞭,在自己的項目中申明該包依賴:

$ composer require yanlongma/push

該包的具體使用可以查看 https://github.com/yanlongma/push

  • 發佈包到 Packagist 後,可能過幾分鐘才能在客戶端 search 到;
  • 沒有打 tag 的要指定 dev,完整命令composer require "yanlongma/push @dev"

本文首發於馬燕龍個人博客,歡迎分享,轉載請標明出處。
馬燕龍個人博客:http://www.mayanlong.com
馬燕龍個人微博:http://weibo.com/imayanlong
馬燕龍Github主頁:https://github.com/yanlongma

關聯文章