验证
引言
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 会自动将用户重定向回其先前的位置。此外,所有验证错误和 请求输入 都将自动 闪存到会话 中。
$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 本地化的更多信息,请查看完整的 本地化文档。
lang 目录。如果您想自定义 Laravel 的语言文件,可以通过 lang:publish Artisan 命令发布它们。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 由于验证错误而生成重定向响应时,框架会自动 将请求的所有输入闪存到会话 中。这样做是为了方便您在下一个请求期间访问输入并重新填充用户试图提交的表单。
要从上一个请求中检索闪存的输入,请在 Illuminate\Http\Request 实例上调用 old 方法。old 方法将从 会话 中拉取先前闪存的输入数据:
$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."
]
}
}
表单请求验证
创建表单请求
对于更复杂的验证场景,您可能希望创建一个“表单请求”。表单请求是封装自己的验证和授权逻辑的自定义请求类。要创建表单请求类,您可以使用 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');
}
如果验证失败,将生成一个重定向响应,将用户送回其先前的位置。错误也将闪存到会话中,以便可以显示。如果请求是 XHR 请求,则会返回一个状态码为 422 的 HTTP 响应,其中包含 验证错误的 JSON 表示。
执行额外验证
有时您需要在初始验证完成后执行额外验证。您可以使用表单请求的 after 方法来实现此目的。
after 方法应返回一个可调用对象或闭包数组,这些对象或闭包将在验证完成后被调用。给定的可调用对象将接收一个 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 方法。在此方法中,您可以确定当前经过身份验证的用户是否确实有权更新给定资源。例如,您可以确定用户是否确实拥有他们试图更新的博客评论。最有可能的是,您将在该方法中与 授权门和策略 进行交互:
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 方法将错误消息闪存到会话中。当使用此方法时,$errors 变量将在重定向后自动与您的视图共享,让您可以轻松地将它们显示给用户。withErrors 方法接受一个验证器、一个 MessageBag 或一个 PHP 数组。
在第一次验证失败时停止
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 占位符,该占位符被正在验证的字段或属性的名称替换。如果您希望验证消息的 :attribute 部分被自定义值替换,您可以在 lang/xx/validation.php 语言文件中的 attributes 数组中指定自定义属性名称:
'attributes' => [
'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']);
如果您想将已验证的数据作为 集合 实例检索,您可以调用 collect 方法:
$collection = $request->safe()->collect();
处理错误消息
在验证器实例上调用 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 本地化的更多信息,请查看完整的 本地化文档。
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',
],
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'
],
],
lang 目录。如果您想自定义 Laravel 的语言文件,可以通过 lang:publish Artisan 命令发布它们。在定义此值后,验证规则将产生以下错误消息:
The credit card number field is required when payment type is credit card.
可用验证规则
以下是所有可用验证规则及其功能的列表:
布尔值
AcceptedAccepted IfBooleanDeclinedDeclined If
字符串
Active URLAlphaAlpha DashAlpha NumericAsciiConfirmedCurrent PasswordDifferentDoesnt Start WithDoesnt End WithEmailEnds WithEnumHex ColorInIP AddressJSONLowercaseMAC AddressMaxMinNot InRegular ExpressionNot Regular ExpressionSameSizeStarts WithStringUppercaseURLULIDUUID
数字
BetweenDecimalDifferentDigitsDigits BetweenGreater ThanGreater Than Or EqualIntegerLess ThanLess Than Or EqualMaxMax DigitsMinMin DigitsMultiple OfNumericSameSize
数组
ArrayBetweenContainsDoesnt ContainDistinctIn ArrayIn Array KeysListMaxMinSize
日期
AfterAfter Or EqualBeforeBefore Or EqualDateDate EqualsDate FormatDifferentTimezone
文件
BetweenDimensionsExtensionsFileImageMaxMIME TypesMIME Type By File ExtensionSize
数据库
ExistsUnique
实用工具
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
根据 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
被验证的字段必须完全是 Unicode 字母字符,包含在 \p{L} 和 \p{M} 中。
要将此验证规则限制为 ASCII 范围内的字符(a-z 和 A-Z),您可以为验证规则提供 ascii 选项:
'username' => 'alpha:ascii',
alpha_dash
被验证的字段必须完全是 Unicode 字母数字字符,包含在 \p{L}、\p{M}、\p{N} 中,以及 ASCII 破折号(-)和 ASCII 下划线(_)。
要将此验证规则限制为 ASCII 范围内的字符(a-z、A-Z 和 0-9),您可以为验证规则提供 ascii 选项:
'username' => 'alpha_dash:ascii',
alpha_num
被验证的字段必须完全是 Unicode 字母数字字符,包含在 \p{L}、\p{M} 和 \p{N} 中。
要将此验证规则限制为 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
被验证的字段必须与经过身份验证的用户的密码匹配。您可以使用规则的第一个参数指定身份验证守卫:
'password' => 'current_password:api'
date
根据 strtotime PHP 函数,被验证的字段必须是有效的、非相对的日期。
date_equals:date
被验证的字段必须等于给定日期。日期将被传递到 PHP strtotime 函数中,以便转换为有效的 DateTime 实例。
date_format:format,...
被验证的字段必须匹配给定的格式之一。您应该使用 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()
],
]);
dns和spoof验证器需要 PHPintl扩展。
ends_with:foo,bar,...
被验证的字段必须以给定的值之一结尾。
enum
Enum 规则是一个基于类的规则,用于验证被验证的字段是否包含有效的枚举值。Enum 规则接受枚举的名称作为其唯一的构造函数参数。在验证原始值时,应向 Enum 规则提供一个 backed Enum:
use App\Enums\ServerStatus;
use Illuminate\Validation\Rule;
$request->validate([
'status' => [Rule::enum(ServerStatus::class)],
]);
Enum 规则的 only 和 except 方法可用于限制应被视为有效的枚举情况:
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'],
您不应该仅仅依靠通过其用户分配的扩展名来验证文件。此规则通常应始终与
mimes或mimetypes规则结合使用。
file
被验证的字段必须是成功上传的文件。
filled
被验证的字段如果存在则不得为空。
gt:field
被验证的字段必须大于给定的 field 或 value。这两个字段必须是相同的类型。字符串、数字、数组和文件的评估方式与 size 规则相同。
gte:field
被验证的字段必须大于或等于给定的 field 或 value。这两个字段必须是相同的类型。字符串、数字、数组和文件的评估方式与 size 规则相同。
hex_color
被验证的字段必须包含有效的十六进制格式颜色值。
image
被验证的文件必须是图像(jpg、jpeg、png、bmp、gif 或 webp)。
默认情况下,由于可能存在 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.*
被验证的字段必须是一个数组,并且在该数组中至少包含一个给定 value 作为键:
'config' => 'array|in_array_keys:timezone'
integer
被验证的字段必须是整数。
您可以使用 strict 参数来仅当其类型为 integer 时才将字段视为有效。具有整数值的字符串将被视为无效:
'age' => 'integer:strict'
此验证规则不验证输入是否是“integer”变量类型,只验证输入是否是 PHP 的
FILTER_VALIDATE_INT规则接受的类型。如果您需要验证输入是否为数字,请将此规则与numeric验证规则结合使用。
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 类型。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,否则被验证的字段必须存在且不为空。这也意味着 anotherfield 必须存在于请求数据中,除非 value 是 null。如果 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 对应于以千字节为单位的文件大小。让我们看一些例子:
// 验证一个字符串正好有 12 个字符...
'title' => 'size:12';
// 验证提供的整数等于 10...
'seats' => 'integer|size:10';
// 验证一个数组正好有 5 个元素...
'tags' => 'array|size:5';
// 验证上传的文件正好是 512 千字节...
'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 时才要求一个给定字段。或者,您可能需要两个字段具有给定值,仅当另一个字段存在时。添加这些验证规则不一定很麻烦。首先,使用您的静态规则创建一个 Validator 实例,这些规则永不改变:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'email' => 'required|email',
'games' => 'required|integer|min:0',
]);
假设我们的 Web 应用程序是为游戏收藏家准备的。如果一个游戏收藏家在我们的应用程序中注册,并且他们拥有超过 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' => '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 规则接受一个允许的数组键列表。如果数组中存在任何额外的键,验证将失败:
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 开始)占位符:
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.”(请描述照片 #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)),
],
]);
image 规则不允许 SVG 文件。如果您需要允许 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)
)
验证密码
为了确保密码具有足够的复杂性,您可以使用 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-匿名 模型来确定密码是否通过 haveibeenpwned.com 服务泄露,而不会牺牲用户的隐私或安全。
默认情况下,如果一个密码在数据泄露中至少出现一次,它将被视为已泄露。您可以使用 uncompromised 方法的第一个参数来自定义此阈值:
// 确保密码在同一数据泄露中出现的次数少于 3 次...
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
为了使自定义规则即使在属性为空时也运行,该规则必须暗示该属性是必需的。要快速生成新的隐式规则对象,您可以使用 make:rule Artisan 命令并附带 --implicit 选项:
php artisan make:rule Uppercase --implicit