在 Laravel 中使用枚舉

文章轉發自專業的Laravel開發者社區，原始連接：learnku.com/laravel/t/3…

我是enums的忠實粉絲最近，我在一家使用C#的公司工做，那裏普遍使用enum，我已經習慣了在找不到它們的時候，可以找到它們，並想念它們。

我將它們用於任何具備有限一組可能選項的事情，例如一週中的幾天、訂單的狀態，或者，以下面的示例中所示，用戶類型。

使用枚舉有幾個好處：

-減小因轉置或錯誤輸入數字而致使的錯誤。

-使未來改變價值觀變得容易。

-使代碼更易於閱讀，這意味着不太可能有錯誤潛入其中。

-確保前向兼容性使用枚舉時，若是未來有人更改與成員名稱對應的值，能夠大大下降你的代碼失敗概率。

PHP 自己並不支持枚舉，可是使用類中的常量至關容易實現等價的效果。 此外，我還建立了一個名爲 laravel-enum 的 Laravel 包。 它容許你訪問幫助函數，例如列出鍵和值,將描述附加到值上，以及驗證指望枚舉值的請求。

本指南逐步介紹了安裝的過程 Laravel package 包括用法和最佳實踐的示例。

安裝包

能夠經過 composer 在終端中運如下命令來安裝包:

$ composer require bensampo/laravel-enum

複製代碼

若是你使用的是低於5.5的 Laravel 版本，你須要將服務提供者添加到  config/app.php.

'BenSampo\Enum\EnumServiceProvider'

複製代碼

##建立第一個枚舉

咱們將爲用戶類型建立一個枚舉在咱們的示例應用程序中，用戶能夠屬於如下三種用戶類型之一：管理員、付費成員、成員。

包中包含用於建立枚舉的生成器，所以能夠運行如下命令來建立名爲UserType的枚舉該文件將在「app/Enums/UserType.php」中建立

php artisan make:enum UserType

複製代碼

你將在這個文件中看到必定數量的腳手架。在文件頂部附近，可能的選項列表被定義爲常量。這些常量值存儲在數據庫中，所以我發現最好是使用整數，可是並無限制必定要使用整數，只要每個值都是惟一就能夠了了。

本例中的選項看起來是這樣的:

const Administrator = 0;
const PaidMember = 1;
const Member = 2;

複製代碼

把值存儲在數據庫中

如今咱們有了一個帶有一些可能性的枚舉，而且能夠開始使用它。在遷移 user 表時, 能夠添加如下內容。

$table->tinyInteger('type')->unsigned()->default(UserType::Member);

複製代碼

由於 null 不是枚舉的選項，咱們須要爲它設置默認值。在這個例子中，有必要去假設默認狀況下的用戶將成爲標準成員。

確保文件的頂部包含此枚舉的 use 語句。

use App\Enums\UserType;

複製代碼

在操做中使用枚舉

因爲咱們如今的用戶模型具備類型的屬性，咱們能夠對它進行訪問，並和 enum 值進行比較。這就是枚舉真正的好處，也是我爲何如此喜歡他們。看一下下面的用法示例和可能替代的方法。

if ($user->type === UserType::PaidMember) {
    // 在這裏只是作一些付費會員的事情.
}

複製代碼

若是咱們不使用枚舉，可能會有相似如下的代碼:

if ($user->type === 1) { // 這個1表示什麼??
    // ...
}

if ($user->type === 'PaidMember') { // 這他媽咋麼又是字符串 😞
    // ...
}

複製代碼

使用枚舉的第一個例子是最容易讀懂而且也是最不容易出錯的例子。若是我偶然輸入了 UserType::Paidember (注意拼寫錯誤)，我會獲得一個很好的錯誤提示，告訴我代碼錯誤了(類中不存在這個常量值)，而不是像前兩個示例那樣默默的失敗。(只是判斷不符合條件，你還須要根據當前的條件語句去具體的查看相關代碼😞)

顯示枚舉

在應用的某些界面，咱們可能但願向用戶顯示他們所屬的用戶類型。若是隻是簡單的輸出從數據庫所獲取的整型值，顯然達不到咱們想要的結果。相反，可以使用每一個枚舉類所繼承基類的 getDescription 方法。

在 blade 模板上的操做以下:

<p>{{ \App\Enums\UserType::getDescription($user->type) }}</p>
複製代碼

輸出結果Administrator(管理員)，PaidMember(付費會員) 、Member(會員)中的一個。

有時候關鍵詞名稱是複合詞(就像 PaidMember)，咱們想要展現和鍵名不一樣的東西。咱們能夠像下面這樣覆蓋掉當前枚舉的描述。 在 app/Enums/UserType.php:

public static function getDescription(int $value): string
{
    switch ($value) {
        case self::PaidMember:
            return 'Paid member';
        break;
        default:
            return self::getKey($value);
    }
}

複製代碼

如今當咱們調用  getDescription 咱們將獲取到 Administrator, Paid member or Member.

驗證方式

經過用戶的輸入，對枚舉值進行修改時，最好能確保咱們僅僅接受有效的值。咱們可使用包中的驗證規則。

當以表格展現枚舉的時候，我常常把他們顯示爲 HTML select 元素。這樣雖仍然能夠被惡意修改，可是避免了將錯誤的值傳遞給服務器的狀況。

繼續咱們的用戶使用示例，讓咱們在用戶控制器中處理修改的值:

public function store(Request $request)
{
    $this->validate($request, [
        'type' => ['required', new EnumValue(UserType::class)],
    ]);

    // 保存用戶等等...
}

複製代碼

記住要同時包含枚舉的 use 語句和 EnumValue 的規則。

use App\Enums\UserType;
use BenSampo\Enum\Rules\EnumValue;

複製代碼

結束

固然這並非枚舉所能完成的所有範圍。可是它覆蓋了90%的用例。

值得一看的列表 枚舉類上的方法的完整列表 以查看您還能實現什麼。