Laravel 開發(fā)擴(kuò)展包基本流程

AaronYuan 發(fā)布于2019-06-27 16:06 / 2578人閱讀

摘要：介紹在中就有開發(fā)的相關(guān)介紹這其中需要運(yùn)用當(dāng)然對于我們開發(fā)人員來說開發(fā)一個(gè)擴(kuò)展包還是很值得學(xué)習(xí)的現(xiàn)在就來開發(fā)一個(gè)消息通知的擴(kuò)展包擴(kuò)展包的地址整個(gè)參照的新建包在生成好的項(xiàng)目中新建目錄和同級(jí)接著在目錄下新建包目錄我們需要去項(xiàng)目下去聲明包的命名空間

介紹

在Laravel中就有Laravel Composer Package開發(fā)的相關(guān)介紹這其中需要運(yùn)用 Service Providers 當(dāng)然對于我們Laravel開發(fā)人員
來說開發(fā)一個(gè)擴(kuò)展包還是很值得學(xué)習(xí)的現(xiàn)在就來開發(fā)一個(gè)消息通知的擴(kuò)展包

擴(kuò)展包的地址:https://github.com/GeekGhc/LaraFlash
整個(gè)package參照    Jeffrey Way的Flash Packages

新建包

在生成好的Laravel項(xiàng)目中新建packages目錄(和app同級(jí)) 接著在packages目錄下新建包目錄 packages/geekghc/laraflash

我們需要去laravel項(xiàng)目下去聲明包的命名空間:

"autoload": {
    "classmap": [
        "database"
    ],
    "psr-4": {
        "App": "app/",
        "GeekGhcLaraFlash":"packages/geekghc/laraflash/src/"
    }
},

聲明完畢之后別忘了去執(zhí)行重新生成autoload文件

$ composer dump-autoload

我們需要新建src目錄來存放我們的源文件

接著因?yàn)槲覀兪情_發(fā)一個(gè)擴(kuò)展包之后還需要進(jìn)行測試開發(fā) 所以我們?nèi)ド梢粋€(gè)composer.json文件

$ composer init

填寫完基本信息之后在packages/geekghc/laraflash目錄下就會(huì)生成一個(gè)composer.json文件:

我先給出

{
    "name": "geekghc/flash",
    "description": "flash for laravel",
    "license": "MIT",
    "authors": [
        {
            "name": "GeekGhc",
            "email": "ghcgavin@sina.com"
        }
    ],
    "minimum-stability": "dev",
    "require": {
        "php": ">=5.5.9",
    },
    "require-dev": {
        "phpunit/phpunit": "~5.7",
        "mockery/mockery": "0.9.*"
    },
    "autoload": {
        "psr-0": {
            "GeekGhcLaraFlash": "src/"
        },
        "files": [
            "src/GeekGhc/LaraFlash/function.php"
        ]
    }
}

完成好composer.json后我們可以去src/GeekGhc/LaraFlash目錄下新建一個(gè)Flash.php


我們這里繼承了Facade類，用Facades可以訪問IoC容器中注冊的類 這樣我們就可以去調(diào)用注冊的類
同時(shí)我們需要去新建一個(gè)Service Provider
$ php artisan make:provider FlashProvider
將生成的 app/Providers/FlashProvider.php 文件移動(dòng)到我們的 packages/geekghc/laraflash/src/GeekGhc/LaraFlash/ 目錄下面，并注冊 FlashProvider 到 config/app.php 
在FlsahProvider里面我們?nèi)懸幌轮笪覀冃枰壎ǖ念?
public function register()
{
    $this->app->bind(
        "GeekGhcLaraFlashSessionStore",
        "GeekGhcLaraFlashLaravelSessionStore"
    );

    $this->app->singleton("laraflash",function(){
        return $this->app->make("GeekGhcLaraFlashFlashNotifier");
    });
}
這邊我們就綁定了封裝好的SessionStore 之后我們?nèi)ヅ渲靡幌乱晥D的路徑
public function boot()
{
    $this->loadViewsFrom(__DIR__."/../../views","laraflash");
    $this->publishes([
        __DIR__."/../../views"=>base_path("resources/views/vendor/laraFlash"),
    ]);
}
這里我們就發(fā)布了我們的視圖文件 如果在項(xiàng)目里去執(zhí)行
$ php artisan vendor:publish
我們就可以在resources/views/vendor/laraFlash去自定義自己需要的樣式效果
接著在config/app.php去注冊我們的服務(wù)
"providers" => [
    GeekGhcLaraFlashMyFlashProvider::class,
];
為了方便使用 可以再去添加一個(gè)alias
"aliases" => [
    "LaraFlash"=>GeekGhcLaraFlashFlash::class,
];
接著我們可以去實(shí)現(xiàn)flash的主要功能服務(wù) 每個(gè)包的功能都根據(jù)需求而來 這里也不多做介紹
最后的目錄結(jié)構(gòu)是這樣的
|
|—— packages 
| |—— geekghc
|   |—— laraflash 
|     |—— src            源文件
|       |—— GeekGhc      源文件
|         |—— LaraFlash     
|           |—— Flash.php     
|           |—— FlashNotifier.php     
|           |—— function.php     
|           |—— FlashProvider.php     
|           |—— SessionStore.php     
|           |—— LaravelSessionStore.php     
|       |—— views        視圖文件
|     |—— tests          測試目錄
|     |—— vendor         測試需要的包
|     |—— .gitignore    
|     |—— composer.json    
|     |—— composer.lock    
|     |—— phpunit.xml  
|     |—— readme.md
這樣的話 我們就在本地寫好了擴(kuò)展包  我們其實(shí)可以去創(chuàng)建一個(gè)控制器去測試我們這個(gè)包是否正常
在視圖home.blade.php我們就可以去包含views里面的視圖文件
@include("laraflash::notification")
或者
@include("laraflash::header-notification")
接著在控制器去使用類似這樣的形式:

LaraFlash::success("Message")

LaraFlash::info("Message")

LaraFlash::error("Message")

LaraFlash::warning("Message")


包的具體使用去GeekGhc/LaraFlash看一下具體使用就知道了
最后的效果大概就是這樣的:


顯示正常之后我們就可以去發(fā)布我們的package了
在github先創(chuàng)建一個(gè)倉庫 當(dāng)然我這里的就是創(chuàng)建了LaraFlash這個(gè)遠(yuǎn)程倉庫
緊接著我們?nèi)ネ坪梦覀兊拇a到github
接著我們需要去倉庫的setting => Intergrations&services添加Packagist服務(wù)(填寫好用戶名和Token)
添加完畢之后去Packagist  Submit這個(gè)倉庫(提供遠(yuǎn)程倉庫的地址)
在github進(jìn)入packagist測試通過之后就ok了
因?yàn)槲覀冎岸x的dev版本 如果后期有人提出了一些issues你去修改了自己的package
那么我們會(huì)去增加別的tag  也是就是說你修改package之后 再去添加一個(gè)tag:
$ git tag 2.0 -a
填寫說明信息后 推送這個(gè)tag:
$ git push --tags
這樣一來我們就發(fā)布了v2.0這個(gè)版本  這就是我們發(fā)布擴(kuò)展包大概流程
博客文章地址Laravel Package
參考資料

Laravel Composer Package 開發(fā)簡明教程

Laravel 的擴(kuò)展插件開發(fā)指南

Laravel Package Development