跳到内容
Laravel

验证

简介

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 变量由 Illuminate\View\Middleware\ShareErrorsFromSession 中间件（由 web 中间件组提供）与应用程序的所有视图共享。应用此中间件后，$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 目录，您可以指示 Laravel 使用 lang:publish Artisan 命令创建它。

在 lang/en/validation.php 文件中，您将找到每个验证规则的翻译条目。您可以根据应用程序的需要自由更改或修改这些消息。

此外，您可以将此文件复制到另一个语言目录，以翻译应用程序语言的消息。要了解有关 Laravel 本地化的更多信息，请查看完整的本地化文档。

exclamation

默认情况下，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',
    ];
}
lightbulb

您可以在 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 表示形式。

lightbulb

需要为您的 Inertia 驱动的 Laravel 前端添加实时表单请求验证吗？请查看 Laravel Precognition。

执行其他验证

有时您需要在初始验证完成后执行额外的验证。您可以使用表单请求的 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;
}
lightbulb

您可以在 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 外观 手动创建一个验证器实例。外观上的 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 占位符，该占位符会被替换为正在验证的字段或属性的名称。要自定义用于替换特定字段的这些占位符的值，您可以将自定义属性数组作为第四个参数传递给 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 实例可以像数组一样进行迭代和访问。

// Validated data may be iterated...
foreach ($request->safe() as $key => $value) {
    // ...
}
 
// Validated data may be accessed as an array...
$validated = $request->safe();
 
$email = $validated['email'];

如果你想向已验证的数据添加额外的字段，你可以调用 merge 方法。

$validated = $request->safe()->merge(['name' => 'Taylor Otwell']);

如果你想将已验证的数据作为 集合 实例检索，你可以调用 collect 方法。

$collection = $request->safe()->collect();

使用错误消息

在 Validator 实例上调用 errors 方法后，你将收到一个 Illuminate\Support\MessageBag 实例，它具有多种方便的方法来处理错误消息。自动提供给所有视图的 $errors 变量也是 MessageBag 类的实例。

检索字段的第一个错误消息

要检索给定字段的第一个错误消息，请使用 first 方法。

$errors = $validator->errors();
 
echo $errors->first('email');

检索字段的所有错误消息

如果你需要检索给定字段的所有消息的数组，请使用 get 方法。

foreach ($errors->get('email') as $message) {
    // ...
}

如果你正在验证一个数组表单字段，你可以使用 * 字符检索每个数组元素的所有消息。

foreach ($errors->get('attachments.*') as $message) {
    // ...
}

检索所有字段的所有错误消息

要检索所有字段的所有消息的数组，请使用 all 方法。

foreach ($errors->all() as $message) {
    // ...
}

确定字段是否存在消息

可以使用 has 方法来确定给定字段是否存在任何错误消息。

if ($errors->has('email')) {
    // ...
}

在语言文件中指定自定义消息

Laravel 的内置验证规则都有一个错误消息，该消息位于您的应用程序的 lang/en/validation.php 文件中。如果您的应用程序没有 lang 目录，您可以指示 Laravel 使用 lang:publish Artisan 命令创建它。

在 lang/en/validation.php 文件中，您将找到每个验证规则的翻译条目。您可以根据应用程序的需要自由更改或修改这些消息。

此外，您可以将此文件复制到另一个语言目录，以翻译应用程序语言的消息。要了解有关 Laravel 本地化的更多信息，请查看完整的本地化文档。

exclamation

默认情况下，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',
],
exclamation

默认情况下，Laravel 应用程序框架不包含 lang 目录。如果您想自定义 Laravel 的语言文件，您可以通过 lang:publish Artisan 命令发布它们。

在语言文件中指定值

Laravel 的一些内置验证规则错误消息包含一个 :value 占位符，该占位符会被替换为请求属性的当前值。但是，你有时可能需要验证消息的 :value 部分被替换为值的自定义表示形式。例如，考虑以下规则，该规则指定如果 payment_type 的值为 cc，则需要提供信用卡号：

Validator::make($request->all(), [
    'credit_card_number' => 'required_if:payment_type,cc'
]);

