驗證
簡介
Laravel 提供多種不同的方法來驗證應用程式傳入的資料。最常見的做法是使用所有傳入 HTTP 請求中都具備的 validate 方法。不過,我們也會討論其他的驗證方法。
Laravel 包含各種方便的驗證規則,您可以將其套用於資料上,甚至提供驗證數值在指定的資料庫資料表中是否唯一的功能。我們將詳細介紹每一種驗證規則,讓您熟悉 Laravel 的所有驗證功能。
驗證快速上手
要學習 Laravel 強大的驗證功能,讓我們來看一個驗證表單並將錯誤訊息顯示給使用者的完整範例。透過閱讀這份高階總覽,您將能對如何使用 Laravel 驗證傳入的請求資料有一個良好的通盤瞭解:
定義路由
首先,假設我們在 routes/web.php 檔案中定義了以下路由:
use App\Http\Controllers\PostController;
Route::get('/post/create', [PostController::class, 'create']);
Route::post('/post', [PostController::class, 'store']);GET 路由會顯示一個供使用者建立新部落格文章的表單,而 POST 路由則會將新的部落格文章儲存到資料庫中。
建立控制器
接下來,讓我們看一個簡單的控制器,它負責處理這些路由的傳入請求。我們暫時將 store 方法留空:
<?php
namespace App\Http\Controllers;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\View\View;
class PostController extends Controller
{
/**
* Show the form to create a new blog post.
*/
public function create(): View
{
return view('post.create');
}
/**
* Store a new blog post.
*/
public function store(Request $request): RedirectResponse
{
// Validate and store the blog post...
$post = /** ... */
return to_route('post.show', ['post' => $post->id]);
}
}撰寫驗證邏輯
現在我們準備在 store 方法中填寫驗證新部落格文章的邏輯。為此,我們將使用 Illuminate\Http\Request 物件提供的 validate 方法。如果驗證規則通過,您的程式碼將繼續正常執行;但如果驗證失敗,則會拋出 Illuminate\Validation\ValidationException 例外,並自動將適當的錯誤回應傳回給使用者。
如果在傳統的 HTTP 請求期間驗證失敗,則會產生一個指向前一個 URL 的重導向回應。如果傳入的請求是 XHR 請求,則會回傳一個包含驗證錯誤訊息的 JSON 回應。
為了更深入瞭解 validate 方法,讓我們回到 store 方法中:
/**
* Store a new blog post.
*/
public function store(Request $request): RedirectResponse
{
$validated = $request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
// The blog post is valid...
return redirect('/posts');
}如您所見,驗證規則被傳入 validate 方法中。別擔心——所有可用的驗證規則都已記錄在文件中。同樣地,如果驗證失敗,系統會自動產生適當的回應。如果驗證通過,我們的控制器將繼續正常執行。
或者,驗證規則可以指定為規則陣列,而不是單個以 | 分隔的字串:
$validatedData = $request->validate([
'title' => ['required', 'unique:posts', 'max:255'],
'body' => ['required'],
]);此外,您可以使用 validateWithBag 方法來驗證請求,並將任何錯誤訊息儲存在一個具名錯誤袋中:
$validatedData = $request->validateWithBag('post', [
'title' => ['required', 'unique:posts', 'max:255'],
'body' => ['required'],
]);遇到第一個驗證失敗時停止
有時您可能希望在某個屬性遇到第一個驗證失敗後,就停止對該屬性執行後續的驗證規則。為此,請將 bail 規則分配給該屬性:
$request->validate([
'title' => 'bail|required|unique:posts|max:255',
'body' => 'required',
]);在此範例中,如果 title 屬性上的 unique 規則失敗,則不會檢查 max 規則。規則將按照它們被分配的順序進行驗證。
關於巢狀屬性的注意事項
如果傳入的 HTTP 請求包含「巢狀」欄位資料,您可以使用「點」語法在驗證規則中指定這些欄位:
$request->validate([
'title' => 'required|unique:posts|max:255',
'author.name' => 'required',
'author.description' => 'required',
]);另一方面,如果您的欄位名稱本身包含一個實際的小數點,您可以透過使用反斜線轉義小數點,來明確防止其被解釋為「點」語法:
$request->validate([
'title' => 'required|unique:posts|max:255',
'v1\.0' => 'required',
]);顯示驗證錯誤
那麼,如果傳入的請求欄位沒有通過指定的驗證規則會發生什麼事呢?如前所述,Laravel 會自動將使用者重新導向回先前的路徑。此外,所有的驗證錯誤以及請求輸入都會自動閃存 (Flash) 至 Session。
web 中介層群組提供的 Illuminate\View\Middleware\ShareErrorsFromSession 中介層會將 $errors 變數與應用程式的所有視圖共享。當套用此中介層時,視圖中始終可以使用 $errors 變數,這讓您可以放心地假設 $errors 變數已被定義且可以安全使用。$errors 變數將會是 Illuminate\Support\MessageBag 的執行個體。有關如何使用此物件的更多資訊,請參閱其文件。
因此,在我們的範例中,當驗證失敗時,使用者將被重新導向到控制器的 create 方法,讓我們能在視圖中顯示錯誤訊息:
<!-- /resources/views/post/create.blade.php -->
<h1>Create Post</h1>
@if ($errors->any())
<div class="alert alert-danger">
<ul>
@foreach ($errors->all() as $error)
<li>{{ $error }}</li>
@endforeach
</ul>
</div>
@endif
<!-- Create Post Form -->自定義錯誤訊息
Laravel 每個內建的驗證規則都有一個錯誤訊息,位於應用程式的 lang/en/validation.php 檔案中。如果您的應用程式沒有 lang 目錄,您可以使用 lang:publish Artisan 指令要求 Laravel 建立它。
在 lang/en/validation.php 檔案中,您會發現每個驗證規則都有一個翻譯項目。您可以根據應用程式的需求自由更改或修改這些訊息。
此外,您可以將此檔案複製到另一個語言目錄,為您的應用程式語言翻譯訊息。要了解更多關於 Laravel 在地化的資訊,請參閱完整的在地化文件。
⚠️ 警告
預設情況下,Laravel 應用程式骨架不包含 lang 目錄。如果您想自定義 Laravel 的語言檔案,可以透過 lang:publish Artisan 指令發布它們。
XHR 請求與驗證
在此範例中,我們使用了傳統表單將資料發送到應用程式。然而,許多應用程式會從 JavaScript 驅動的前端接收 XHR 請求。在 XHR 請求期間使用 validate 方法時,Laravel 不會產生重導向回應。相反地,Laravel 會產生一個包含所有驗證錯誤的 JSON 回應。此 JSON 回應將隨附 422 HTTP 狀態碼傳送。
The @error Directive
您可以使用 @error Blade 指令快速判斷給定的屬性是否存在驗證錯誤訊息。在 @error 指令內,您可以印出 $message 變數來顯示錯誤訊息:
<!-- /resources/views/post/create.blade.php -->
<label for="title">Post Title</label>
<input
id="title"
type="text"
name="title"
class="@error('title') is-invalid @enderror"
/>
@error('title')
<div class="alert alert-danger">{{ $message }}</div>
@enderror如果您正在使用具名錯誤袋,可以將錯誤袋的名稱作為第二個參數傳遞給 @error 指令:
<input ... class="@error('title', 'post') is-invalid @enderror">重新填充表單
當 Laravel 因為驗證錯誤而產生重導向回應時,框架會自動將請求的所有輸入內容閃存 (Flash) 到 Session。這樣做是為了讓您可以在下一個請求中方便地存取輸入內容,並重新填充使用者嘗試提交的表單。
要從上一個請求中檢索閃存的輸入,請在 Illuminate\Http\Request 執行個體上呼叫 old 方法。old 方法會從 Session 中取出先前閃存的輸入資料:
$title = $request->old('title');Laravel 還提供了一個全域的 old 輔助函式。如果您在 Blade 範本中顯示舊的輸入,使用 old 輔助函式來重新填充表單會更方便。如果給定的欄位不存在舊輸入,則會回傳 null:
<input type="text" name="title" value="{{ old('title') }}">關於可選欄位的注意事項
預設情況下,Laravel 在應用程式的全域中介層堆疊中包含了 TrimStrings 和 ConvertEmptyStringsToNull 中介層。因此,如果您不希望驗證器將 null 值視為無效,通常需要將「可選」的請求欄位標記為 nullable。例如:
$request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
'publish_at' => 'nullable|date',
]);在此範例中,我們指定 publish_at 欄位可以是 null 或有效的日期格式。如果未在規則定義中加入 nullable 修飾詞,驗證器會將 null 視為無效的日期。
驗證錯誤回應格式
當您的應用程式拋出 Illuminate\Validation\ValidationException 異常,且傳入的 HTTP 請求預期獲得 JSON 回應時,Laravel 會自動為您格式化錯誤訊息並回傳 422 Unprocessable Entity HTTP 回應。
在下方,您可以查看驗證錯誤的 JSON 回應格式範例。請注意,巢狀錯誤鍵會被扁平化為「點 (Dot)」號標法格式:
{
"message": "The team name must be a string. (and 4 more errors)",
"errors": {
"team_name": [
"The team name must be a string.",
"The team name must be at least 1 characters."
],
"authorization.role": [
"The selected authorization.role is invalid."
],
"users.0.email": [
"The users.0.email field is required."
],
"users.2.email": [
"The users.2.email must be a valid email address."
]
}
}表單請求驗證
建立表單請求
對於更複雜的驗證情境,您可能希望建立一個「表單請求 (Form Request)」。表單請求是自定義的請求類別,其中封裝了各自的驗證與授權邏輯。若要建立表單請求類別,您可以使用 make:request Artisan CLI 命令:
php artisan make:request StorePostRequest產生的表單請求類別將放置在 app/Http/Requests 目錄中。如果該目錄不存在,在您執行 make:request 命令時將會自動建立。Laravel 產生的每個表單請求都有兩個方法:authorize 和 rules。
如您所料,authorize 方法負責判斷當前通過身份驗證的使用者是否可以執行該請求代表的操作,而 rules 方法則返回應應用於請求資料的驗證規則:
/**
* Get the validation rules that apply to the request.
*
* @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
*/
public function rules(): array
{
return [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
];
}📌 備註
您可以在 rules 方法的參數中使用型別提示來注入所需的任何依賴項。它們將自動透過 Laravel 服務容器 進行解析。
那麼,驗證規則是如何被評估的呢?您只需要在控制器方法中對該請求進行型別提示即可。傳入的表單請求會在控制器方法被呼叫之前進行驗證,這意味著您不需要在控制器中堆滿任何驗證邏輯:
/**
* Store a new blog post.
*/
public function store(StorePostRequest $request): RedirectResponse
{
// The incoming request is valid...
// Retrieve the validated input data...
$validated = $request->validated();
// Retrieve a portion of the validated input data...
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
// Store the blog post...
return redirect('/posts');
}如果驗證失敗,將會產生一個重導向回應,將使用者送回先前的位置。錯誤訊息也會被快閃 (Flash) 到 Session 中,以便顯示。如果請求是 XHR 請求,則會向使用者回傳一個帶有 422 狀態碼的 HTTP 回應,其中包含 驗證錯誤的 JSON 表示形式。
📌 備註
需要為您的 Inertia 驅動的 Laravel 前端加入即時表單請求驗證嗎?請參考 Laravel Precognition。
執行額外驗證
有時您需要在初始驗證完成後執行額外的驗證。您可以使用表單請求的 after 方法來達成此目的。
after 方法應回傳一個由可呼叫物件 (Callables) 或閉包組成的陣列,這些內容將在驗證完成後被呼叫。傳入的可呼叫物件將接收一個 Illuminate\Validation\Validator 實例,允許您在必要時增加額外的錯誤訊息:
use Illuminate\Validation\Validator;
/**
* Get the "after" validation callables for the request.
*/
public function after(): array
{
return [
function (Validator $validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add(
'field',
'Something is wrong with this field!'
);
}
}
];
}如前所述,after 方法回傳的陣列也可以包含可呼叫類別。這些類別的 __invoke 方法將接收一個 Illuminate\Validation\Validator 實例:
use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
use Illuminate\Validation\Validator;
/**
* Get the "after" validation callables for the request.
*/
public function after(): array
{
return [
new ValidateUserStatus,
new ValidateShippingTime,
function (Validator $validator) {
//
}
];
}在第一個驗證失敗時停止
藉由在您的請求類別中加入 stopOnFirstFailure 屬性,您可以通知驗證器一旦發生單個驗證失敗,就應停止驗證所有屬性:
/**
* Indicates if the validator should stop on the first rule failure.
*
* @var bool
*/
protected $stopOnFirstFailure = true;自定義重導向位置
當表單請求驗證失敗時,會產生一個重導向回應將使用者送回先前的位置。但是,您可以自由地自定義此行為。若要執行此操作,請在您的表單請求中定義一個 $redirect 屬性:
/**
* The URI that users should be redirected to if validation fails.
*
* @var string
*/
protected $redirect = '/dashboard';或者,如果您想將使用者重導向至具名路由,則可以定義 $redirectRoute 屬性:
/**
* The route that users should be redirected to if validation fails.
*
* @var string
*/
protected $redirectRoute = 'dashboard';授權表單請求
表單請求類別還包含一個 authorize 方法。在此方法中,您可以判斷經過身份驗證的使用者是否真的有權限更新給定的資源。例如,您可以判斷使用者是否真的擁有他們嘗試更新的部落格留言。您很可能會在此方法中與您的 授權 Gates 與 Policies 進行互動:
use App\Models\Comment;
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
$comment = Comment::find($this->route('comment'));
return $comment && $this->user()->can('update', $comment);
}由於所有表單請求都繼承自 Laravel 基礎請求類別,我們可以使用 user 方法來存取當前通過身份驗證的使用者。此外,請注意上方範例中對 route 方法的呼叫。此方法讓您可以存取被呼叫路由中定義的 URI 參數,例如下方範例中的 {comment} 參數:
Route::post('/comment/{comment}');因此,如果您的應用程式正在利用 路由模型綁定,透過將解析後的模型作為請求的屬性來存取,您的程式碼可以變得更加簡潔:
return $this->user()->can('update', $this->comment);如果 authorize 方法回傳 false,則會自動回傳一個帶有 403 狀態碼的 HTTP 回應,且您的控制器方法將不會執行。
如果您打算在應用程式的其他部分處理請求的授權邏輯,您可以完全移除 authorize 方法,或簡單地回傳 true:
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
return true;
}📌 備註
您可以在 authorize 方法的參數中使用型別提示來注入所需的任何依賴項。它們將自動透過 Laravel 服務容器 進行解析。
自定義錯誤訊息
您可以透過覆寫 messages 方法來自定義表單請求所使用的錯誤訊息。此方法應回傳一個包含屬性/規則對及其對應錯誤訊息的陣列:
/**
* Get the error messages for the defined validation rules.
*
* @return array<string, string>
*/
public function messages(): array
{
return [
'title.required' => 'A title is required',
'body.required' => 'A message is required',
];
}自定義驗證屬性
許多 Laravel 內建的驗證規則錯誤訊息都包含一個 :attribute 佔位符。如果您希望將驗證訊息中的 :attribute 佔位符替換為自定義的屬性名稱,您可以透過覆寫 attributes 方法來指定這些自定義名稱。此方法應回傳一個包含屬性/名稱對的陣列:
/**
* Get custom attributes for validator errors.
*
* @return array<string, string>
*/
public function attributes(): array
{
return [
'email' => 'email address',
];
}準備驗證輸入
如果您在套用驗證規則之前需要準備或淨化來自請求的任何資料,您可以使用 prepareForValidation 方法:
use Illuminate\Support\Str;
/**
* Prepare the data for validation.
*/
protected function prepareForValidation(): void
{
$this->merge([
'slug' => Str::slug($this->slug),
]);
}同樣地,如果您在驗證完成後需要正規化任何請求資料,您可以使用 passedValidation 方法:
/**
* Handle a passed validation attempt.
*/
protected function passedValidation(): void
{
$this->replace(['name' => 'Taylor']);
}手動建立驗證器
如果您不想在請求上使用 validate 方法,您可以使用 Validator Facade 手動建立一個驗證器實例。Facade 上的 make 方法會產生一個新的驗證器實例:
<?php
namespace App\Http\Controllers;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
class PostController extends Controller
{
/**
* Store a new blog post.
*/
public function store(Request $request): RedirectResponse
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
if ($validator->fails()) {
return redirect('/post/create')
->withErrors($validator)
->withInput();
}
// Retrieve the validated input...
$validated = $validator->validated();
// Retrieve a portion of the validated input...
$validated = $validator->safe()->only(['name', 'email']);
$validated = $validator->safe()->except(['name', 'email']);
// Store the blog post...
return redirect('/posts');
}
}傳遞給 make 方法的第一個參數是待驗證的資料。第二個參數是應套用於該資料的驗證規則陣列。
在判斷請求驗證是否失敗後,您可以使用 withErrors 方法將錯誤訊息快閃 (Flash) 到 Session 中。使用此方法時,$errors 變數會在重導向後自動與您的視圖共享,讓您能輕鬆地將它們顯示給使用者。withErrors 方法接受驗證器、MessageBag 或 PHP array。
在第一個驗證失敗時停止
stopOnFirstFailure 方法會通知驗證器,一旦發生單一驗證失敗,就應停止驗證所有屬性:
if ($validator->stopOnFirstFailure()->fails()) {
// ...
}自動重導向
如果您想手動建立驗證器實例,但仍想利用 HTTP 請求的 validate 方法所提供的自動重導向功能,您可以對現有的驗證器實例呼叫 validate 方法。如果驗證失敗,使用者將自動被重導向,或者在 XHR 請求的情況下,將會回傳一個 JSON 回應:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validate();如果驗證失敗,您可以使用 validateWithBag 方法將錯誤訊息儲存在具名錯誤袋中:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validateWithBag('post');具名錯誤袋
如果您在單一頁面上有多個表單,您可能希望為包含驗證錯誤的 MessageBag 命名,以便擷取特定表單的錯誤訊息。若要達成此目的,請將名稱作為 withErrors 的第二個參數傳遞:
return redirect('/register')->withErrors($validator, 'login');接著,您可以從 $errors 變數存取該具名 MessageBag 實例:
{{ $errors->login->first('email') }}自定義錯誤訊息
如有需要,您可以提供驗證器實例應使用的自定義錯誤訊息,而非 Laravel 提供的預設錯誤訊息。有幾種方式可以指定自定義訊息。首先,您可以將自定義訊息作為 Validator::make 方法的第三個參數傳遞:
$validator = Validator::make($input, $rules, $messages = [
'required' => 'The :attribute field is required.',
]);在此範例中,:attribute 佔位符將被替換為待驗證欄位的實際名稱。您也可以在驗證訊息中使用其他佔位符。例如:
$messages = [
'same' => 'The :attribute and :other must match.',
'size' => 'The :attribute must be exactly :size.',
'between' => 'The :attribute value :input is not between :min - :max.',
'in' => 'The :attribute must be one of the following types: :values',
];為特定屬性指定自定義訊息
有時您可能只想為特定屬性指定自定義錯誤訊息。您可以使用「點 (Dot)」標記法來做到這一點。先指定屬性名稱,接著是規則名稱:
$messages = [
'email.required' => 'We need to know your email address!',
];指定自定義屬性數值
許多 Laravel 內建的錯誤訊息都包含 :attribute 佔位符,它會被替換為待驗證欄位或屬性的名稱。若要為特定欄位自定義替換這些佔位符的數值,您可以將自定義屬性陣列作為 Validator::make 方法的第四個參數傳遞:
$validator = Validator::make($input, $rules, $messages, [
'email' => 'email address',
]);執行額外驗證
有時您需要在初始驗證完成後執行額外驗證。您可以使用驗證器的 after 方法來達成此目的。after 方法接受一個閉包或可呼叫項 (Callables) 陣列,這些項目將在驗證完成後被調用。給定的可呼叫項將接收一個 Illuminate\Validation\Validator 實例,讓您在必要時可以加入額外的錯誤訊息:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make(/* ... */);
$validator->after(function ($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add(
'field', 'Something is wrong with this field!'
);
}
});
if ($validator->fails()) {
// ...
}如前所述,after 方法也接受一個可呼叫項陣列,如果您的「驗證後」邏輯封裝在可調用類別中,這會特別方便,這些類別將透過其 __invoke 方法接收 Illuminate\Validation\Validator 實例:
use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
$validator->after([
new ValidateUserStatus,
new ValidateShippingTime,
function ($validator) {
// ...
},
]);使用驗證後的輸入資料
在使用表單請求或手動建立的驗證器實例驗證傳入的請求資料後,您可能希望取得實際經過驗證的傳入請求資料。這可以透過幾種方式實現。首先,您可以呼叫表單請求或驗證器實例上的 validated 方法。此方法會回傳一個包含已驗證資料的陣列:
$validated = $request->validated();
$validated = $validator->validated();或者,您可以呼叫表單請求或驗證器實例上的 safe 方法。此方法會回傳一個 Illuminate\Support\ValidatedInput 的實例。該物件提供了 only、except 與 all 方法,用於取得已驗證資料的子集或整個已驗證資料陣列:
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
$validated = $request->safe()->all();此外,Illuminate\Support\ValidatedInput 實例可以被迭代並像陣列一樣存取:
// Validated data may be iterated...
foreach ($request->safe() as $key => $value) {
// ...
}
// Validated data may be accessed as an array...
$validated = $request->safe();
$email = $validated['email'];如果您想在已驗證資料中新增額外欄位,可以呼叫 merge 方法:
$validated = $request->safe()->merge(['name' => 'Taylor Otwell']);如果您想以集合實例的形式取得已驗證資料,可以呼叫 collect 方法:
$collection = $request->safe()->collect();使用錯誤訊息
在呼叫 Validator 實例上的 errors 方法後,您將收到一個 Illuminate\Support\MessageBag 實例,該實例擁有多種方便的方法來處理錯誤訊息。自動提供給所有視圖的 $errors 變數也是 MessageBag 類別的一個實例。
取得欄位的第一條錯誤訊息
若要取得給定欄位的第一條錯誤訊息,請使用 first 方法:
$errors = $validator->errors();
echo $errors->first('email');取得欄位的所有錯誤訊息
如果您需要取得給定欄位所有訊息的陣列,請使用 get 方法:
foreach ($errors->get('email') as $message) {
// ...
}如果您正在驗證陣列形式的表單欄位,可以使用 * 字元取得每個陣列元素的所有訊息:
foreach ($errors->get('attachments.*') as $message) {
// ...
}取得所有欄位的所有錯誤訊息
若要取得所有欄位的所有訊息陣列,請使用 all 方法:
foreach ($errors->all() as $message) {
// ...
}判斷欄位是否存在錯誤訊息
has 方法可用於判斷給定欄位是否存在任何錯誤訊息:
if ($errors->has('email')) {
// ...
}在語言檔中指定自定義訊息
Laravel 的內建驗證規則各有一個錯誤訊息,位於應用程式的 lang/en/validation.php 檔案中。如果您的應用程式沒有 lang 目錄,您可以使用 lang:publish Artisan 指令要求 Laravel 建立它。
在 lang/en/validation.php 檔案中,您會發現每個驗證規則都有一個翻譯項目。您可以根據應用程式的需求隨意更改或修改這些訊息。
此外,您可以將此檔案複製到另一個語言目錄,以為應用程式的語言翻譯訊息。要了解更多關於 Laravel 本地化的資訊,請查看完整的本地化文件。
⚠️ 警告
根據預設,Laravel 應用程式骨架不包含 lang 目錄。如果您想自定義 Laravel 的語言檔,可以透過 lang:publish Artisan 指令發佈它們。
針對特定屬性的自定義訊息
您可以在應用程式的驗證語言檔中,針對指定的屬性與規則組合自定義錯誤訊息。為此,請將您的訊息自定義內容新增到應用程式 lang/xx/validation.php 語言檔的 custom 陣列中:
'custom' => [
'email' => [
'required' => 'We need to know your email address!',
'max' => 'Your email address is too long!'
],
],在語言檔中指定屬性
許多 Laravel 內建的錯誤訊息都包含一個 :attribute 佔位符,該佔位符會被替換為正在驗證的欄位或屬性名稱。如果您希望驗證訊息中的 :attribute 部分被替換為自定義值,可以在 lang/xx/validation.php 語言檔的 attributes 陣列中指定自定義屬性名稱:
'attributes' => [
'email' => 'email address',
],⚠️ 警告
根據預設,Laravel 應用程式骨架不包含 lang 目錄。如果您想自定義 Laravel 的語言檔,可以透過 lang:publish Artisan 指令發佈它們。
在語言檔中指定數值
某些 Laravel 內建的驗證規則錯誤訊息包含一個 :value 佔位符,該佔位符會被替換為請求屬性的當前值。然而,有時您可能需要將驗證訊息中的 :value 部分替換為該值的自定義表示方式。例如,考慮以下規則,該規則指定如果 payment_type 的值為 cc,則需要信用卡號碼:
Validator::make($request->all(), [
'credit_card_number' => 'required_if:payment_type,cc'
]);如果此驗證規則失敗,它將產生以下錯誤訊息:
The credit card number field is required when payment type is cc.您可以透過在 lang/xx/validation.php 語言檔中定義 values 陣列,來指定更友善的數值表示方式,而不是顯示 cc 作為付款類型的值:
'values' => [
'payment_type' => [
'cc' => 'credit card'
],
],⚠️ 警告
根據預設,Laravel 應用程式骨架不包含 lang 目錄。如果您想自定義 Laravel 的語言檔,可以透過 lang:publish Artisan 指令發佈它們。
定義此數值後,驗證規則將產生以下錯誤訊息:
The credit card number field is required when payment type is credit card.可用的驗證規則
以下是所有可用驗證規則及其功能的列表:
布林值 (Booleans)
字串 (Strings)
Active URLAlphaAlpha DashAlpha NumericAsciiConfirmedCurrent PasswordDifferentDoesnt Start WithDoesnt End WithEmailEnds WithEnumHex ColorInIP AddressJSONLowercaseMAC AddressMaxMinNot InRegular ExpressionNot Regular ExpressionSameSizeStarts WithStringUppercaseURLULIDUUID
數字 (Numbers)
BetweenDecimalDifferentDigitsDigits BetweenGreater ThanGreater Than Or EqualIntegerLess ThanLess Than Or EqualMaxMax DigitsMinMin DigitsMultiple OfNumericSameSize
陣列 (Arrays)
日期 (Dates)
檔案 (Files)
資料庫 (Database)
公用程式 (Utilities)
Any OfBailExcludeExclude IfExclude UnlessExclude WithExclude WithoutFilledMissingMissing IfMissing UnlessMissing WithMissing With AllNullablePresentPresent IfPresent UnlessPresent WithPresent With AllProhibitedProhibited IfProhibited If AcceptedProhibited If DeclinedProhibited UnlessProhibitsRequiredRequired IfRequired If AcceptedRequired If DeclinedRequired UnlessRequired WithRequired With AllRequired WithoutRequired Without AllRequired Array KeysSometimes
accepted
待驗證欄位必須是 "yes"、"on"、1、"1"、true 或 "true"。這對於驗證「服務條款」的接受或類似欄位非常有用。
accepted_if:anotherfield,value,...
若另一個待驗證欄位等於指定的值,則待驗證欄位必須是 "yes"、"on"、1、"1"、true 或 "true"。這對於驗證「服務條款」的接受或類似欄位非常有用。
active_url
待驗證欄位必須根據 PHP 函數 dns_get_record 擁有有效的 A 或 AAAA 紀錄。在傳遞給 dns_get_record 之前,會先使用 PHP 函數 parse_url 提取所提供 URL 的主機名稱。
after:date
待驗證欄位必須是一個在給定日期之後的值。這些日期將被傳遞至 PHP 的 strtotime 函數,以便轉換為有效的 DateTime 執行個體:
'start_date' => 'required|date|after:tomorrow'您可以指定另一個欄位來與日期進行比較,而不是傳遞要由 strtotime 評估的日期字串:
'finish_date' => 'required|date|after:start_date'為了方便起見,可以使用流暢的 date 規則建構器來建立基於日期的規則:
use Illuminate\Validation\Rule;
'start_date' => [
'required',
Rule::date()->after(today()->addDays(7)),
],afterToday 和 todayOrAfter 方法可用於流暢地表達日期,且必須分別在今天之後,或今天或今天之後:
'start_date' => [
'required',
Rule::date()->afterToday(),
],after_or_equal:date
待驗證欄位必須是一個在給定日期之後或等於該日期的值。如需更多資訊,請參閱 after 規則。
為了方便起見,可以使用流暢的 date 規則建構器來建立基於日期的規則:
use Illuminate\Validation\Rule;
'start_date' => [
'required',
Rule::date()->afterOrEqual(today()->addDays(7)),
],anyOf
Rule::anyOf 驗證規則允許您指定待驗證欄位必須滿足任何指定的驗證規則集。例如,以下規則將驗證 username 欄位必須是電子郵件地址,或者是長度至少為 6 個字元的字母數字字串(包含連字號):
use Illuminate\Validation\Rule;
'username' => [
'required',
Rule::anyOf([
['string', 'email'],
['string', 'alpha_dash', 'min:6'],
]),
],alpha
待驗證欄位必須完全由包含在 \p{L} 和 \p{M} 中的 Unicode 字母字元組成。
若要將此驗證規則限制為 ASCII 範圍內的字元(a-z 和 A-Z),您可以為該驗證規則提供 ascii 選項:
'username' => 'alpha:ascii',alpha_dash
待驗證欄位必須完全由 \p{L}、\p{M}、\p{N} 中包含的 Unicode 字母數字字元,以及 ASCII 連字號 (-) 和 ASCII 底線 (_) 組成。
若要將此驗證規則限制在 ASCII 範圍內的字元(a-z、A-Z 和 0-9),您可以為該驗證規則提供 ascii 選項:
'username' => 'alpha_dash:ascii',alpha_num
待驗證欄位必須完全由 \p{L}、\p{M} 和 \p{N} 中包含的 Unicode 字母數字字元組成。
若要將此驗證規則限制在 ASCII 範圍內的字元(a-z、A-Z 和 0-9),您可以為該驗證規則提供 ascii 選項:
'username' => 'alpha_num:ascii',array
待驗證欄位必須是一個 PHP array。
當為 array 規則提供額外的值時,輸入陣列中的每個鍵 (Key) 必須存在於提供給規則的值清單中。在以下範例中,輸入陣列中的 admin 鍵是無效的,因為它不包含在提供給 array 規則的值清單中:
use Illuminate\Support\Facades\Validator;
$input = [
'user' => [
'name' => 'Taylor Otwell',
'username' => 'taylorotwell',
'admin' => true,
],
];
Validator::make($input, [
'user' => 'array:name,username',
]);一般來說,您應該始終指定允許存在於陣列中的陣列鍵。
ascii
待驗證欄位必須完全由 7 位元 ASCII 字元組成。
bail
在第一個驗證失敗後,停止對該欄位執行後續的驗證規則。
雖然 bail 規則只會在遇到驗證失敗時停止驗證特定欄位,但 stopOnFirstFailure 方法會通知驗證器,一旦發生單一驗證失敗,就應該停止驗證所有屬性:
if ($validator->stopOnFirstFailure()->fails()) {
// ...
}before:date
待驗證欄位必須是早於給定日期的值。日期將被傳遞給 PHP 的 strtotime 函數,以便轉換為有效的 DateTime 執行個體。此外,與 after 規則類似,可以提供另一個待驗證欄位的名稱作為 date 的值。
為了方便起見,可以使用流暢的 date 規則建構器來建立基於日期的規則:
use Illuminate\Validation\Rule;
'start_date' => [
'required',
Rule::date()->before(today()->subDays(7)),
],beforeToday 與 todayOrBefore 方法可用於流暢地表達日期,且必須分別早於今天,或是今天或更早:
'start_date' => [
'required',
Rule::date()->beforeToday(),
],before_or_equal:date
待驗證欄位必須是早於或等於給定日期的值。日期將被傳遞給 PHP 的 strtotime 函數,以便轉換為有效的 DateTime 執行個體。此外,與 after 規則類似,可以提供另一個待驗證欄位的名稱作為 date 的值。
為了方便起見,可以使用流暢的 date 規則建構器來建立基於日期的規則:
use Illuminate\Validation\Rule;
'start_date' => [
'required',
Rule::date()->beforeOrEqual(today()->subDays(7)),
],between:min,max
待驗證欄位的大小必須介於給定的 min 與 max 之間(包含)。字串、數值、陣列和檔案的評估方式與 size 規則相同。
boolean
待驗證欄位必須能夠被轉型為布林值。接受的輸入為 true、false、1、0、"1" 和 "0"。
您可以使用 strict 參數,讓欄位僅在值為 true 或 false 時才被視為有效:
'foo' => 'boolean:strict'confirmed
待驗證欄位必須具有一個比對欄位 {field}_confirmation。例如,如果待驗證欄位是 password,則輸入資料中必須存在一個相符的 password_confirmation 欄位。
您也可以傳遞自定義的比對欄位名稱。例如,confirmed:repeat_username 將會預期 repeat_username 欄位與待驗證欄位相符。
contains:foo,bar,...
待驗證欄位必須是一個包含所有給定參數值的陣列。由於此規則通常需要您 implode 陣列,因此可以使用 Rule::contains 方法來流暢地建構規則:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'roles' => [
'required',
'array',
Rule::contains(['admin', 'editor']),
],
]);doesnt_contain:foo,bar,...
待驗證欄位必須是一個不包含任何給定參數值的陣列。由於此規則通常需要您 implode 陣列,因此可以使用 Rule::doesntContain 方法來流暢地建構規則:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'roles' => [
'required',
'array',
Rule::doesntContain(['admin', 'editor']),
],
]);current_password
待驗證欄位必須與目前已驗證使用者的密碼相符。您可以使用規則的第一個參數來指定 authentication guard:
'password' => 'current_password:api'date
待驗證欄位必須是根據 PHP strtotime 函數所判定的一個有效的、非相對的日期。
date_equals:date
待驗證欄位必須等於給定日期。日期將被傳遞給 PHP 的 strtotime 函數,以便轉換為有效的 DateTime 執行個體。
date_format:format,...
待驗證欄位必須符合給定的 formats 之一。驗證欄位時,您應該使用 date 或 date_format 其中之一,而非兩者。此驗證規則支援 PHP DateTime 類別支援的所有格式。
為了方便起見,可以使用流暢的 date 規則建構器來建立基於日期的規則:
use Illuminate\Validation\Rule;
'start_date' => [
'required',
Rule::date()->format('Y-m-d'),
],decimal:min,max
待驗證欄位必須是數值,且必須包含指定的小數位數:
// Must have exactly two decimal places (9.99)...
'price' => 'decimal:2'
// Must have between 2 and 4 decimal places...
'price' => 'decimal:2,4'declined
待驗證欄位必須是 "no"、"off"、0、"0"、false 或 "false"。
declined_if:anotherfield,value,...
如果另一個待驗證欄位等於指定的值,則待驗證欄位必須是 "no"、"off"、0、"0"、false 或 "false"。
different:field
待驗證欄位的值必須與 field 的值不同。
digits:value
待驗證的整數長度必須正好為 value。
digits_between:min,max
待驗證的整數長度必須介於指定的 min 與 max 之間。
dimensions
待驗證的檔案必須是符合規則參數所指定尺寸限制的圖片:
'avatar' => 'dimensions:min_width=100,min_height=200'可用的限制選項有:min_width、max_width、min_height、max_height、width、height、ratio。
ratio 限制應表示為寬度除以高度。這可以透過像 3/2 這樣的分數或像 1.5 這樣的浮點數來指定:
'avatar' => 'dimensions:ratio=3/2'由於此規則需要多個參數,因此使用 Rule::dimensions 方法來流暢地建構規則通常會更方便:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'avatar' => [
'required',
Rule::dimensions()
->maxWidth(1000)
->maxHeight(500)
->ratio(3 / 2),
],
]);distinct
當驗證陣列時,待驗證的欄位不得有任何重複的數值:
'foo.*.id' => 'distinct'預設情況下,Distinct 使用寬鬆的變數比較。若要使用嚴格比較,您可以在驗證規則定義中加入 strict 參數:
'foo.*.id' => 'distinct:strict'您可以在驗證規則的參數中加入 ignore_case,讓規則忽略大小寫差異:
'foo.*.id' => 'distinct:ignore_case'doesnt_start_with:foo,bar,...
待驗證的欄位開頭不得為指定的數值之一。
doesnt_end_with:foo,bar,...
待驗證的欄位結尾不得為指定的數值之一。
email
待驗證的欄位格式必須為電子郵件地址。此驗證規則利用 egulias/email-validator 套件來驗證電子郵件地址。預設情況下,會套用 RFCValidation 驗證器,但您也可以套用其他驗證樣式:
'email' => 'email:rfc,dns'上面的範例將套用 RFCValidation 與 DNSCheckValidation 驗證。以下是您可以套用的完整驗證樣式列表:
rfc:RFCValidation- 根據 支援的 RFC 驗證電子郵件地址。strict:NoRFCWarningsValidation- 根據 支援的 RFC 驗證電子郵件,當發現警告時(例如:結尾句點與多個連續句點)驗證失敗。dns:DNSCheckValidation- 確保電子郵件地址的網域具有有效的 MX 紀錄。spoof:SpoofCheckValidation- 確保電子郵件地址不包含同形文字或具欺騙性的 Unicode 字元。filter:FilterEmailValidation- 根據 PHP 的filter_var函式確保電子郵件地址有效。filter_unicode:FilterEmailValidation::unicode()- 根據 PHP 的filter_var函式確保電子郵件地址有效,允許部分 Unicode 字元。
為了方便起見,可以使用流暢的規則建構器來建立電子郵件驗證規則:
use Illuminate\Validation\Rule;
$request->validate([
'email' => [
'required',
Rule::email()
->rfcCompliant(strict: false)
->validateMxRecord()
->preventSpoofing()
],
]);⚠️ 警告
dns 與 spoof 驗證器需要 PHP intl 擴充功能。
encoding:encoding_type
待驗證的欄位必須符合指定的字元編碼。此規則使用 PHP 的 mb_check_encoding 函式來驗證給定檔案或字串值的編碼。為了方便起見,可以使用 Laravel 流暢的檔案規則建構器來建構 encoding 規則:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\File;
Validator::validate($input, [
'attachment' => [
'required',
File::types(['csv'])
->encoding('utf-8'),
],
]);ends_with:foo,bar,...
待驗證的欄位結尾必須為指定的數值之一。
enum
Enum 規則是一個基於類別的規則,用於驗證待驗證欄位是否包含有效的 enum 數值。Enum 規則接受 enum 的名稱作為其唯一的建構子參數。當驗證原始數值時,應提供一個 backed Enum 給 Enum 規則:
use App\Enums\ServerStatus;
use Illuminate\Validation\Rule;
$request->validate([
'status' => [Rule::enum(ServerStatus::class)],
]);Enum 規則的 only 與 except 方法可用於限制哪些 enum 案例應被視為有效:
Rule::enum(ServerStatus::class)
->only([ServerStatus::Pending, ServerStatus::Active]);
Rule::enum(ServerStatus::class)
->except([ServerStatus::Pending, ServerStatus::Active]);when 方法可用於條件式地修改 Enum 規則:
use Illuminate\Support\Facades\Auth;
use Illuminate\Validation\Rule;
Rule::enum(ServerStatus::class)
->when(
Auth::user()->isAdmin(),
fn ($rule) => $rule->only(...),
fn ($rule) => $rule->only(...),
);exclude
待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除。
exclude_if:anotherfield,value
待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除,前提是 anotherfield 欄位等於 value。
如果需要複雜的條件式排除邏輯,您可以使用 Rule::excludeIf 方法。此方法接受布林值或閉包。當提供閉包時,該閉包應回傳 true 或 false 以指示是否應排除待驗證的欄位:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::excludeIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::excludeIf(fn () => $request->user()->is_admin),
]);exclude_unless:anotherfield,value
待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除,除非 anotherfield 的欄位等於 value。若 value 為 null (exclude_unless:name,null),則除非比較欄位為 null 或請求資料中遺漏比較欄位,否則待驗證欄位將被排除。
exclude_with:anotherfield
待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除,前提是 anotherfield 欄位存在。
exclude_without:anotherfield
待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除,前提是 anotherfield 欄位不存在。
exists:table,column
待驗證的欄位必須存在於指定的資料庫資料表中。
Exists 規則的基本用法
'state' => 'exists:states'若未指定 column 選項,則會使用欄位名稱。因此,在此情況下,該規則將驗證 states 資料庫資料表是否包含一筆其 state 欄位值與請求的 state 屬性值相符的紀錄。
指定自定義欄位名稱
您可以透過在資料庫資料表名稱後方加上欄位名稱,來明確指定驗證規則應使用的資料庫欄位名稱:
'state' => 'exists:states,abbreviation'有時,您可能需要指定用於 exists 查詢的特定資料庫連線。您可以透過在資料表名稱前加上連線名稱來達成此目的:
'email' => 'exists:connection.staff,email'除了直接指定資料表名稱,您也可以指定應當用於決定資料表名稱的 Eloquent 模型:
'user_id' => 'exists:App\Models\User,id'如果您想要自定義驗證規則執行的查詢,可以使用 Rule 類別來流暢地定義規則。在此範例中,我們還會將驗證規則指定為陣列,而非使用 | 字元來分隔它們:
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::exists('staff')->where(function (Builder $query) {
$query->where('account_id', 1);
}),
],
]);您可以透過將欄位名稱作為 exists 方法的第二個參數,來明確指定由 Rule::exists 方法產生的 exists 規則應使用的資料庫欄位名稱:
'state' => Rule::exists('states', 'abbreviation'),有時,您可能希望驗證一個陣列值是否存在於資料庫中。您可以透過將 exists 與 array 規則同時加入到要驗證的欄位中來達成此目的:
'states' => ['array', Rule::exists('states', 'abbreviation')],當這兩個規則都分配給一個欄位時,Laravel 將自動建立單個查詢,以判斷所有給定的值是否存在於指定的資料表中。
extensions:foo,bar,...
被驗證的檔案必須具有與所列副檔名之一相對應的使用者指定副檔名:
'photo' => ['required', 'extensions:jpg,png'],file
被驗證的欄位必須是成功上傳的檔案。
filled
被驗證的欄位在存在時不得為空。
gt:field
被驗證的欄位必須大於指定的 field 或 value。這兩個欄位必須是相同的類型。字串、數值、陣列和檔案的評估方式與 size 規則相同。
gte:field
被驗證的欄位必須大於或等於指定的 field 或 value。這兩個欄位必須是相同的類型。字串、數值、陣列和檔案的評估方式與 size 規則相同。
hex_color
被驗證的欄位必須包含 十六進位 格式的有效顏色值。
image
被驗證的檔案必須是圖片 (jpg, jpeg, png, bmp, gif 或 webp)。
⚠️ 警告
預設情況下,image 規則不允許 SVG 檔案,因為可能存在 XSS 漏洞。如果您需要允許 SVG 檔案,可以將 allow_svg 指令提供給 image 規則 (image:allow_svg)。
in:foo,bar,...
被驗證的欄位必須包含在指定的數值清單中。由於此規則通常需要您 implode 陣列,因此可以使用 Rule::in 方法來流暢地建構規則:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'zones' => [
'required',
Rule::in(['first-zone', 'second-zone']),
],
]);當 in 規則與 array 規則結合使用時,輸入陣列中的每個值都必須存在於提供給 in 規則的數值清單中。在以下範例中,輸入陣列中的 LAS 機場代碼是無效的,因為它不包含在提供給 in 規則的機場清單中:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
$input = [
'airports' => ['NYC', 'LAS'],
];
Validator::make($input, [
'airports' => [
'required',
'array',
],
'airports.*' => Rule::in(['NYC', 'LIT']),
]);in_array:anotherfield.*
被驗證的欄位必須存在於 anotherfield 的值中。
in_array_keys:value.*
被驗證的欄位必須是一個陣列,且該陣列中至少有一個鍵名為指定的 values 之一:
'config' => 'array|in_array_keys:timezone'integer
被驗證的欄位必須是整數。
您可以使用 strict 參數,只有在欄位類型為 integer 時才視為有效。包含整數值的字串將被視為無效:
'age' => 'integer:strict'⚠️ 警告
此驗證規則不會驗證輸入是否為 "integer" 變數類型,僅驗證輸入是否為 PHP 的 FILTER_VALIDATE_INT 規則所接受的類型。如果您需要將輸入驗證為數字,請將此規則與 the numeric validation rule 結合使用。
ip
被驗證的欄位必須是 IP 位址。
ipv4
被驗證的欄位必須是 IPv4 位址。
ipv6
被驗證的欄位必須是 IPv6 位址。
json
被驗證的欄位必須是有效的 JSON 字串。
lt:field
被驗證的欄位必須小於指定的 field。這兩個欄位必須是相同的類型。字串、數值、陣列和檔案的評估方式與 size 規則相同。
lte:field
被驗證的欄位必須小於或等於指定的 field。這兩個欄位必須是相同的類型。字串、數值、陣列和檔案的評估方式與 size 規則相同。
lowercase
被驗證的欄位必須是小寫。
list
被驗證的欄位必須是一個列表形式的陣列。如果一個陣列的鍵由從 0 到 count($array) - 1 的連續數字組成,則該陣列被視為列表。
mac_address
被驗證的欄位必須是 MAC 位址。
max:value
被驗證的欄位必須小於或等於最大值 value。字串、數值、陣列和檔案的評估方式與 size 規則相同。
max_digits:value
被驗證的整數最大長度必須為 value。
mimetypes:text/plain,...
被驗證的檔案必須符合指定的 MIME 類型之一:
'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime'為了確定上傳檔案的 MIME 類型,系統將讀取檔案內容,且框架將嘗試猜測 MIME 類型,這可能與客戶端提供的 MIME 類型不同。
mimes:foo,bar,...
待驗證的檔案必須具有對應於所列副檔名之一的 MIME 類型:
'photo' => 'mimes:jpg,bmp,png'即使您只需要指定副檔名,此規則實際上仍會透過讀取檔案內容並猜測其 MIME 類型來進行驗證。MIME 類型及其對應副檔名的完整列表可以在以下位置找到:
https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
MIME 類型與副檔名
此驗證規則不會驗證 MIME 類型與使用者為檔案分配的副檔名之間的一致性。例如,mimes:png 驗證規則會將包含有效 PNG 內容的檔案視為有效的 PNG 圖片,即使該檔案被命名為 photo.txt。如果您想驗證使用者分配的檔案副檔名,可以使用 extensions 規則。
min:value
待驗證的欄位必須具有最小值 value。字串、數字、陣列和檔案的評估方式與 size 規則相同。
min_digits:value
待驗證的整數必須具有最小長度 value。
multiple_of:value
待驗證的欄位必須是 value 的倍數。
missing
待驗證的欄位必須不存在於輸入資料中。
missing_if:anotherfield,value,...
如果 anotherfield 欄位等於任何 value,則待驗證的欄位必須不存在。
missing_unless:anotherfield,value
除非 anotherfield 欄位等於任何 value,否則待驗證的欄位必須不存在。
missing_with:foo,bar,...
「僅當」其他任何指定的欄位存在時,待驗證的欄位才必須不存在。
missing_with_all:foo,bar,...
「僅當」所有其他指定的欄位都存在時,待驗證的欄位才必須不存在。
not_in:foo,bar,...
待驗證的欄位不得包含在給定的數值列表中。可以使用 Rule::notIn 方法來流暢地建構此規則:
use Illuminate\Validation\Rule;
Validator::make($data, [
'toppings' => [
'required',
Rule::notIn(['sprinkles', 'cherries']),
],
]);not_regex:pattern
待驗證的欄位不得符合給定的正規表達式。
在內部,此規則使用 PHP 的 preg_match 函式。指定的模式應遵循 preg_match 所需的相同格式,因此也應包含有效的定界符。例如:'email' => 'not_regex:/^.+$/i'。
⚠️ 警告
當使用 regex / not_regex 模式時,可能需要使用陣列而非 | 定界符來指定驗證規則,特別是當正規表達式包含 | 字元時。
nullable
待驗證的欄位可以為 null。
numeric
待驗證的欄位必須是 數字。
您可以使用 strict 參數,僅在欄位數值為整數或浮點數類型時才視為有效。數字字串將被視為無效:
'amount' => 'numeric:strict'present
待驗證的欄位必須存在於輸入資料中。
present_if:anotherfield,value,...
如果 anotherfield 欄位等於任何 value,則待驗證的欄位必須存在。
present_unless:anotherfield,value
除非 anotherfield 欄位等於任何 value,否則待驗證的欄位必須存在。
present_with:foo,bar,...
「僅當」其他任何指定的欄位存在時,待驗證的欄位才必須存在。
present_with_all:foo,bar,...
「僅當」所有其他指定的欄位都存在時,待驗證的欄位才必須存在。
prohibited
待驗證的欄位必須缺失或為空。如果欄位符合以下標準之一,則被視為「空」:
- 數值為
null。 - 數值為空字串。
- 數值為空陣列或空的
Countable物件。 - 數值為路徑為空的已上傳檔案。
prohibited_if:anotherfield,value,...
如果 anotherfield 欄位等於任何 value,則待驗證的欄位必須缺失或為空。如果欄位符合以下標準之一,則被視為「空」:
- 數值為
null。 - 數值為空字串。
- 數值為空陣列或空的
Countable物件。 - 數值為路徑為空的已上傳檔案。
如果需要複雜的條件式禁止邏輯,可以使用 Rule::prohibitedIf 方法。此方法接受一個布林值或一個閉包。當提供閉包時,閉包應返回 true 或 false 以指示待驗證的欄位是否應被禁止:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::prohibitedIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::prohibitedIf(fn () => $request->user()->is_admin),
]);prohibited_if_accepted:anotherfield,...
如果 anotherfield 欄位等於 "yes"、"on"、1、"1"、true 或 "true",則待驗證的欄位必須缺失或為空。
prohibited_if_declined:anotherfield,...
如果 anotherfield 欄位等於 "no"、"off"、0、"0"、false 或 "false",則待驗證的欄位必須缺失或為空。
prohibited_unless:anotherfield,value,...
除非 anotherfield 欄位等於任何 value,否則待驗證的欄位必須缺失或為空。如果欄位符合以下標準之一,則被視為「空」:
- 數值為
null。 - 數值為空字串。
- 數值為空陣列或空的
Countable物件。 - 數值為路徑為空的已上傳檔案。
prohibits:anotherfield,...
如果待驗證的欄位不是缺失或為空,則 anotherfield 中的所有欄位必須缺失或為空。如果欄位符合以下標準之一,則被視為「空」:
- 數值為
null。 - 數值為空字串。
- 數值為空陣列或空的
Countable物件。 - 數值為路徑為空的已上傳檔案。
regex:pattern
待驗證的欄位必須符合給定的正規表達式。
在內部,此規則使用 PHP 的 preg_match 函式。指定的模式應遵循 preg_match 所需的相同格式,因此也應包含有效的定界符。例如:'email' => 'regex:/^.+@.+$/i'。
⚠️ 警告
當使用 regex / not_regex 模式時,可能需要使用陣列而非 | 定界符來指定規則,特別是當正規表達式包含 | 字元時。
required
待驗證的欄位必須存在於輸入資料中且不為空。若欄位符合以下任一標準,則視為「空」:
- 值為
null。 - 值為空字串。
- 值為空陣列或空的
Countable物件。 - 值為沒有路徑的已上傳檔案。
required_if:anotherfield,value,...
若 anotherfield 欄位等於任何一個 value,則待驗證的欄位必須存在且不為空。
如果您想為 required_if 規則構建更複雜的條件,可以使用 Rule::requiredIf 方法。此方法接受一個布林值或一個閉包。當傳入閉包時,該閉包應回傳 true 或 false 以指示待驗證的欄位是否為必填:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::requiredIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::requiredIf(fn () => $request->user()->is_admin),
]);required_if_accepted:anotherfield,...
若 anotherfield 欄位等於 "yes", "on", 1, "1", true, 或 "true",則待驗證的欄位必須存在且不為空。
required_if_declined:anotherfield,...
若 anotherfield 欄位等於 "no", "off", 0, "0", false, 或 "false",則待驗證的欄位必須存在且不為空。
required_unless:anotherfield,value,...
除非 anotherfield 欄位等於任何一個 value,否則待驗證的欄位必須存在且不為空。這也代表除非 value 為 null,否則 anotherfield 必須存在於請求資料中。如果 value 為 null (required_unless:name,null),則除非比較欄位為 null 或請求資料中缺少該比較欄位,否則待驗證欄位將是必填的。
required_with:foo,bar,...
僅當指定的任一其他欄位存在且不為空時,待驗證的欄位才必須存在且不為空。
required_with_all:foo,bar,...
僅當指定的所有其他欄位皆存在且不為空時,待驗證的欄位才必須存在且不為空。
required_without:foo,bar,...
僅當指定的任一其他欄位為空或不存在時,待驗證的欄位才必須存在且不為空。
required_without_all:foo,bar,...
僅當指定的所有其他欄位皆為空或不存在時,待驗證的欄位才必須存在且不為空。
required_array_keys:foo,bar,...
待驗證的欄位必須是一個陣列,且必須至少包含指定的鍵名 (Keys)。
same:field
給定的 field 必須與待驗證的欄位值相符。
size:value
待驗證欄位的大小必須與給定的 value 相符。對於字串資料,value 對應字元數。對於數值資料,value 對應給定的整數值(該屬性還必須具有 numeric 或 integer 規則)。對於陣列,size 對應陣列的 count 數量。對於檔案,size 對應檔案大小(以 KB 為單位)。讓我們看一些範例:
// Validate that a string is exactly 12 characters long...
'title' => 'size:12';
// Validate that a provided integer equals 10...
'seats' => 'integer|size:10';
// Validate that an array has exactly 5 elements...
'tags' => 'array|size:5';
// Validate that an uploaded file is exactly 512 kilobytes...
'image' => 'file|size:512';starts_with:foo,bar,...
待驗證的欄位必須以給定的值之一開頭。
string
待驗證的欄位必須是字串。如果您想允許該欄位也可以是 null,則應為該欄位分配 nullable 規則。
timezone
待驗證的欄位必須是根據 DateTimeZone::listIdentifiers 方法定義的有效時區識別碼。
DateTimeZone::listIdentifiers 方法接受的參數也可以提供給此驗證規則:
'timezone' => 'required|timezone:all';
'timezone' => 'required|timezone:Africa';
'timezone' => 'required|timezone:per_country,US';unique:table,column
待驗證的欄位在指定的資料庫資料表中必須是不存在的。
指定自定義資料表 / 欄位名稱:
除了直接指定資料表名稱外,您也可以指定應當用於確定資料表名稱的 Eloquent 模型:
'email' => 'unique:App\Models\User,email_address'column 選項可用於指定欄位對應的資料庫欄位。若未指定 column 選項,則會使用待驗證屬性的名稱。
'email' => 'unique:users,email_address'指定自定義資料庫連線
有時您可能需要為驗證器執行的資料庫查詢設定自定義連線。若要達成此目的,可以在資料表名稱前加上連線名稱:
'email' => 'unique:connection.users,email_address'強制 Unique 規則忽略指定 ID:
有時您可能希望在進行唯一性驗證時忽略特定的 ID。例如,考慮一個包含使用者名稱、電子郵件地址和位置的「更新個人資料」畫面。您可能會想驗證電子郵件地址是否唯一。但是,如果使用者僅更改了名稱欄位而未更改電子郵件欄位,您不希望拋出驗證錯誤,因為該使用者本來就是該電子郵件地址的擁有者。
為了指示驗證器忽略使用者的 ID,我們將使用 Rule 類別來流暢地定義規則。在此範例中,我們還將驗證規則指定為陣列,而非使用 | 字元來分隔規則:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::unique('users')->ignore($user->id),
],
]);⚠️ 警告
您絕對不應該將任何使用者控制的請求輸入傳遞給 ignore 方法。相反地,您應該只傳遞系統產生的唯一 ID,例如來自 Eloquent 模型實例的自動遞增 ID 或 UUID。否則,您的應用程式將容易受到 SQL 注入攻擊。
除了將模型鍵的值傳遞給 ignore 方法外,您也可以傳遞整個模型實例。Laravel 將會自動從模型中提取主鍵:
Rule::unique('users')->ignore($user)如果您的資料表使用 id 以外的主鍵欄位名稱,您可以在呼叫 ignore 方法時指定該欄位的名稱:
Rule::unique('users')->ignore($user->id, 'user_id')預設情況下,unique 規則會檢查與待驗證屬性名稱相符的欄位唯一性。但是,您可以將不同的欄位名稱作為第二個參數傳遞給 unique 方法:
Rule::unique('users', 'email_address')->ignore($user->id)增加額外的 Where 子句:
您可以透過使用 where 方法自定義查詢來指定額外的查詢條件。例如,讓我們增加一個查詢條件,將查詢範圍限制在 account_id 欄位值為 1 的紀錄:
'email' => Rule::unique('users')->where(fn (Builder $query) => $query->where('account_id', 1))在 Unique 檢查中忽略軟刪除紀錄:
預設情況下,唯一性規則在判定唯一性時會包含已軟刪除的紀錄。若要從唯一性檢查中排除軟刪除紀錄,您可以呼叫 withoutTrashed 方法:
Rule::unique('users')->withoutTrashed();如果您的模型對軟刪除紀錄使用 deleted_at 以外的欄位名稱,您可以在呼叫 withoutTrashed 方法時提供該欄位名稱:
Rule::unique('users')->withoutTrashed('was_deleted_at');uppercase
待驗證的欄位必須是大寫。
url
待驗證的欄位必須是有效的 URL。
如果您想指定哪些 URL 協定應被視為有效,可以將這些協定作為驗證規則的參數傳入:
'url' => 'url:http,https',
'game' => 'url:minecraft,steam',ulid
待驗證的欄位必須是有效的 通用唯一詞典排序識別碼 (ULID)。
uuid
待驗證的欄位必須是有效的 RFC 9562(版本 1、3、4、5、6、7 或 8)通用唯一識別碼 (UUID)。
您也可以驗證指定的 UUID 是否符合特定版本的 UUID 規範:
'uuid' => 'uuid:4'條件式加入規則
當欄位為特定值時跳過驗證
您有時可能希望在另一個欄位為特定值時不驗證給定欄位。您可以使用 exclude_if 驗證規則來達成此目的。在此範例中,如果 has_appointment 欄位的值為 false,則不會驗證 appointment_date 和 doctor_name 欄位:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($data, [
'has_appointment' => 'required|boolean',
'appointment_date' => 'exclude_if:has_appointment,false|required|date',
'doctor_name' => 'exclude_if:has_appointment,false|required|string',
]);或者,您可以使用 exclude_unless 規則,除非另一個欄位具有給定值,否則不驗證給定欄位:
$validator = Validator::make($data, [
'has_appointment' => 'required|boolean',
'appointment_date' => 'exclude_unless:has_appointment,true|required|date',
'doctor_name' => 'exclude_unless:has_appointment,true|required|string',
]);當欄位存在時驗證
在某些情況下,您可能希望僅當欄位存在於被驗證的資料中時,才對該欄位執行驗證檢查。要快速達成此目的,請將 sometimes 規則加入您的規則清單中:
$validator = Validator::make($data, [
'email' => 'sometimes|required|email',
]);在上面的範例中,email 欄位僅在它存在於 $data 陣列中時才會被驗證。
📌 備註
如果您嘗試驗證一個應該始終存在但可能為空的欄位,請查看關於可選欄位的注意事項。
複雜的條件式驗證
有時您可能希望根據更複雜的條件邏輯來加入驗證規則。例如,您可能希望僅在另一個欄位的值大於 100 時才要求給定欄位。或者,您可能需要兩個欄位僅在另一個欄位存在時才具有給定值。加入這些驗證規則並不麻煩。首先,使用永不改變的 static rules (靜態規則) 建立一個 Validator 實例:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'email' => 'required|email',
'games' => 'required|integer|min:0',
]);假設我們的網頁應用程式是為遊戲收藏家設計的。如果一位遊戲收藏家在我們的應用程式註冊,且他們擁有超過 100 款遊戲,我們希望他們解釋為什麼擁有這麼多遊戲。例如,或許他們經營一家遊戲二手店,或者他們只是單純喜歡收集遊戲。要條件式地加入此要求,我們可以在 Validator 實例上使用 sometimes 方法。
use Illuminate\Support\Fluent;
$validator->sometimes('reason', 'required|max:500', function (Fluent $input) {
return $input->games >= 100;
});傳遞給 sometimes 方法的第一個引數是我們有條件地要驗證的欄位名稱。第二個引數是我們想要加入的規則清單。如果作為第三個引數傳遞的閉包回傳 true,則會加入這些規則。此方法讓建立複雜的條件驗證變得非常容易。您甚至可以一次為多個欄位加入條件驗證:
$validator->sometimes(['reason', 'cost'], 'required', function (Fluent $input) {
return $input->games >= 100;
});📌 備註
傳遞給閉包的 $input 參數將會是 Illuminate\Support\Fluent 的實例,可用於存取您正在驗證的輸入資料與檔案。
複雜的條件式陣列驗證
有時您可能想根據同一個巢狀陣列中您不知道其索引的另一個欄位來驗證某個欄位。在這種情況下,您可以讓您的閉包接收第二個引數,該引數將是陣列中目前正在驗證的個別項目:
$input = [
'channels' => [
[
'type' => 'email',
'address' => '[email protected]',
],
[
'type' => 'url',
'address' => 'https://example.com',
],
],
];
$validator->sometimes('channels.*.address', 'email', function (Fluent $input, Fluent $item) {
return $item->type === 'email';
});
$validator->sometimes('channels.*.address', 'url', function (Fluent $input, Fluent $item) {
return $item->type !== 'email';
});與傳遞給閉包的 $input 參數一樣,當屬性資料是陣列時,$item 參數是 Illuminate\Support\Fluent 的實例;否則,它是一個字串。
驗證陣列
正如 array 驗證規則文件 中所討論的,array 規則接受一個允許的陣列鍵值列表。如果陣列中存在任何額外的鍵值,驗證將會失敗:
use Illuminate\Support\Facades\Validator;
$input = [
'user' => [
'name' => 'Taylor Otwell',
'username' => 'taylorotwell',
'admin' => true,
],
];
Validator::make($input, [
'user' => 'array:name,username',
]);通常情況下,您應該始終指定允許存在於陣列中的陣列鍵值。否則,驗證器的 validate 和 validated 方法將會回傳所有的驗證資料,包含該陣列及其所有的鍵值,即使這些鍵值未經其他巢狀陣列驗證規則驗證也是如此。
驗證巢狀陣列輸入
驗證巢狀陣列形式的表單輸入欄位並不困難。您可以使用「點號表示法 (dot notation)」來驗證陣列中的屬性。例如,如果傳入的 HTTP 請求包含一個 photos[profile] 欄位,您可以像這樣驗證它:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'photos.profile' => 'required|image',
]);您也可以驗證陣列中的每個元素。例如,要驗證給定陣列輸入欄位中的每個電子郵件是否唯一,您可以執行以下操作:
$validator = Validator::make($request->all(), [
'users.*.email' => 'email|unique:users',
'users.*.first_name' => 'required_with:users.*.last_name',
]);同樣地,在語言檔中指定自定義驗證訊息時,您可以使用 * 字元,這讓為陣列形式的欄位使用單一驗證訊息變得非常容易:
'custom' => [
'users.*.email' => [
'unique' => 'Each user must have a unique email address',
]
],存取巢狀陣列資料
有時在為屬性分配驗證規則時,您可能需要存取給定巢狀陣列元素的值。您可以使用 Rule::forEach 方法來達成此目的。forEach 方法接受一個閉包,該閉包將在驗證陣列屬性的每次迭代中被調用,並接收該屬性的值和顯式的、完整展開的屬性名稱。該閉包應回傳一個要分配給陣列元素的規則陣列:
use App\Rules\HasPermission;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
$validator = Validator::make($request->all(), [
'companies.*.id' => Rule::forEach(function (string|null $value, string $attribute) {
return [
Rule::exists(Company::class, 'id'),
new HasPermission('manage-company', $value),
];
}),
]);錯誤訊息索引與位置
驗證陣列時,您可能希望在應用程式顯示的錯誤訊息中引用驗證失敗的特定項目的索引或位置。要達成此目的,您可以在自定義驗證訊息中包含 :index (從 0 開始)、:position (從 1 開始) 或 :ordinal-position (從 1st 開始) 佔位符:
use Illuminate\Support\Facades\Validator;
$input = [
'photos' => [
[
'name' => 'BeachVacation.jpg',
'description' => 'A photo of my beach vacation!',
],
[
'name' => 'GrandCanyon.jpg',
'description' => '',
],
],
];
Validator::validate($input, [
'photos.*.description' => 'required',
], [
'photos.*.description.required' => 'Please describe photo #:position.',
]);在上述範例中,驗證將失敗,使用者將看到 "Please describe photo #2." 的錯誤訊息。
如有需要,您可以透過 second-index、second-position、third-index、third-position 等方式引用更深層巢狀的索引與位置。
'photos.*.attributes.*.string' => 'Invalid attribute for photo #:second-position.',驗證檔案
Laravel 提供了多種可用於驗證上傳檔案的驗證規則,例如 mimes、image、min 和 max。雖然您可以在驗證檔案時單獨指定這些規則,但 Laravel 還提供了一個流暢的檔案驗證規則生成器,您可能會覺得這很方便:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\File;
Validator::validate($input, [
'attachment' => [
'required',
File::types(['mp3', 'wav'])
->min(1024)
->max(12 * 1024),
],
]);驗證檔案類型
雖然您在調用 types 方法時只需要指定副檔名,但此方法實際上會透過讀取檔案內容並猜測其 MIME 類型來驗證檔案的 MIME 類型。MIME 類型及其對應副檔名的完整列表可以在以下位置找到:
https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
驗證檔案大小
為了方便起見,最小和最大檔案大小可以指定為帶有指示檔案大小單位後綴的字串。支援 kb、mb、gb 和 tb 後綴:
File::types(['mp3', 'wav'])
->min('1kb')
->max('10mb');驗證圖片檔案
如果您的應用程式接受使用者上傳的圖片,您可以使用 File 規則的 image 建構子方法來確保驗證的檔案是圖片 (jpg, jpeg, png, bmp, gif 或 webp)。
此外,dimensions 規則可用於限制圖片的尺寸:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;
Validator::validate($input, [
'photo' => [
'required',
File::image()
->min(1024)
->max(12 * 1024)
->dimensions(Rule::dimensions()->maxWidth(1000)->maxHeight(500)),
],
]);📌 備註
有關驗證圖片尺寸的更多資訊可以在 dimension 規則文件中找到。
⚠️ 警告
預設情況下,image 規則不允許 SVG 檔案,因為可能存在 XSS 漏洞。如果您需要允許 SVG 檔案,可以將 allowSvg: true 傳遞給 image 規則:File::image(allowSvg: true)。
驗證圖片尺寸
您也可以驗證圖片的尺寸。例如,要驗證上傳的圖片寬度至少為 1000 像素,高度至少為 500 像素,您可以使用 dimensions 規則:
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;
File::image()->dimensions(
Rule::dimensions()
->maxWidth(1000)
->maxHeight(500)
)📌 備註
有關驗證圖片尺寸的更多資訊可以在 dimension 規則文件中找到。
驗證密碼
為了確保密碼具有足夠的複雜度,您可以使用 Laravel 的 Password 規則物件:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;
$validator = Validator::make($request->all(), [
'password' => ['required', 'confirmed', Password::min(8)],
]);Password 規則物件讓您可以輕鬆地自定義應用程式的密碼複雜度要求,例如指定密碼需要至少一個字母、數字、符號或大小寫混合的字元:
// Require at least 8 characters...
Password::min(8)
// Require at least one letter...
Password::min(8)->letters()
// Require at least one uppercase and one lowercase letter...
Password::min(8)->mixedCase()
// Require at least one number...
Password::min(8)->numbers()
// Require at least one symbol...
Password::min(8)->symbols()此外,您可以使用 uncompromised 方法確保密碼未在公開的密碼資料外洩事件中遭到洩露:
Password::min(8)->uncompromised()在內部,Password 規則物件使用 k-Anonymity 模型,在不犧牲使用者隱私或安全的情況下,透過 haveibeenpwned.com 服務來判斷密碼是否已被洩露。
預設情況下,如果密碼在資料外洩中出現至少一次,則會被視為已洩漏。您可以使用 uncompromised 方法的第一個參數來定義此門檻:
// Ensure the password appears less than 3 times in the same data leak...
Password::min(8)->uncompromised(3);當然,您可以串接上述範例中的所有方法:
Password::min(8)
->letters()
->mixedCase()
->numbers()
->symbols()
->uncompromised()定義預設密碼規則
您可能會發現在應用程式中的單一位置指定密碼的預設驗證規則很方便。您可以使用 Password::defaults 方法輕鬆達成此目的,該方法接受一個閉包。提供給 defaults 方法的閉包應該回傳 Password 規則的預設設定。通常,defaults 規則應該在應用程式其中一個服務提供者的 boot 方法中呼叫:
use Illuminate\Validation\Rules\Password;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Password::defaults(function () {
$rule = Password::min(8);
return $this->app->isProduction()
? $rule->mixedCase()->uncompromised()
: $rule;
});
}接著,當您想要對正在進行驗證的特定密碼套用預設規則時,您可以呼叫不帶參數的 defaults 方法:
'password' => ['required', Password::defaults()],有時候,您可能希望在預設的密碼驗證規則中加入額外的驗證規則。您可以使用 rules 方法來達成此目的:
use App\Rules\ZxcvbnRule;
Password::defaults(function () {
$rule = Password::min(8)->rules([new ZxcvbnRule]);
// ...
});自定義驗證規則
使用規則物件
Laravel 提供了各種實用的驗證規則;然而,您可能希望指定一些自己的規則。註冊自定義驗證規則的一種方法是使用規則物件。要產生一個新的規則物件,您可以使用 make:rule Artisan 指令。讓我們使用這個指令來產生一個驗證字串是否為大寫的規則。Laravel 將會把新的規則放在 app/Rules 目錄中。如果此目錄不存在,當您執行 Artisan 指令來建立規則時,Laravel 會自動建立它:
php artisan make:rule Uppercase規則建立完成後,我們就可以定義它的行為。規則物件包含一個方法:validate。此方法接收屬性名稱、其數值,以及一個在驗證失敗時應呼叫的驗證錯誤訊息回呼函式:
<?php
namespace App\Rules;
use Closure;
use Illuminate\Contracts\Validation\ValidationRule;
class Uppercase implements ValidationRule
{
/**
* Run the validation rule.
*/
public function validate(string $attribute, mixed $value, Closure $fail): void
{
if (strtoupper($value) !== $value) {
$fail('The :attribute must be uppercase.');
}
}
}定義好規則後,您可以藉由將規則物件的實例連同其他驗證規則一起傳遞給驗證器來掛載它:
use App\Rules\Uppercase;
$request->validate([
'name' => ['required', 'string', new Uppercase],
]);翻譯驗證訊息
除了直接向 $fail 閉包提供字面錯誤訊息外,您也可以提供一個 翻譯字串鍵值 並指示 Laravel 翻譯該錯誤訊息:
if (strtoupper($value) !== $value) {
$fail('validation.uppercase')->translate();
}如果有需要,您可以將佔位符替換內容與偏好的語言作為第一和第二個參數傳遞給 translate 方法:
$fail('validation.location')->translate([
'value' => $this->value,
], 'fr');存取額外資料
如果您的自定義驗證規則類別需要存取所有正在進行驗證的其他資料,您的規則類別可以實作 Illuminate\Contracts\Validation\DataAwareRule 介面。此介面要求您的類別定義一個 setData 方法。Laravel 會在驗證開始前自動呼叫此方法,並傳入所有正在驗證的資料:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\DataAwareRule;
use Illuminate\Contracts\Validation\ValidationRule;
class Uppercase implements DataAwareRule, ValidationRule
{
/**
* All of the data under validation.
*
* @var array<string, mixed>
*/
protected $data = [];
// ...
/**
* Set the data under validation.
*
* @param array<string, mixed> $data
*/
public function setData(array $data): static
{
$this->data = $data;
return $this;
}
}或者,如果您的驗證規則需要存取正在執行驗證的驗證器實例,您可以實作 ValidatorAwareRule 介面:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Contracts\Validation\ValidatorAwareRule;
use Illuminate\Validation\Validator;
class Uppercase implements ValidationRule, ValidatorAwareRule
{
/**
* The validator instance.
*
* @var \Illuminate\Validation\Validator
*/
protected $validator;
// ...
/**
* Set the current validator.
*/
public function setValidator(Validator $validator): static
{
$this->validator = $validator;
return $this;
}
}使用閉包
如果您在整個應用程式中只需要使用一次自定義規則的功能,您可以使用閉包來代替規則物件。該閉包接收屬性名稱、屬性值,以及一個在驗證失敗時應該呼叫的 $fail 回呼函式:
use Illuminate\Support\Facades\Validator;
use Closure;
$validator = Validator::make($request->all(), [
'title' => [
'required',
'max:255',
function (string $attribute, mixed $value, Closure $fail) {
if ($value === 'foo') {
$fail("The {$attribute} is invalid.");
}
},
],
]);隱式規則
預設情況下,當被驗證的屬性不存在或包含空字串時,一般的驗證規則(包括自定義規則)都不會執行。例如,unique 規則將不會針對空字串執行:
use Illuminate\Support\Facades\Validator;
$rules = ['name' => 'unique:users,name'];
$input = ['name' => ''];
Validator::make($input, $rules)->passes(); // true若要讓自定義規則在屬性為空時也能執行,該規則必須暗示該屬性是必填的。要快速產生一個新的隱式規則物件,您可以使用帶有 --implicit 選項的 make:rule Artisan 指令:
php artisan make:rule Uppercase --implicit⚠️ 警告
「隱式」規則僅 暗示 屬性是必填的。至於它是否真的會使缺失或空的屬性驗證失敗,則由您決定。