「12步」製做 Laravel 插件 (一)

時間 2019-11-26

標籤製做 laravel 插件简体版

原文原文鏈接

在Laravel 開發過程當中，用了不少諸如：laravel-admin，Guzzle，Intervention Image 等優秀的插件，看他們的 star 不少，獲得不少人的關注，就想着本身能不能寫個有價值的插件，共享給你們使用。php

今天就讓咱們來講說如何建立一個簡單的插件：「數字轉中文大寫金額」css

具體只須要如下「12」個步驟：html

1. 建立 Laravel 5.5 項目

// 下載最新 Laravel

composer global require "laravel/installer"

// 建立項目
Laravel new packagelearning
複製代碼

2. 建立插件文件夾

在 Laravel 項目 vendor 文件夾放的是各類第三方插件，咱們隨便看看，能夠發現這些插件基本遵循下面的文件目錄格式：laravel

如，monolog 插件，目錄結構爲 [VENDOR or CREATOR] / [PACKAGE NAME]，並且 src 文件夾基本用於保存插件源代碼，還有一個 composer.json 用於配置插件基本信息和引入其它第三方插件等信息。json

咱們在 packagelearning 項目建立 packages 文件夾：api

3. 建立 composer.json

咱們能夠利用「composer」命令來初始化 composer.json 文件：bash

輸入插件的基本信息後：服務器

4. PSR-4 autoload namespace mapping

在 composer.json 加入 autoload 配置：app

5. 建立 Service Providers

正如 Laravel 官網所說：composer

Service providers are the connection points between your package and Laravel. A service provider is responsible for binding things into Laravel's service container and informing Laravel where to load package resources such as views, configuration, and localization files.

因此咱們須要建立一個 Service Provider 來告訴 Laravel 使用該插件是，什麼 Controller 被執行了，Routes 和 Views 在哪加載等等。

// 在 Laravel項目根目錄執行命令

php artisan make:provider Num2nmbServiceProvider
複製代碼

再將 Num2nmbServiceProvider.php 文件移動到插件 src 文件夾下，並修改namespace 名爲：Fanly\Num2nmb

這也正如官網的說明同樣，service provider 主要包括兩個方法：register 和 boot方法。

A service provider extends the Illuminate\Support\ServiceProvider class and contains two methods: register and boot. The base ServiceProvider class is located in the illuminate/support Composer package, which you should add to your own package's dependencies. To learn more about the structure and purpose of service providers, check out their documentation.

有了 Service Provider，咱們能夠先加入到 config/app.php 中。

接下來讓咱們跟常規開發同樣，建立功能的 Controller，Route 和 View。

6. 建立 Controller

從網上 copy 了一段「數字金額轉中文大寫金額」功能，直接上代碼：

<?php
/**
 * Created by PhpStorm.
 * User: ye
 * Date: 2018/1/10
 * Time: 下午9:49
 */

namespace Fanly\Num2nmb;


use App\Http\Controllers\Controller;

class Num2nmbController extends Controller {

    public function index($num) {
        $nmb = $this->num2nmb($num);
        return view('num2nmb::nmb', compact('nmb'));
    }

    private function num2nmb($num) {
        $c1 = "零壹貳叄肆伍陸柒捌玖";
        $c2 = "分角元拾佰仟萬拾佰仟億";

        //精確到分後面就不要了，因此只留兩個小數位
        $num = round($num, 2);
        //將數字轉化爲整數
        $num = $num * 100;

        if (strlen($num) > 10) {
            return "金額太大，請檢查";
        }
        $i = 0;
        $c = "";
        while(1) {
            if ($i == 0) {
                //獲取最後一位數字
                $n = substr($num, strlen($num) - 1, 1);
            } else {
                $n = $num % 10;
            }    //每次將最後一位數字轉化爲中文
            $p1 = substr($c1, 3 * $n, 3);
            $p2 = substr($c2, 3 * $i, 3);
            if ($n != '0' || ($n == '0' && ($p2 == '億' || $p2 == '萬' || $p2 == '元'))) {
                $c = $p1 . $p2 . $c;
            } else {
                $c = $p1 . $c;
            }
            $i = $i + 1;
            //去掉數字最後一位了
            $num = $num / 10;
            $num = (int) $num;
            //結束循環
            if ($num == 0) {
                break;
            }
        }
        $j = 0;
        $slen = strlen($c);
        while ($j < $slen) {
            //utf8一個漢字至關3個字符
            $m = substr($c, $j, 6);
            //處理數字中不少0的狀況,每次循環去掉一個漢字「零」
            if ($m == '零元' || $m == '零萬' || $m == '零億' || $m == '零零') {
                $left = substr($c, 0, $j);
                $right = substr($c, $j + 3);
                $c = $left . $right;
                $j = $j - 3;
                $slen = $slen - 3;
            }
            $j = $j + 3;
        }

        //這個是爲了去掉相似23.0中最後一個「零」字
        if (substr($c, strlen($c) - 3, 3) == '零') {
            $c = substr($c, 0, strlen($c) - 3);
        }

        //將處理的漢字加上「整」
        if (empty($c)) {
            return "零元整";
        } else {
            return $c . "整";
        }
    }
}
複製代碼