如果此验证规则失败，它将产生以下错误消息：

The credit card number field is required when payment type is cc.

你可以在 lang/xx/validation.php 语言文件中定义一个 values 数组，而不是将 cc 显示为付款类型值，你可以指定一个更友好的值表示形式。

'values' => [
    'payment_type' => [
        'cc' => 'credit card'
    ],
],
exclamation

默认情况下，Laravel 应用程序框架不包含 lang 目录。如果您想自定义 Laravel 的语言文件，您可以通过 lang:publish Artisan 命令发布它们。

在定义此值之后，验证规则将产生以下错误消息：

The credit card number field is required when payment type is credit card.

可用的验证规则

以下是所有可用验证规则及其功能的列表

接受 如果接受 活动 URL 之后（日期） 之后或等于（日期） 字母 字母破折号 字母数字 数组 ASCII 停止 之前（日期） 之前或等于（日期） 之间 布尔值 已确认 包含 当前密码 日期 日期等于 日期格式 小数 拒绝 如果拒绝 不同 数字 数字之间 尺寸（图像文件） 不同 不以开头 不以结尾 电子邮件 以结尾 枚举 排除 如果排除 除非排除 排除当 排除当不 存在（数据库） 扩展名 文件 已填充 大于 大于或等于 十六进制颜色 图像（文件） 在…中 在数组中 整数 IP 地址 JSON 小于 小于或等于 列表 小写 MAC 地址 最大值 最大位数 MIME 类型 按文件扩展名划分的 MIME 类型 最小值 最小位数 缺失 如果缺失 除非缺失 缺失当 缺失当所有 倍数 不在…中 非正则表达式 可为空 数值 存在 如果存在 除非存在 存在当 存在当所有 禁止 如果禁止 除非禁止 禁止 正则表达式 必需 如果必需 如果接受则必需 如果拒绝则必需 除非必需 当必需 当所有必需 当不必需 当所有不必需 必需的数组键 相同 大小 有时 以开头 字符串 时区 唯一（数据库） 大写 URL ULID UUID

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 记录。提供的 URL 的主机名在使用 parse_url PHP 函数提取后，会传递给 dns_get_record。

after:date

被验证的字段必须是晚于给定日期的值。日期将传递到 strtotime PHP 函数中，以便转换为有效的 DateTime 实例。

'start_date' => 'required|date|after:tomorrow'

你可以指定另一个字段来与日期进行比较，而不是传递要由 strtotime 评估的日期字符串。

'finish_date' => 'required|date|after:start_date'

after_or_equal:date

被验证的字段必须是晚于或等于给定日期的值。有关更多信息，请参阅 after 规则。

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）中的字符，你可以为验证规则提供 ascii 选项。

'username' => 'alpha_dash:ascii',

alpha_num

被验证的字段必须完全是包含在 \p{L}、 \p{M} 和 \p{N} 中的 Unicode 字母数字字符。

要将此验证规则限制为 ASCII 范围（a-z 和 A-Z）中的字符，你可以为验证规则提供 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 的值提供。

before_or_equal:date

待验证字段的值必须早于或等于给定的日期。日期会被传递给 PHP 的 strtotime 函数，以便转换为有效的 DateTime 实例。此外，与 after 规则一样，还可以将另一个待验证字段的名称作为 date 的值提供。

between:min,max

待验证字段的大小必须在给定的 min 和 max 之间（包括 min 和 max）。字符串、数值、数组和文件的评估方式与 size 规则相同。

boolean

待验证字段必须能够转换为布尔值。接受的输入为 true、false、1、0、"1" 和 "0"。

confirmed

待验证字段必须有一个匹配的 {field}_confirmation 字段。例如，如果待验证字段是 password，则输入中必须存在匹配的 password_confirmation 字段。

您还可以传递自定义的确认字段名称。例如，confirmed:repeat_username 将期望字段 repeat_username 与待验证的字段匹配。

contains:foo,bar,...

待验证字段必须是一个包含所有给定参数值的数组。

current_password

