如何開發、本地測試、發佈 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.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。

2. 把擴展包發佈到 Packagist

而後，訪問 Packagist 官網，登陸後，點擊右上角Submit按鈕，進入發佈嚮導:

此時，將 GitHub 版本庫的地址填寫至 Repository URL 輸入框中，而後點擊 Submit 提交按鈕，一切順利，能夠看到發佈成功。

3. 設置代碼同步

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

添加服務，服務列表中選擇 Packagist，主要填寫兩項 Packagist 配置信息：

用戶名： 注意是 Packagist 上的用戶名
Token： 通信令牌
Domain： 可不用填寫

其中 Token 須要到 Packagist 的我的設置裏面去獲取。

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

Okay, the test payload is on its way.

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

4. 設置版本信息

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

git tag 1.0.0
git push --tag

擴展包剛發佈，此時安裝，可能會報找不到安裝包的錯誤，須要稍等一下服務器同步，通常不過超過 3-5 分鐘，若是一切正常，會看到版本提示，安裝成功！

參考文獻

• Laravel 的擴展插件開發指南
• 人人爲我，我爲人人！向社區發佈本身的 Composer 包
• Composer & Laravel 包本地開發