7. 建立 View

這個很簡單了，從 welcome.blade.php 直接 copy 過來，放在 src/views/nmb.blade.php：

<!doctype html>
<html lang="{{ app()->getLocale() }}">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>Laravel</title>

    <!-- Fonts -->
    <link href="https://fonts.googleapis.com/css?family=Raleway:100,600" rel="stylesheet" type="text/css">

    <!-- Styles -->
    <style>
        html, body {
            background-color: #fff;
            color: #636b6f;
            font-family: 'Raleway', sans-serif;
            font-weight: 100;
            height: 100vh;
            margin: 0;
        }

        .full-height {
            height: 100vh;
        }

        .flex-center {
            align-items: center;
            display: flex;
            justify-content: center;
        }

        .position-ref {
            position: relative;
        }

        .top-right {
            position: absolute;
            right: 10px;
            top: 18px;
        }

        .content {
            text-align: center;
        }

        .title {
            font-size: 84px;
        }

        .links > a {
            color: #636b6f;
            padding: 0 25px;
            font-size: 12px;
            font-weight: 600;
            letter-spacing: .1rem;
            text-decoration: none;
            text-transform: uppercase;
        }

        .m-b-md {
            margin-bottom: 30px;
        }
    </style>
</head>
<body>
<div class="flex-center position-ref full-height">
    <div class="content">
        <div class="title m-b-md">
            {{ $nmb }}
        </div>
        <div class="links">
            <a href="https://laravel.com/docs">fanly</a>
        </div>
    </div>
</div>
</body>
</html>
複製代碼

8. 添加 Route

在 src目錄下，建立 routes.php 文件

Route::get('num2nmb/{num}', 'Fanly\Num2nmb\Num2nmbController@index');
複製代碼

9. 配置 Service Provider

有了 controller、view 和路由，直接在 Num2nmbServiceProvider 配置相關信息便可：

在 boot 函數中，加入代碼：

$this->loadViewsFrom(__DIR__.'/views', 'num2nmb');
複製代碼

在 register 函數加入代碼：

10. 測試

如圖：

11. Publishing the Views

最後，view 層是高度自定義層，因此有必要將 views 試圖 publish 到項目中，咱們就能夠改動顯示效果，而不至於去變化插件中 views 的代碼了，並且這自己也是不容許的。

能夠在 boot 函數中加入代碼：

$this->publishes([
            __DIR__.'/views' => base_path('resources/views/num2nmb'),
        ]);
複製代碼

最後，執行命令：

12. 使用「包自動發現」

Laravel 5.5 增長了一個新的功能「Package Auto Discovery」。這個功能使得 Laravel 能更容易地對包進行安裝和啓用的管理。

包的開發者能夠在 composer.json 文件中添加一個新的部分，用來告訴框架應該註冊哪些服務提供器或者它們的外觀。

咱們能夠試試這個功能，在插件的 composer.json 中加入以下代碼：

"extra": {
        "laravel": {
            "providers": [
                "Barryvdh\\Debugbar\\ServiceProvider"
            ]
        }
    }
複製代碼

注：有關「Package Auto Discovery」功能的說明和使用，能夠參考：

1. 深刻了解 Laravel 5.5 Package Auto Discovery zhuanlan.zhihu.com/p/27518011

2. Laravel 5.5 支持包自動發現（新功能早知道）laravel-china.org/articles/49…

3. Laravel Package Auto-Discovery laravel-news.com/package-aut…

4. Package Auto-Discovery In Laravel 5.5 medium.com/@taylorotwe…

總結

下一步，咱們須要將作好的插件包提交服務器，供其餘人使用。

「未完待續」

coding01 期待您繼續關注

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。