待验证字段必须与已认证用户的密码匹配。您可以使用该规则的第一个参数指定一个身份验证守卫。

'password' => 'current_password:api'

date

待验证字段必须是根据 PHP 的 strtotime 函数得出的有效、非相对日期。

date_equals:date

待验证字段的值必须等于给定的日期。日期会被传递给 PHP 的 strtotime 函数，以便转换为有效的 DateTime 实例。

date_format:format,...

待验证字段必须与给定的 format 之一匹配。验证字段时，应使用 date 或 date_format 之一，而不是同时使用两者。此验证规则支持 PHP DateTime 类支持的所有格式。

decimal:min,max

待验证字段必须是数值，并且必须包含指定的小数位数。

// Must have exactly two decimal places (9.99)...
'price' => 'decimal:2'
 
// Must have between 2 and 4 decimal places...
'price' => 'decimal:2,4'

declined

待验证字段必须是 "no"、"off"、0、"0"、false 或 "false"。

declined_if:anotherfield,value,...

如果另一个待验证字段的值等于指定的值，则待验证字段必须是 "no"、"off"、0、"0"、false 或 "false"。

different:field

待验证字段的值必须与 field 的值不同。

digits:value

待验证的整数必须具有 value 的精确长度。

digits_between:min,max

待验证的整数的长度必须在给定的 min 和 max 之间。

dimensions

待验证的文件必须是满足规则参数指定尺寸约束的图像。

'avatar' => 'dimensions:min_width=100,min_height=200'

可用的约束包括：min_width、max_width、min_height、max_height、width、height、ratio。

ratio 约束应表示为宽度除以高度。这可以通过 3/2 这样的分数或 1.5 这样的浮点数指定。

'avatar' => 'dimensions:ratio=3/2'

由于此规则需要多个参数，您可以使用 Rule::dimensions 方法来流畅地构造规则。

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
 
Validator::make($data, [
    'avatar' => [
        'required',
        Rule::dimensions()->maxWidth(1000)->maxHeight(500)->ratio(3 / 2),
    ],
]);

distinct

验证数组时，待验证字段不得包含任何重复的值。

'foo.*.id' => 'distinct'

默认情况下，Distinct 使用松散的变量比较。要使用严格比较，您可以将 strict 参数添加到您的验证规则定义中。

'foo.*.id' => 'distinct:strict'

您可以将 ignore_case 添加到验证规则的参数中，以使规则忽略大小写差异。

'foo.*.id' => 'distinct:ignore_case'

doesnt_start_with:foo,bar,...

待验证字段的值不能以给定的值之一开头。

doesnt_end_with:foo,bar,...

待验证字段的值不能以给定的值之一结尾。

email

待验证字段的值必须格式化为电子邮件地址。此验证规则利用 egulias/email-validator 包来验证电子邮件地址。默认情况下，应用 RFCValidation 验证器，但您也可以应用其他验证样式。

'email' => 'email:rfc,dns'

上面的示例将应用 RFCValidation 和 DNSCheckValidation 验证。以下是可以应用的所有验证样式的完整列表：

  • rfc: RFCValidation
  • strict: NoRFCWarningsValidation
  • dns: DNSCheckValidation
  • spoof: SpoofCheckValidation
  • filter: FilterEmailValidation
  • filter_unicode: FilterEmailValidation::unicode()

使用 PHP 的 filter_var 函数的 filter 验证器随 Laravel 一起提供，并且是 Laravel 5.8 版本之前 Laravel 的默认电子邮件验证行为。

exclamation

dns 和 spoof 验证器需要 PHP intl 扩展。

ends_with:foo,bar,...

待验证字段的值必须以给定的值之一结尾。

enum

Enum 规则是一个基于类的规则，用于验证待验证字段是否包含有效的枚举值。Enum 规则接受枚举的名称作为其唯一的构造函数参数。验证原始值时，应将后备枚举提供给 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'),

extensions:foo,bar,...

待验证的文件必须具有与列出的扩展名之一对应的用户分配的扩展名。

'photo' => ['required', 'extensions:jpg,png'],
exclamation

