Laravel中怎么使用枚舉？下面本篇文章給大家介紹一下在 Laravel 中使用枚舉的方法，希望對(duì)大家有所幫助！

Laravel 9 保姆級(jí)視頻教程，想學(xué)不會(huì)都難！進(jìn)入學(xué)習(xí)

我是enums的忠實(shí)粉絲最近，我在一家使用C#的公司工作，那里廣泛使用enum，我已經(jīng)習(xí)慣了在找不到它們的時(shí)候，能夠找到它們，并想念它們。

我將它們用于任何具有有限一組可能選項(xiàng)的事情，例如一周中的幾天、訂單的狀態(tài)，或者，如下面的示例中所示，用戶類型。

使用枚舉有幾個(gè)好處：

-減少因轉(zhuǎn)置或錯(cuò)誤輸入數(shù)字而導(dǎo)致的錯(cuò)誤。

-使將來改變價(jià)值觀變得容易。

-使代碼更易于閱讀，這意味著不太可能有錯(cuò)誤潛入其中。

-確保前向兼容性使用枚舉時(shí)，如果將來有人更改與成員名稱對(duì)應(yīng)的值，可以大大降低你的代碼失敗幾率。

PHP 本身并不支持枚舉，但是使用類中的常量相當(dāng)容易實(shí)現(xiàn)等價(jià)的效果。 此外，我還創(chuàng)建了一個(gè)名為 laravel-enum 的 Laravel 包。 它允許你訪問幫助函數(shù)，例如列出鍵和值,將描述附加到值上，以及驗(yàn)證期望枚舉值的請(qǐng)求。

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

安裝包

可以通過 composer 在終端中運(yùn)以下命令來安裝包:

$ composer require bensampo/laravel-enum

如果你使用的是低于5.5的 Laravel 版本，你需要將服務(wù)提供者添加到 config/app.php.

'BenSampoEnumEnumServiceProvider'

創(chuàng)建第一個(gè)枚舉

我們將為用戶類型創(chuàng)建一個(gè)枚舉在我們的示例應(yīng)用程序中，用戶可以屬于以下三種用戶類型之一：管理員、付費(fèi)成員、成員。

包中包含用于創(chuàng)建枚舉的生成器，因此可以運(yùn)行以下命令來創(chuàng)建名為UserType的枚舉該文件將在“app/Enums/UserType.php”中創(chuàng)建

php artisan make:enum UserType

你將在這個(gè)文件中看到一定數(shù)量的腳手架。在文件頂部附近，可能的選項(xiàng)列表被定義為常量。這些常量值存儲(chǔ)在數(shù)據(jù)庫(kù)中，因此我發(fā)現(xiàn)最好是使用整數(shù)，但是并沒有限制一定要使用整數(shù)，只要每一個(gè)值都是唯一就可以了了。

本例中的選項(xiàng)看起來是這樣的:

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

把值存儲(chǔ)在數(shù)據(jù)庫(kù)中

現(xiàn)在我們有了一個(gè)帶有一些可能性的枚舉，并且可以開始使用它。在遷移 user 表時(shí), 可以添加以下內(nèi)容。

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

因?yàn)?null 不是枚舉的選項(xiàng)，我們需要為它設(shè)置默認(rèn)值。在這個(gè)例子中，有必要去假設(shè)默認(rèn)情況下的用戶將成為標(biāo)準(zhǔn)成員。

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

use AppEnumsUserType;

在操作中使用枚舉

由于我們現(xiàn)在的用戶模型具有類型的屬性，我們可以對(duì)它進(jìn)行訪問，并和 enum 值進(jìn)行比較。這就是枚舉真正的好處，也是我為什么如此喜歡他們?？匆幌孪旅娴挠梅ㄊ纠涂赡芴娲姆椒?。

if ($user->type === UserType::PaidMember) {     // 在這里只是做一些付費(fèi)會(huì)員的事情. }

如果我們不使用枚舉，可能會(huì)有類似以下的代碼:

if ($user->type === 1) { // 這個(gè)1表示什么??     // ... }  if ($user->type === 'PaidMember') { // 這他媽咋么又是字符串 ?     // ... }

使用枚舉的第一個(gè)例子是最容易讀懂并且也是最不容易出錯(cuò)的例子。如果我偶然輸入了 UserType::Paidember (注意拼寫錯(cuò)誤)，我會(huì)得到一個(gè)很好的錯(cuò)誤提示，告訴我代碼錯(cuò)誤了(類中不存在這個(gè)常量值)，而不是像前兩個(gè)示例那樣默默的失敗。(只是判斷不符合條件，你還需要根據(jù)當(dāng)前的條件語句去具體的查看相關(guān)代碼?)

顯示枚舉

在應(yīng)用的某些界面，我們可能希望向用戶顯示他們所屬的用戶類型。如果只是簡(jiǎn)單的輸出從數(shù)據(jù)庫(kù)所獲取的整型值，顯然達(dá)不到我們想要的結(jié)果。相反，可使用每個(gè)枚舉類所繼承基類的 getDescription 方法。

在 blade 模板上的操作如下:

<p>{{ AppEnumsUserType::getDescription($user->type) }}</p>

輸出結(jié)果Administrator(管理員)，PaidMember(付費(fèi)會(huì)員) 、Member(會(huì)員)中的一個(gè)。

有時(shí)候關(guān)鍵詞名稱是復(fù)合詞(就像 PaidMember)，我們想要展示和鍵名不同的東西。我們可以像下面這樣覆蓋掉當(dāng)前枚舉的描述。 在 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);     } }

現(xiàn)在當(dāng)我們調(diào)用 getDescription 我們將獲取到 Administrator, Paid member or Member.

驗(yàn)證方式

通過用戶的輸入，對(duì)枚舉值進(jìn)行修改時(shí)，最好能確保我們僅僅接受有效的值。我們可以使用包中的驗(yàn)證規(guī)則。

當(dāng)以表格展示枚舉的時(shí)候，我經(jīng)常把他們顯示為 HTML select 元素。這樣雖仍然可以被惡意修改，但是避免了將錯(cuò)誤的值傳遞給服務(wù)器的情況。

繼續(xù)我們的用戶使用示例，讓我們?cè)谟脩艨刂破髦刑幚硇薷牡闹?

public function store(Request $request) {     $this->validate($request, [         'type' => ['required', new EnumValue(UserType::class)],     ]);      // 保存用戶等等... }

記住要同時(shí)包含枚舉的 use 語句和 EnumValue 的規(guī)則。

use AppEnumsUserType; use BenSampoEnumRulesEnumValue;

結(jié)束

當(dāng)然這并不是枚舉所能完成的全部范圍。但是它覆蓋了90%的用例。

值得一看的列表 枚舉類上的方法的完整列表 以查看您還能實(shí)現(xiàn)什么。

【