如何開發、本地測試、釋出 Laravel 擴充套件包？

無銘發表於2018-01-10
Laravel套件

現在已經有了很多，關於如何開發 Laravel 擴充套件包的文章。但是大多文章寫的太過片面，不夠完整，而且我在實際進行開發擴充套件包的時候，還是遇到了很多的問題，我把自己的開發經驗，以及遇到的問題記錄下來，分享給大家。

擴充套件包開發

1. 建立新專案，初始化擴充套件包配置

首先建立一個新的 Laravel 專案：

composer create-project laravel/laravel laradmin -vvv

接下來在此專案中，建立目錄 packages/{your_name}/{your_package_name}

mkdir -p packages/angkee/laradmin

進入擴充套件包目錄，初始化 composer 配置

cd packages/angkee/laradmin
composer init

composer init

執行之後，專案下生成一個 composer.json 檔案：

{
    "name": "angkee/laradmin",
    "description": "Laradmin is a laravel package for can be generated fast backend management panel",
    "license": "MIT",
    "authors": [
        {
            "name": "angkee",
            "email": "angkee@qq.com"
        }
    ],
    "require": {}
}
複製程式碼

2. 建立擴充套件包基本目錄、檔案

一般情況下，我們會建立以下檔案和目錄:

angkee/laradmin
├── src  #存放擴充套件包所有的邏輯程式碼
├── tests # 存放測試用例
├── README.md
├── composer.json
└── LICENSE
複製程式碼

3. 修改擴充套件包 composer 配置

然後，修改此擴充套件包中的 composer.json 檔案，設定一下 composer 的自動載入配置、以及擴充套件包的名稱空間。

{
    ...,
    "autoload": {
        "psr-4": {
            "Angkee\\Laradmin\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Angkee\\Laradmin\\Tests\\": "tests/"
        }
    },
    ...
}
複製程式碼

4. 編寫擴充套件包邏輯程式碼

接下來，我們來建立 AdminServiceProvider.php、Admin.php 檔案。

<?php

namespace Angkee\Admin;

use Illuminate\Support\ServiceProvider;

class AdminServiceProvider extends ServiceProvider
{
    public function boot()
    {
        //
    }

    public function register()
    {
        $this->app->singleton('admin', function () {
            return new Admin;
        });
    }
}
複製程式碼
<?php

namespace Angkee\Admin;

class Admin
{
    public function printRunning()
    {
        echo 'running';
    }
}
複製程式碼

此時，這個擴充套件包算是開發好了，接下來我們開始進行本地安裝、測試。

擴充套件包本地測試

把 AdminServiceProvider 新增到專案的 config/app.php providers 陣列中

'providers' => [
    ...,
    Angkee\Admin\AdminServiceProvider::class,
],
複製程式碼

再修改專案下的 composer.json 檔案

{
    "require": {
        ...,
        "angkee/laradmin": "dev-master"
    },
    ...,
    "autoload": {
        ...,
        "psr-4": {
            ...,
            "Angkee\\Admin\\": "packages/laradmin/src/"
        }
    },
    ...
}
複製程式碼

執行命令：

composer dump-autoload
composer update

最後，修改一下 routes/web.php 檔案：

Route::get('/', function () {
    app('admin')->printRunning();
});
複製程式碼

此時，我們開啟瀏覽器訪問此專案，顯示 running，恭喜你，成功了!

擴充套件包釋出

擴充套件包開發、測試完成之後，這個時候就可以釋出到 Packagist。

1. 提交程式碼到 GitHub

首先，需要把擴充套件包的程式碼提交到 GitHub 上，記錄下 GitHub 版本庫的地址，注意是 HTTPS。

laradmin-github

2. 把擴充套件包釋出到 Packagist

然後，訪問 Packagist 官網，登入後，點選右上角Submit按鈕，進入釋出嚮導:

packagist-submit

此時，將 GitHub 版本庫的地址填寫至 Repository URL 輸入框中，然後點選 Submit 提交按鈕，一切順利，可以看到釋出成功。

angkee-laradmin

3. 設定程式碼同步

一旦在 Pakagist上釋出了包，之後的版本更新和程式碼同步，有一個機制來保證，就是 GitHub 中的事件通知服務，用於程式碼遞交時觸發一個事件，將程式碼同步到其他環境中。

Pakagist

新增服務，服務列表中選擇 Packagist，主要填寫兩項 Packagist 配置資訊：

使用者名稱： 注意是 Packagist 上的使用者名稱 Token： 通訊令牌 Domain： 可不用填寫

其中 Token 需要到 Packagist 的個人設定裡面去獲取。

填寫完畢，提交後，記得測試一次，完成首次同步，成功會提示資訊。

Okay, the test payload is on its way.

Pakagist

回到Packagist，重新整理，應該沒有再出現 (Not Auto-Updated) 的提示，說明同步機制已經生效，之後每次 GitHub 變化，會自動通知並同步。

4. 設定版本資訊

版本預設是 dev-master，Composer 包的版本號會從 Git 的 tag 中同步過來。

git tag 1.0.0
git push --tag

擴充套件包剛釋出，此時安裝，可能會報找不到安裝包的錯誤，需要稍等一下伺服器同步，一般不過超過 3-5 分鐘，如果一切正常，會看到版本提示，安裝成功！

參考文獻

相關文章