您不应仅仅依靠其用户分配的扩展名来验证文件。此规则通常应始终与 mimes 或 mimetypes 规则结合使用。

file

待验证字段必须是成功上传的文件。

filled

当待验证字段存在时，它不能为空。

gt:field

待验证字段的值必须大于给定的 field 或 value。这两个字段必须具有相同的类型。字符串、数值、数组和文件的评估方式与 size 规则相同。

gte:field

待验证字段的值必须大于或等于给定的 field 或 value。这两个字段必须具有相同的类型。字符串、数值、数组和文件的评估方式与 size 规则相同。

hex_color

待验证字段必须包含 十六进制 格式的有效颜色值。

image

待验证的文件必须是图像 (jpg, jpeg, png, bmp, gif, svg 或 webp)。

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 的值中。

integer

待验证字段的值必须是整数。

exclamation

此验证规则不会验证输入是否为“整数”变量类型，仅验证输入是否为 PHP 的 FILTER_VALIDATE_INT 规则接受的类型。如果您需要验证输入是否为数字，请将此规则与 numeric 验证规则结合使用。

ip

待验证字段的值必须是 IP 地址。

ipv4

待验证字段的值必须是 IPv4 地址。

ipv6

待验证字段的值必须是 IPv6 地址。

json

待验证字段的值必须是有效的 JSON 字符串。

lt:field

待验证字段的值必须小于给定的 field。这两个字段必须具有相同的类型。字符串、数值、数组和文件的评估方式与 size 规则相同。

lte:field

被验证的字段必须小于或等于给定的字段。两个字段必须是相同类型。字符串、数字、数组和文件的评估方式与 size 规则相同。

小写

被验证的字段必须是小写。

列表

被验证的字段必须是一个数组，且是一个列表。如果一个数组的键由从 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'。

exclamation

当使用 regex / not_regex 模式时，可能需要使用数组而不是使用 | 分隔符来指定验证规则，特别是当正则表达式包含 | 字符时。

nullable

被验证的字段可以为 null。

numeric

被验证的字段必须是数字。

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_unless:anotherfield,value,...

除非 anotherfield 字段等于任何 value，否则被验证的字段必须缺失或为空。如果一个字段满足以下条件之一，则该字段为“空”：

  • 该值为 null。
  • 该值为空字符串。
  • 该值为空数组或空的 Countable 对象。
  • 该值是路径为空的上传文件。

prohibits:anotherfield,...

如果被验证的字段不缺失或不为空，则 anotherfield 中的所有字段都必须缺失或为空。如果一个字段满足以下条件之一，则该字段为“空”：

  • 该值为 null。
  • 该值为空字符串。
  • 该值为空数组或空的 Countable 对象。
  • 该值是路径为空的上传文件。

regex:pattern

被验证的字段必须与给定的正则表达式匹配。

在内部，此规则使用 PHP 的 preg_match 函数。指定的模式应遵循 preg_match 所需的相同格式，因此也应包含有效的分隔符。例如：'email' => 'regex:/^.+@.+$/i'。

exclamation

当使用 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 对应于文件大小（以千字节为单位）。让我们看一些例子：

// Validate that a string is exactly 12 characters long...
'title' => 'size:12';
 
// Validate that a provided integer equals 10...
'seats' => 'integer|size:10';
 
// Validate that an array has exactly 5 elements...
'tags' => 'array|size:5';
 
// Validate that an uploaded file is exactly 512 kilobytes...
'image' => 'file|size:512';

starts_with:foo,bar,...

被验证的字段必须以给定的值之一开头。

string

被验证的字段必须是字符串。如果希望允许该字段也为 null，则应将 nullable 规则分配给该字段。

timezone

被验证的字段必须是根据 DateTimeZone::listIdentifiers 方法的有效时区标识符。

也可以向此验证规则提供 DateTimeZone::listIdentifiers 方法接受的参数。

'timezone' => 'required|timezone:all';
 
'timezone' => 'required|timezone:Africa';
 
'timezone' => 'required|timezone:per_country,US';

unique:table,column

