驗證 (Validation)
- 簡介
- 驗證快速上手
- 表單請求驗證 (Form Request Validation)
- 手動建立驗證器
- 處理已驗證的輸入
- 處理錯誤訊息
- 可用驗證規則
- 條件式加入規則
- 驗證陣列
- 驗證檔案
- 驗證密碼
- 自訂驗證規則
簡介
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
{
/**
* 顯示建立新部落格貼文的表單。
*/
public function create(): View
{
return view('post.create');
}
/**
* 儲存新的部落格貼文。
*/
public function store(Request $request): RedirectResponse
{
// 驗證並儲存部落格貼文...
$post = /** ... */
return to_route('post.show', ['post' => $post->id]);
}
}
編寫驗證邏輯
現在我們準備在 store 方法中填入驗證新部落格貼文的邏輯。為此,我們將使用 Illuminate\Http\Request 物件提供的 validate 方法。如果驗證規則通過,您的程式碼將繼續正常執行;但如果驗證失敗,則會拋出 Illuminate\Validation\ValidationException 異常,並自動將適當的錯誤回應傳回給使用者。
如果在傳統 HTTP 請求期間驗證失敗,則會產生一個重新導向到上一個 URL 的回應。如果傳入的請求是 XHR 請求,則會傳回一個 包含驗證錯誤訊息的 JSON 回應。
為了更瞭解 validate 方法,讓我們回到 store 方法:
/**
* 儲存新的部落格貼文。
*/
public function store(Request $request): RedirectResponse
{
$validated = $request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
// 部落格貼文有效...
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 中。
一個 $errors 變數會透過 web 中介軟體群組提供的 Illuminate\View\Middleware\ShareErrorsFromSession 中介軟體與應用程式的所有視圖共用。當應用此中介軟體時,視圖中始終可以使用 $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 在地化的更多資訊,請參閱完整的 在地化文件。
[!WARNING] 預設情況下,Laravel 應用程式骨架不包含
lang目錄。如果您想自訂 Laravel 的語言檔,可以透過lang:publishArtisan 指令發布它們。
XHR 請求與驗證
在此範例中,我們使用傳統表單將資料傳送到應用程式。然而,許多應用程式接收來自 JavaScript 驅動的前端的 XHR 請求。在 XHR 請求期間使用 validate 方法時,Laravel 不會產生重新導向回應。相反地,Laravel 會產生一個 包含所有驗證錯誤的 JSON 回應。此 JSON 回應將與 422 HTTP 狀態碼一起傳送。
@error 指令
您可以使用 @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 由於驗證錯誤而產生重新導向回應時,框架會自動 將請求的所有輸入快閃到 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 回應格式範例。請注意,巢狀的錯誤鍵會被展平為「點」記法格式:
{
"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 Validation)
建立表單請求
對於更複雜的驗證情境,您可能希望建立一個「表單請求 (Form Request)」。表單請求是封裝了自身驗證和授權邏輯的自訂請求類別。要建立一個表單請求類別,您可以使用 make:request Artisan CLI 指令:
php artisan make:request StorePostRequest
產生的表單請求類別將放置在 app/Http/Requests 目錄中。如果此目錄不存在,它將在您執行 make:request 指令時建立。Laravel 產生的每個表單請求都有兩個方法:authorize 和 rules。
正如您所猜想的,authorize 方法負責確定當前經過身分驗證的使用者是否可以執行請求所代表的操作,而 rules 方法則傳回應套用於請求資料的驗證規則:
/**
* 取得套用於請求的驗證規則。
*
* @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
*/
public function rules(): array
{
return [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
];
}
[!NOTE] 您可以在
rules方法的簽章中型別提示您需要的任何依賴項。它們將透過 Laravel 服務容器 (Service Container) 自動解析。
那麼,驗證規則是如何評估的呢?您只需在控制器方法中型別提示該請求即可。傳入的表單請求會在呼叫控制器方法之前進行驗證,這意味著您不需要在控制器中混雜任何驗證邏輯:
/**
* 儲存新的部落格貼文。
*/
public function store(StorePostRequest $request): RedirectResponse
{
// 傳入的請求有效...
// 檢索已驗證的輸入資料...
$validated = $request->validated();
// 檢索部分已驗證的輸入資料...
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
// 儲存部落格貼文...
return redirect('/posts');
}
如果驗證失敗,將產生一個重新導向回應以將使用者送回其先前的位置。錯誤也會快閃到 Session 中,以便顯示。如果請求是 XHR 請求,則會傳回一個帶有 422 狀態碼的 HTTP 回應,其中包含 驗證錯誤的 JSON 表示形式。
[!NOTE] 需要為您的 Inertia 驅動的 Laravel 前端新增即時表單請求驗證嗎?請查看 Laravel Precognition。
在表單請求上執行額外驗證
有時您需要在初始驗證完成後執行額外驗證。您可以使用表單請求的 after 方法來實現。
after 方法應傳回一個呼叫對象 (Callable) 或閉包的陣列,這些對象將在驗證完成後被呼叫。給定的呼叫對象將接收一個 Illuminate\Validation\Validator 實例,允許您在必要時引發額外的錯誤訊息:
use Illuminate\Validation\Validator;
/**
* 取得請求的「之後」驗證呼叫對象。
*/
public function after(): array
{
return [
function (Validator $validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add(
'field',
'Something is wrong with this field!'
);
}
}
];
}
如前所述,after 方法傳回的陣列也可以包含可呼叫類別 (Invokable Classes)。這些類別的 __invoke 方法將接收一個 Illuminate\Validation\Validator 實例:
use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
use Illuminate\Validation\Validator;
/**
* 取得請求的「之後」驗證呼叫對象。
*/
public function after(): array
{
return [
new ValidateUserStatus,
new ValidateShippingTime,
function (Validator $validator) {
//
}
];
}
在第一次驗證失敗時停止
透過將 StopOnFirstFailure 屬性新增到您的請求類別中,您可以告知驗證器一旦發生單個驗證失敗,就應停止驗證所有屬性:
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\Attributes\StopOnFirstFailure;
use Illuminate\Foundation\Http\FormRequest;
#[StopOnFirstFailure]
class StorePostRequest extends FormRequest
{
// ...
}
自訂重新導向位置
當表單請求驗證失敗時,會產生一個重新導向回應,將使用者送回其先前的位置。但是,您可以自由自訂此行為。為此,您可以在表單請求上使用 RedirectTo 屬性:
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\Attributes\RedirectTo;
use Illuminate\Foundation\Http\FormRequest;
#[RedirectTo('/dashboard')]
class StorePostRequest extends FormRequest
{
// ...
}
或者,如果您想將使用者重新導向到命名的路由,可以使用 RedirectToRoute 屬性代替:
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\Attributes\RedirectToRoute;
use Illuminate\Foundation\Http\FormRequest;
#[RedirectToRoute('dashboard')]
class StorePostRequest extends FormRequest
{
// ...
}
自訂錯誤包
當表單請求驗證失敗時,錯誤會快閃到 default 錯誤包中。如果您需要將錯誤儲存在不同的 命名的錯誤包 中,可以在表單請求上使用 ErrorBag 屬性:
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\Attributes\ErrorBag;
use Illuminate\Foundation\Http\FormRequest;
#[ErrorBag('login')]
class LoginRequest extends FormRequest
{
// ...
}
授權表單請求
表單請求類別還包含一個 authorize 方法。在此方法中,您可以確定經過身分驗證的使用者是否確實有權限更新給定的資源。例如,您可以確定使用者是否確實擁有所要更新的部落格評論。最有可能的情況是,您會在此方法中與您的 授權 Gate 和 Policy 互動:
use App\Models\Comment;
/**
* 確定使用者是否有權發出此請求。
*/
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}');
因此,如果您的應用程式利用了 路由模型綁定 (Route Model Binding),透過將解析後的模型作為請求的屬性來存取,可以使您的程式碼更加簡潔:
return $this->user()->can('update', $this->comment);
如果 authorize 方法傳回 false,則會自動傳回一個帶有 403 狀態碼的 HTTP 回應,且您的控制器方法將不會執行。
如果您打算在應用程式的其他部分處理請求的授權邏輯,可以完全刪除 authorize 方法,或直接傳回 true:
/**
* 確定使用者是否有權發出此請求。
*/
public function authorize(): bool
{
return true;
}
[!NOTE] 您可以在
authorize方法的簽章中型別提示您需要的任何依賴項。它們將透過 Laravel 服務容器 自動解析。
自訂錯誤訊息
您可以透過覆寫 messages 方法來編修表單請求使用的錯誤訊息。此方法應傳回屬性 / 規則配對及其相應錯誤訊息的陣列:
/**
* 取得已定義驗證規則的錯誤訊息。
*
* @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 方法來指定自訂名稱。此方法應傳回屬性 / 名稱配對的陣列:
/**
* 取得驗證器錯誤的自訂屬性。
*
* @return array<string, string>
*/
public function attributes(): array
{
return [
'email' => 'email address',
];
}
驗證前預處理輸入
如果您在應用驗證規則之前需要準備或清理來自請求的任何資料,可以使用 prepareForValidation 方法:
use Illuminate\Support\Str;
/**
* 準備驗證資料。
*/
protected function prepareForValidation(): void
{
$this->merge([
'slug' => Str::slug($this->slug),
]);
}
同樣地,如果您在驗證完成後需要規格化任何請求資料,可以使用 passedValidation 方法:
/**
* 處理通過驗證的嘗試。
*/
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
{
/**
* 儲存新的部落格貼文。
*/
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();
}
// 檢索已驗證的輸入...
$validated = $validator->validated();
// 檢索部分已驗證的輸入...
$validated = $validator->safe()->only(['name', 'email']);
$validated = $validator->safe()->except(['name', 'email']);
// 儲存部落格貼文...
return redirect('/posts');
}
}
傳遞給 make 方法的第一個引數是待驗證的資料。第二個引數是應套用於資料的驗證規則陣列。
在確定請求驗證失敗後,您可以使用 withErrors 方法將錯誤訊息快閃到 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',
];
為指定屬性指定自訂訊息
有時您可能只想為特定屬性指定自訂錯誤訊息。您可以使用「點」記法來做到這一點。先指定屬性名稱,然後是規則:
$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 方法接受一個閉包或呼叫對象的陣列,這些對象將在驗證完成後被呼叫。給定的呼叫對象將接收一個 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 實例可以像陣列一樣被迭代和存取:
// 已驗證的資料可以被迭代...
foreach ($request->safe() as $key => $value) {
// ...
}
// 已驗證的資料可以像陣列一樣存取...
$validated = $request->safe();
$email = $validated['email'];
如果您想向已驗證資料中新增額外欄位,可以呼叫 merge 方法:
$validated = $request->safe()->merge(['name' => 'Taylor Otwell']);
如果您想將已驗證資料作為 集合 (Collection) 實例檢索,可以呼叫 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 在地化的更多資訊,請參閱完整的 在地化文件。
[!WARNING] 預設情況下,Laravel 應用程式骨架不包含
lang目錄。如果您想自訂 Laravel 的語言檔,可以透過lang:publishArtisan 指令發布它們。
指定屬性的自訂訊息
您可以在應用程式的驗證語言檔中自訂指定屬性和規則組合使用的錯誤訊息。為此,請將您的訊息自訂新增到應用程式 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',
],
[!WARNING] 預設情況下,Laravel 應用程式骨架不包含
lang目錄。如果您想自訂 Laravel 的語言檔,可以透過lang:publishArtisan 指令發布它們。
在語言檔中指定值名稱
Laravel 內建的一些驗證規則錯誤訊息包含一個 :value 佔位符,該佔位符會替換為請求屬性的當前值。但是,您有時可能需要將驗證訊息的 :value 部分替換為值的自訂表示。例如,考慮以下規則,該規則指定如果 payment_type 的值為 cc,則 credit_card_number 欄位為必填:
Validator::make($request->all(), [
'credit_card_number' => 'required_if:payment_type,cc'
]);
如果此驗證規則失敗,它將產生以下錯誤訊息:
The credit card number field is required when payment type is cc.
您可以透過定義 values 陣列,在 lang/xx/validation.php 語言檔中指定更友善的值表示,而不是將 cc 顯示為支付類型值:
'values' => [
'payment_type' => [
'cc' => 'credit card'
],
],
[!WARNING] 預設情況下,Laravel 應用程式骨架不包含
lang目錄。如果您想自訂 Laravel 的語言檔,可以透過lang:publishArtisan 指令發布它們。
定義此值後,驗證規則將產生以下錯誤訊息:
The credit card number field is required when payment type is credit card.
可用驗證規則
下面是所有可用驗證規則及其功能的列表:
布林值 (Booleans)
字串 (Strings)
Active URL Alpha Alpha Dash Alpha Numeric Ascii Confirmed Current Password Different Doesnt Start With Doesnt End With Email Ends With Enum Hex Color In IP Address JSON Lowercase MAC Address Max Min Not In Regular Expression Not Regular Expression Same Size Starts With String Uppercase URL ULID UUID
數字 (Numbers)
Between Decimal Different Digits Digits Between Greater Than Greater Than Or Equal Integer Less Than Less Than Or Equal Max Max Digits Min Min Digits Multiple Of Numeric Same Size
陣列 (Arrays)
日期 (Dates)
檔案 (Files)
資料庫 (Database)
公用程式 (Utilities)
Any Of Bail Exclude Exclude If Exclude Unless Exclude With Exclude Without Filled Missing Missing If Missing Unless Missing With Missing With All Nullable Present Present If Present Unless Present With Present With All Prohibited Prohibited If Prohibited If Accepted Prohibited If Declined Prohibited Unless Prohibits Required Required If Required If Accepted Required If Declined Required Unless Required With Required With All Required Without Required Without All Required Array Keys Sometimes
accepted
待驗證欄位必須是 "yes"、"on"、1、"1"、true 或 "true"。這對於驗證「服務條款」接受或類似欄位很有用。
accepted_if:anotherfield,value,...
如果另一個待驗證欄位等於指定的值,則待驗證欄位必須是 "yes"、"on"、1、"1"、true 或 "true"。這對於驗證「服務條款」接受或類似欄位很有用。
active_url
根據 dns_get_record PHP 函式,待驗證欄位必須具有有效的 A 或 AAAA 記錄。在傳遞給 dns_get_record 之前,會使用 parse_url PHP 函式提取所提供 URL 的主機名稱。
after:date
待驗證欄位必須是給定日期之後的值。日期將傳遞到 strtotime PHP 函式中,以便轉換為有效的 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 規則提供額外的值時,輸入陣列中的每個鍵都必須存在於提供給規則的值列表中。在以下範例中,輸入陣列中的 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
待驗證欄位必須與經過身分驗證的使用者的密碼匹配。您可以使用規則的第一個參數指定 驗證 Guard:
'password' => 'current_password:api'
date
根據 strtotime PHP 函式,待驗證欄位必須是一個有效的、非相對的日期。
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
待驗證欄位必須是數字,且必須包含指定的小數位數:
// 必須恰好有兩位小數 (9.99)...
'price' => 'decimal:2'
// 必須有 2 到 4 位小數...
'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,...
待驗證欄位不得以給定的任何值結尾。
待驗證欄位必須格式化為電子郵件地址。此驗證規則利用 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()
],
]);
[!WARNING]
dns和spoof驗證器需要 PHPintl擴充功能。
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 的名稱作為其唯一的建構函式引數。在驗證原始值時,應向 Enum 規則提供備存 Enum (Backed 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
如果 anotherfield 欄位等於 value,則待驗證欄位將從 validate 和 validated 方法傳回的請求資料中排除。
如果需要複雜的條件排除邏輯,可以利用 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
除非 anotherfield 的欄位等於 value,否則待驗證欄位將從 validate 和 validated 方法傳回的請求資料中排除。如果 value 是 null (exclude_unless:name,null),則除非比較欄位是 null 或比較欄位從請求資料中缺失,否則待驗證欄位將被排除。
exclude_with:anotherfield
如果 anotherfield 欄位存在,則待驗證欄位將從 validate 和 validated 方法傳回的請求資料中排除。
exclude_without:anotherfield
如果 anotherfield 欄位不存在,則待驗證欄位將從 validate 和 validated 方法傳回的請求資料中排除。
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'],
[!WARNING] 您絕不應僅依靠驗證檔案的使用者指定擴充功能。此規則通常應始終與 mimes 或 mimetypes 規則結合使用。
file
待驗證欄位必須是成功上傳的檔案。
filled
當待驗證欄位存在時,不得為空。
gt:field
待驗證欄位必須大於給定的 field 或 value。兩個欄位必須是相同的型別。字串、數字、陣列和檔案使用與 size 規則相同的慣例進行評估。
gte:field
待驗證欄位必須大於或等於給定的 field 或 value。兩個欄位必須是相同的型別。字串、數字、陣列和檔案使用與 size 規則相同的慣例進行評估。
hex_color
待驗證欄位必須包含 十六進位 格式的有效顏色值。
image
待驗證的檔案必須是圖片(jpg、jpeg、png、bmp、gif 或 webp)。
[!WARNING] 預設情況下,由於可能存在 XSS 漏洞,image 規則不允許 SVG 檔案。如果您需要允許 SVG 檔案,可以為
image規則提供allow_svg指令 (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'
[!WARNING] 此驗證規則不驗證輸入是否為「整數 (integer)」變數型別,僅驗證輸入是否為 PHP
FILTER_VALIDATE_INT規則所接受的型別。如果您需要驗證輸入是否為數字,請將此規則與 numeric 驗證規則 結合使用。
ip
待驗證欄位必須是 IP 地址。
ipv4
待驗證欄位必須是 IPv4 地址。
ipv6
待驗證欄位必須是 IPv6 地址。
json
待驗證欄位必須是有效的 JSON 字串。
lt:field
待驗證欄位必須小於給定的 field。兩個欄位必須是相同的型別。字串、數字、陣列和檔案使用與 size 規則相同的慣例進行評估。
lte:field
待驗證欄位必須小於或等於給定的 field。兩個欄位必須是相同的型別。字串、數字、陣列和檔案使用與 size 規則相同的慣例進行評估。
lowercase
待驗證欄位必須是小寫。
list
待驗證欄位必須是一個作為列表 (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',
'media' => 'mimetypes:image/*,video/*',
為了確定上傳檔案的 MIME 型別,將讀取檔案內容並嘗試猜測 MIME 型別,這可能與客戶端提供的 MIME 型別不同。
mimes:foo,bar,...
待驗證的檔案必須具有與列出的擴充功能之一相對應的 MIME 型別:
'photo' => 'mimes:jpg,bmp,png'
即使您只需要指定擴充功能,此規則實際上也會透過讀取檔案內容並猜測其 MIME 型別來驗證檔案的 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'。
[!WARNING] 使用
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'。
[!WARNING] 使用
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,...
待驗證欄位必須是陣列,且必須至少包含指定的鍵。
same:field
給定的 field 必須與待驗證欄位匹配。
size:value
待驗證欄位的大小必須符合給定的 value。對於字串資料,value 對應於字元數。對於數字資料,value 對應於給定的整數值(屬性還必須具有 numeric 或 integer 規則)。對於陣列,size 對應於陣列的 count。對於檔案,size 對應於檔案大小(以 KB 為單位)。讓我們看一些範例:
// 驗證字串長度是否恰好為 12 個字元...
'title' => 'size:12';
// 驗證提供的整數是否等於 10...
'seats' => 'integer|size:10';
// 驗證陣列是否恰好有 5 個元素...
'tags' => 'array|size:5';
// 驗證上傳的檔案是否恰好為 512 KB...
'image' => 'file|size:512';
starts_with:foo,bar,...
待驗證欄位必須以給定的任何值開頭。
string
待驗證欄位必須是字串。如果您想允許該欄位也為 null,應為該欄位分配 nullable 規則。
為了方便起見,也可以使用流暢的 Rule::string() 規則構建器來構建字串驗證規則:
use Illuminate\Validation\Rule;
'title' => [
'required',
Rule::string()
->min(3)
->max(255)
->alphaDash(ascii: true),
],
字串規則構建器提供了常用字串約束的方法,包括 alpha、alphaDash、alphaNumeric、ascii、between、doesntEndWith、doesntStartWith、endsWith、exactly、lowercase、max、min、startsWith 和 uppercase。由於規則構建器是 conditionable 的,您還可以使用 when 和 unless 方法來條件式套用約束。
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:
有時,您可能希望在 unique 驗證期間忽略指定的 ID。例如,考慮一個包含使用者名稱、電子郵件地址和位置的「更新個人資料」螢幕。您可能想驗證電子郵件地址是否唯一。但是,如果使用者僅更改名稱欄位而未更改電子郵件欄位,則不希望拋出驗證錯誤,因為使用者已經是所涉電子郵件地址的所有者。
要指示驗證器忽略使用者的 ID,我們將使用 Rule 類別來流暢地定義規則。在此範例中,我們還將驗證規則指定為陣列,而不是使用 | 字元來分隔規則:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::unique('users')->ignore($user->id),
],
]);
[!WARNING] 您絕不應將任何使用者控制的請求輸入傳遞給
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 檢查中忽略軟刪除記錄:
預設情況下,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: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 陣列中時,才會對其進行驗證。
[!NOTE] 如果您嘗試驗證一個應始終存在但可能為空的欄位,請參閱 關於選填欄位的這條說明。
複雜條件式驗證
有時您可能希望根據更複雜的條件邏輯新增驗證規則。例如,您可能希望僅當另一個欄位的值大於 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;
});
[!NOTE] 傳遞給閉包的
$input參數將是Illuminate\Support\Fluent的實例,可用於存取待驗證的輸入和檔案。
複雜條件式陣列驗證
有時您可能想根據同一巢狀陣列中您不知道其索引的另一個欄位來驗證某個欄位。在這些情況下,您可以允許閉包接收第二個引數,該引數將是待驗證陣列中的當前個別項目:
$input = [
'channels' => [
[
'type' => 'email',
'address' => 'abigail @example.com',
],
[
'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 方法將傳回所有的已驗證資料,包含陣列及其所有鍵,即使這些鍵未經其他巢狀陣列驗證規則驗證。
驗證巢狀陣列輸入
驗證巢狀的基於陣列的表單輸入欄位不一定很麻煩。您可以使用「點記法」來驗證陣列中的屬性。例如,如果傳入的 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)),
],
]);
[!NOTE] 有關驗證圖片尺寸的更多資訊,可以在 dimensions 規則文件 中找到。
[!WARNING] 預設情況下,由於可能存在 XSS 漏洞,
image規則不允許 SVG 檔案。如果您需要允許 SVG 檔案,可以向image規則傳遞allowSvg: true: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)
)
[!NOTE] 有關驗證圖片尺寸的更多資訊,可以在 dimensions 規則文件 中找到。
驗證密碼
為了確保密碼具有足夠的複雜度,您可以使用 Laravel 的 Password 規則物件:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;
$validator = Validator::make($request->all(), [
'password' => ['required', 'confirmed', Password::min(8)],
]);
Password 規則物件允許您輕鬆自訂應用程式的密碼複雜度要求,例如指定密碼至少需要一個字母、數字、符號或具有混合大小寫的字元:
// 至少需要 8 個字元...
Password::min(8)
// 至少需要一個字母...
Password::min(8)->letters()
// 至少需要一個大寫和一個小寫字母...
Password::min(8)->mixedCase()
// 至少需要一個數字...
Password::min(8)->numbers()
// 至少需要一個符號...
Password::min(8)->symbols()
此外,您可以使用 uncompromised 方法確保密碼未在公共密碼資料外洩洩漏中遭到洩漏:
Password::min(8)->uncompromised()
在內部,Password 規則物件使用 k-Anonymity 模型,透過 haveibeenpwned.com 服務確定密碼是否已洩漏,而不會犧牲使用者的隱私或安全性。
預設情況下,如果密碼在資料洩漏中至少出現過一次,則將被視為已洩漏。您可以使用 uncompromised 方法的第一個引數自訂此閾值:
// 確保密碼在同一資料洩漏中出現次數少於 3 次...
Password::min(8)->uncompromised(3);
當然,您可以鏈接上面範例中的所有方法:
Password::min(8)
->letters()
->mixedCase()
->numbers()
->symbols()
->uncompromised()
定義預設密碼規則
您可能會覺得在應用程式的單個位置指定密碼的預設驗證規則很方便。您可以使用 Password::defaults 方法輕鬆實現這一點,該方法接受一個閉包。提供給 defaults 方法的閉包應傳回 Password 規則的預設配置。通常,應在應用程式其中一個服務提供者 (Service Provider) 的 boot 方法中呼叫 defaults 規則:
use Illuminate\Validation\Rules\Password;
/**
* 引導任何應用程式服務。
*/
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 目錄中。如果此目錄不存在,Laravel 將在您執行 Artisan 指令建立規則時建立它:
php artisan make:rule Uppercase
一旦規則被建立,我們就準備好定義它的行為。規則物件包含一個方法:validate。此方法接收屬性名稱、其值以及一個應在驗證失敗時調用的回呼函式,並帶有驗證錯誤訊息:
<?php
namespace App\Rules;
use Closure;
use Illuminate\Contracts\Validation\ValidationRule;
class Uppercase implements ValidationRule
{
/**
* 執行驗證規則。
*/
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],
]);
翻譯驗證訊息
您可以提供一個 翻譯字串鍵 並指示 Laravel 翻譯錯誤訊息,而不是向 $fail 閉包提供字面錯誤訊息:
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
{
/**
* 所有待驗證資料。
*
* @var array<string, mixed>
*/
protected $data = [];
// ...
/**
* 設定待驗證資料。
*
* @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
{
/**
* 驗證器實例。
*
* @var \Illuminate\Validation\Validator
*/
protected $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
[!WARNING] 一個「隱含」規則僅 暗示 屬性是必填的。是否實際讓缺失或為空的屬性無效取決於您。 ClearcutLogger: Flush already in progress, marking pending flush.