被验证的字段不得存在于给定的数据库表中。

指定自定义表/列名

您可以指定应该用于确定表名称的 Eloquent 模型，而不是直接指定表名称。

'email' => 'unique:App\Models\User,email_address'

可以使用 column 选项指定字段对应的数据库列。如果未指定 column 选项，将使用被验证字段的名称。

'email' => 'unique:users,email_address'

指定自定义数据库连接

有时，你可能需要为 Validator 执行的数据库查询设置自定义连接。为此，你可以将连接名称前置到表名称：

'email' => 'unique:connection.users,email_address'

强制唯一规则忽略给定 ID

有时，你可能希望在唯一性验证期间忽略给定的 ID。例如，考虑一个包含用户姓名、电子邮件地址和位置的“更新个人资料”屏幕。你可能需要验证电子邮件地址的唯一性。但是，如果用户仅更改姓名字段而不是电子邮件字段，则不希望抛出验证错误，因为用户已经是相关电子邮件地址的所有者。

要指示验证器忽略用户的 ID，我们将使用 Rule 类以流畅的方式定义规则。在此示例中，我们还将验证规则指定为数组，而不是使用 | 字符来分隔规则：

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
 
Validator::make($data, [
    'email' => [
        'required',
        Rule::unique('users')->ignore($user->id),
    ],
]);
exclamation

你永远不应将任何用户控制的请求输入传递到 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))

uppercase

正在验证的字段必须为大写。

url

正在验证的字段必须是有效的 URL。

如果您想指定应被视为有效的 URL 协议，可以将这些协议作为验证规则参数传递。

'url' => 'url:http,https',
 
'game' => 'url:minecraft,steam',

ulid

正在验证的字段必须是有效的 Universally Unique Lexicographically Sortable Identifier (ULID)。

uuid

正在验证的字段必须是有效的 RFC 4122（版本 1、3、4 或 5）通用唯一标识符 (UUID)。

有条件地添加规则

当字段具有特定值时跳过验证

有时，您可能希望在另一个字段具有给定值时不验证给定的字段。您可以使用 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 数组中时才会对其进行验证。

lightbulb

如果您正在尝试验证一个应该始终存在但可能为空的字段，请查看关于可选字段的说明。

复杂的条件验证

有时您可能希望根据更复杂的条件逻辑添加验证规则。例如，您可能希望仅在另一个字段的值大于 100 时才需要某个字段。或者，您可能需要在另一个字段存在时，两个字段都具有给定的值。添加这些验证规则不必很麻烦。首先，使用您的永不更改的 *静态规则* 创建一个 Validator 实例。

use Illuminate\Support\Facades\Validator;
 
$validator = Validator::make($request->all(), [
    'email' => 'required|email',
    'games' => 'required|numeric',
]);

假设我们的 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;
});
lightbulb

传递给闭包的 $input 参数将是 Illuminate\Support\Fluent 的实例，可用于访问正在验证的输入和文件。

复杂的条件数组验证

有时，您可能想根据同一嵌套数组中您不知道索引的另一个字段来验证一个字段。在这些情况下，您可以允许您的闭包接收第二个参数，该参数将是正在验证的数组中当前的单个项目。

$input = [
    'channels' => [
        [
            'type' => 'email',
            'address' => '[email protected]',
        ],
        [
            'type' => 'url',
            'address' => 'https://example.com',
        ],
    ],
];
 
$validator->sometimes('channels.*.address', 'email', function (Fluent $input, Fluent $item) {
    return $item->type === 'email';
});
 
$validator->sometimes('channels.*.address', 'url', function (Fluent $input, Fluent $item) {
    return $item->type !== 'email';
});

与传递给闭包的 $input 参数类似，当属性数据为数组时，$item 参数是 Illuminate\Support\Fluent 的实例；否则，它是一个字符串。

验证数组

正如 array 验证规则文档 中所述，array 规则接受允许的数组键的列表。如果数组中存在任何其他键，则验证将失败。

use Illuminate\Support\Facades\Validator;
 
$input = [
    'user' => [
        'name' => 'Taylor Otwell',
        'username' => 'taylorotwell',
        'admin' => true,
    ],
];
 
Validator::make($input, [
    'user' => 'array:name,username',
]);

通常，您应该始终指定允许出现在数组中的数组键。否则，验证器的 validate 和 validated 方法将返回所有验证的数据，包括数组及其所有键，即使这些键没有被其他嵌套数组验证规则验证。

验证嵌套数组输入

验证基于嵌套数组的表单输入字段不必很麻烦。您可以使用“点表示法”来验证数组中的属性。例如，如果传入的 HTTP 请求包含 photos[profile] 字段，您可以像这样验证它：

use Illuminate\Support\Facades\Validator;
 
$validator = Validator::make($request->all(), [
    'photos.profile' => 'required|image',
]);

您还可以验证数组的每个元素。例如，要验证给定数组输入字段中的每个电子邮件都是唯一的，您可以执行以下操作：

$validator = Validator::make($request->all(), [
    'person.*.email' => 'email|unique:users',
    'person.*.first_name' => 'required_with:person.*.last_name',
]);

同样，您可以在 语言文件中指定自定义验证消息时使用 * 字符，这使得为基于数组的字段使用单个验证消息变得非常容易。

'custom' => [
    'person.*.email' => [
        'unique' => 'Each person 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.',
]);

给定上面的示例，验证将失败，并且用户将看到以下错误消息：“请描述照片 #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),
    ],
]);

如果您的应用程序接受用户上传的图像，您可以使用 File 规则的 image 构造方法来指示上传的文件应该是图像。此外，可以使用 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)),
    ],
]);
lightbulb

有关验证图像尺寸的更多信息，请参阅尺寸规则文档。

文件大小

为了方便起见，最小和最大文件大小可以指定为带有后缀的字符串，该后缀指示文件大小单位。支持 kb、mb、gb 和 tb 后缀。

File::image()
    ->min('1kb')
    ->max('10mb')

文件类型

即使您在调用 types 方法时只需要指定扩展名，但此方法实际上通过读取文件的内容并猜测其 MIME 类型来验证文件的 MIME 类型。可以在以下位置找到 MIME 类型及其相应扩展名的完整列表：

https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types

验证密码

为了确保密码具有足够的复杂性，您可以使用 Laravel 的 Password 规则对象。

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;
 
$validator = Validator::make($request->all(), [
    'password' => ['required', 'confirmed', Password::min(8)],
]);

Password 规则对象允许您轻松自定义应用程序的密码复杂性要求，例如指定密码至少需要一个字母、数字、符号或大小写混合的字符。

// Require at least 8 characters...
Password::min(8)
 
// Require at least one letter...
Password::min(8)->letters()
 
// Require at least one uppercase and one lowercase letter...
Password::min(8)->mixedCase()
 
// Require at least one number...
Password::min(8)->numbers()
 
// Require at least one symbol...
Password::min(8)->symbols()

此外，您可以使用 uncompromised 方法确保密码没有在公共密码数据泄露中泄露。

Password::min(8)->uncompromised()

在内部，Password 规则对象使用 k-匿名模型通过 haveibeenpwned.com 服务来确定密码是否已泄露，而不会牺牲用户的隐私或安全性。

默认情况下，如果密码在数据泄露中至少出现一次，则会被视为已泄露。您可以使用 uncompromised 方法的第一个参数自定义此阈值。

// Ensure the password appears less than 3 times in the same data leak...
Password::min(8)->uncompromised(3);

当然，您可以链接上面示例中的所有方法。

Password::min(8)
    ->letters()
    ->mixedCase()
    ->numbers()
    ->symbols()
    ->uncompromised()

定义默认密码规则

您可能会发现在应用程序的单个位置指定密码的默认验证规则很方便。您可以使用接受闭包的 Password::defaults 方法轻松实现此目的。传递给 defaults 方法的闭包应返回密码规则的默认配置。通常，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 目录中。如果此目录不存在，Laravel 将在您执行 Artisan 命令创建规则时创建它。

php artisan make:rule Uppercase

创建规则后，我们就可以定义其行为。规则对象包含一个方法：validate。此方法接收属性名称、其值以及一个回调，如果验证失败，应使用验证错误消息调用该回调。

<?php
 
namespace App\Rules;
 
use Closure;
use Illuminate\Contracts\Validation\ValidationRule;
 
class Uppercase implements ValidationRule
{
    /**
     * Run the validation rule.
     */
    public function validate(string $attribute, mixed $value, Closure $fail): void
    {
        if (strtoupper($value) !== $value) {
            $fail('The :attribute must be uppercase.');
        }
    }
}

定义规则后，您可以通过将规则对象的实例与您的其他验证规则一起传递来将其附加到验证器。

use App\Rules\Uppercase;
 
$request->validate([
    'name' => ['required', 'string', new Uppercase],
]);

翻译验证消息

除了向 $fail 闭包提供字面错误消息外，您还可以提供 翻译字符串键并指示 Laravel 翻译错误消息。

if (strtoupper($value) !== $value) {
    $fail('validation.uppercase')->translate();
}

如有必要，您可以将占位符替换和首选语言作为 translate 方法的第一个和第二个参数提供。

$fail('validation.location')->translate([
    'value' => $this->value,
], 'fr')

访问其他数据

如果您的自定义验证规则类需要访问正在验证的所有其他数据，则您的规则类可以实现 Illuminate\Contracts\Validation\DataAwareRule 接口。此接口要求您的类定义一个 setData 方法。Laravel 将使用正在验证的所有数据自动调用此方法（在验证开始之前）。

<?php
 
namespace App\Rules;
 
use Illuminate\Contracts\Validation\DataAwareRule;
use Illuminate\Contracts\Validation\ValidationRule;
 
class Uppercase implements DataAwareRule, ValidationRule
{
    /**
     * All of the data under validation.
     *
     * @var array<string, mixed>
     */
    protected $data = [];
 
    // ...
 
    /**
     * Set the data under validation.
     *
     * @param  array<string, mixed>  $data
     */
    public function setData(array $data): static
    {
        $this->data = $data;
 
        return $this;
    }
}

或者，如果您的验证规则需要访问执行验证的验证器实例，您可以实现 ValidatorAwareRule 接口。

<?php
 
namespace App\Rules;
 
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Contracts\Validation\ValidatorAwareRule;
use Illuminate\Validation\Validator;
 
class Uppercase implements ValidationRule, ValidatorAwareRule
{
    /**
     * The validator instance.
     *
     * @var \Illuminate\Validation\Validator
     */
    protected $validator;
 
    // ...
 
    /**
     * Set the current validator.
     */
    public function setValidator(Validator $validator): static
    {
        $this->validator = $validator;
 
        return $this;
    }
}

使用闭包

如果你只需要在整个应用程序中使用一次自定义规则的功能，你可以使用闭包而不是规则对象。闭包接收属性的名称、属性的值以及一个 $fail 回调函数，如果验证失败，则应调用此回调函数。

use Illuminate\Support\Facades\Validator;
use Closure;
 
$validator = Validator::make($request->all(), [
    'title' => [
        'required',
        'max:255',
        function (string $attribute, mixed $value, Closure $fail) {
            if ($value === 'foo') {
                $fail("The {$attribute} is invalid.");
            }
        },
    ],
]);

隐式规则

默认情况下，当要验证的属性不存在或包含空字符串时，不会运行包括自定义规则在内的常规验证规则。例如，unique 规则不会针对空字符串运行。

use Illuminate\Support\Facades\Validator;
 
$rules = ['name' => 'unique:users,name'];
 
$input = ['name' => ''];
 
Validator::make($input, $rules)->passes(); // true

为了使自定义规则即使在属性为空时也运行，该规则必须暗示该属性是必需的。要快速生成新的隐式规则对象，你可以使用带有 --implicit 选项的 make:rule Artisan 命令。

php artisan make:rule Uppercase --implicit
exclamation

一个“隐式”规则只是暗示该属性是必需的。是否实际使缺失或空属性无效取决于你。