Skip to content

验证

简介

Laravel 提供了几种不同的方法来验证应用程序的传入数据。最常见的是使用所有传入 HTTP 请求上可用的 validate 方法。但是,我们也将讨论其他验证方法。

Laravel 包含各种方便的验证规则,您可以将其应用于数据,甚至提供验证值在给定数据库表中是否唯一的能力。我们将详细介绍每个验证规则,以便您熟悉 Laravel 的所有验证功能。

验证快速入门

要了解 Laravel 强大的验证功能,让我们看一个验证表单并向用户显示错误消息的完整示例。通过阅读此高级概述,您将能够很好地了解如何使用 Laravel 验证传入请求数据:

定义路由

首先,假设我们在 routes/web.php 文件中定义了以下路由:

php
use App\Http\Controllers\PostController;

Route::get('/post/create', [PostController::class, 'create']);
Route::post('/post', [PostController::class, 'store']);

GET 路由将显示一个表单供用户创建新博客文章,而 POST 路由将在数据库中存储新博客文章。

创建控制器

接下来,让我们看一个处理这些路由传入请求的简单控制器。我们暂时将 store 方法留空:

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\View\View;

class PostController extends Controller
{
    /**
     * 显示创建博客文章的表单。
     */
    public function create(): View
    {
        return view('post.create');
    }

    /**
     * 存储新博客文章。
     */
    public function store(Request $request): RedirectResponse
    {
        // 验证并存储博客文章...

        $post = /** ... */

        return to_route('post.show', ['post' => $post->id]);
    }
}

编写验证逻辑

现在我们准备用验证新博客文章的逻辑填充 store 方法。为此,我们将使用 Illuminate\Http\Request 对象提供的 validate 方法。如果验证规则通过,您的代码将继续正常执行;但是,如果验证失败,将抛出 Illuminate\Validation\ValidationException 异常,并将正确的错误响应自动发送回用户。

如果在传统 HTTP 请求期间验证失败,将生成重定向响应到上一个 URL。如果传入请求是 XHR 请求,将返回包含验证错误消息的 JSON 响应

为了更好地理解 validate 方法,让我们回到 store 方法:

php
/**
 * 存储新博客文章。
 */
public function store(Request $request): RedirectResponse
{
    $validated = $request->validate([
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ]);

    // 博客文章有效...

    return redirect('/posts');
}

如您所见,验证规则被传递给 validate 方法。不用担心 - 所有可用的验证规则都已记录。同样,如果验证失败,将自动生成正确的响应。如果验证通过,我们的控制器将继续正常执行。

或者,验证规则可以指定为规则数组,而不是单个 | 分隔字符串:

php
$validatedData = $request->validate([
    'title' => ['required', 'unique:posts', 'max:255'],
    'body' => ['required'],
]);

此外,您可以使用 validateWithBag 方法验证请求并将任何错误消息存储在命名错误包中:

php
$validatedData = $request->validateWithBag('post', [
    'title' => ['required', 'unique:posts', 'max:255'],
    'body' => ['required'],
]);

在第一次验证失败时停止

有时您可能希望在第一次验证失败后停止对属性运行验证规则。为此,请将 bail 规则分配给属性:

php
$request->validate([
    'title' => 'bail|required|unique:posts|max:255',
    'body' => 'required',
]);

在此示例中,如果 title 属性上的 unique 规则失败,则不会检查 max 规则。规则将按分配顺序进行验证。

关于嵌套属性的说明

如果传入 HTTP 请求包含「嵌套」字段数据,您可以使用「点」语法在验证规则中指定这些字段:

php
$request->validate([
    'title' => 'required|unique:posts|max:255',
    'author.name' => 'required',
    'author.description' => 'required',
]);

另一方面,如果您的字段名包含字面句点,您可以通过使用反斜杠转义句点来明确防止将其解释为「点」语法:

php
$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 方法,允许我们在视图中显示错误消息:

blade
<!-- /resources/views/post/create.blade.php -->

<h1>创建文章</h1>

@if ($errors->any())
    <div class="alert alert-danger">
        <ul>
            @foreach ($errors->all() as $error)
                <li>{{ $error }}</li>
            @endforeach
        </ul>
    </div>
@endif

<!-- 创建文章表单 -->

自定义错误消息

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

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

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

WARNING

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

XHR 请求和验证

在此示例中,我们使用传统表单将数据发送到应用程序。但是,许多应用程序从 JavaScript 驱动的前端接收 XHR 请求。在 XHR 请求期间使用 validate 方法时,Laravel 不会生成重定向响应。相反,Laravel 生成包含所有验证错误的 JSON 响应。此 JSON 响应将使用 422 HTTP 状态码发送。

@error 指令

您可以使用 @error Blade 指令快速确定给定属性是否存在验证错误消息。在 @error 指令中,您可以回显 $message 变量以显示错误消息:

blade
<!-- /resources/views/post/create.blade.php -->

<label for="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 指令:

blade
<input ... class="@error('title', 'post') is-invalid @enderror">

重新填充表单

当 Laravel 由于验证错误生成重定向响应时,框架将自动将所有请求输入闪存到会话。这样做是为了让您可以在下一个请求期间方便地访问输入并重新填充用户尝试提交的表单。

要从上一个请求检索闪存的输入,请在 Illuminate\Http\Request 实例上调用 old 方法。old 方法将从会话中提取以前闪存的输入数据:

php
$title = $request->old('title');

Laravel 还提供全局 old 辅助函数。如果您在 Blade 模板中显示旧输入,使用 old 辅助函数重新填充表单更方便。如果给定字段不存在旧输入,将返回 null

blade
<input type="text" name="title" value="{{ old('title') }}">

关于可选字段的说明

默认情况下,Laravel 在应用程序的全局中间件堆栈中包含 TrimStringsConvertEmptyStringsToNull 中间件。因此,如果您不希望验证器将 null 值视为无效,通常需要将「可选」请求字段标记为 nullable。例如:

php
$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 响应格式示例。请注意,嵌套错误键被扁平化为「点」符号格式:

json
{
    "message": "团队名称必须是字符串。(还有 4 个错误)",
    "errors": {
        "team_name": [
            "团队名称必须是字符串。",
            "团队名称必须至少为 1 个字符。"
        ],
        "authorization.role": [
            "选择的 authorization.role 无效。"
        ],
        "users.0.email": [
            "users.0.email 字段是必填的。"
        ],
        "users.2.email": [
            "users.2.email 必须是有效的电子邮件地址。"
        ]
    }
}

表单请求验证

创建表单请求

对于更复杂的验证场景,您可能希望创建「表单请求」。表单请求是自定义请求类,封装了自己的验证和授权逻辑。要创建表单请求类,可以使用 make:request Artisan CLI 命令:

shell
php artisan make:request StorePostRequest

生成的表单请求类将放置在 app/Http/Requests 目录中。如果此目录不存在,将在运行 make:request 命令时创建。Laravel 生成的每个表单请求都有两个方法:authorizerules

如您所料,authorize 方法负责确定当前经过身份验证的用户是否可以执行请求表示的操作,而 rules 方法返回应用于请求数据的验证规则:

php
/**
 * 获取应用于请求的验证规则。
 *
 * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
 */
public function rules(): array
{
    return [
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ];
}

NOTE

您可以在 rules 方法的签名中类型提示您需要的任何依赖项。它们将通过 Laravel 服务容器自动解析。

那么,验证规则是如何评估的?您只需要在控制器方法上类型提示请求。传入表单请求在控制器方法被调用之前进行验证,这意味着您不需要用任何验证逻辑使控制器混乱:

php
/**
 * 存储新博客文章。
 */
public function store(StorePostRequest $request): RedirectResponse
{
    // 传入请求有效...

    // 检索已验证的输入数据...
    $validated = $request->validated();

    // 检索部分已验证的输入数据...
    $validated = $request->safe()->only(['name', 'email']);
    $validated = $request->safe()->except(['name', 'email']);

    // 存储博客文章...

    return redirect('/posts');
}

如果验证失败,将生成重定向响应以将用户发送回其上一个位置。错误也将闪存到会话,以便它们可用于显示。如果请求是 XHR 请求,将向用户返回包含验证错误的 JSON 表示的 HTTP 响应,状态码为 422。

NOTE

需要向 Inertia 驱动的 Laravel 前端添加实时表单请求验证?请查看 Laravel Precognition

执行额外验证

有时您需要在初始验证完成后执行额外验证。您可以使用表单请求的 after 方法完成此操作。

after 方法应返回一个可调用对象或闭包数组,它们将在验证完成后调用。给定的可调用对象将接收 Illuminate\Validation\Validator 实例,允许您在必要时引发额外的错误消息:

php
use Illuminate\Validation\Validator;

/**
 * 获取请求的「after」验证可调用对象。
 */
public function after(): array
{
    return [
        function (Validator $validator) {
            if ($this->somethingElseIsInvalid()) {
                $validator->errors()->add(
                    'field',
                    '此字段有问题!'
                );
            }
        }
    ];
}

如前所述,after 方法返回的数组也可以包含可调用类。这些类的 __invoke 方法将接收 Illuminate\Validation\Validator 实例:

php
use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
use Illuminate\Validation\Validator;

/**
 * 获取请求的「after」验证可调用对象。
 */
public function after(): array
{
    return [
        new ValidateUserStatus,
        new ValidateShippingTime,
        function (Validator $validator) {
            //
        }
    ];
}

在第一次验证失败时停止

通过向请求类添加 StopOnFirstFailure 属性,您可以通知验证器在发生单个验证失败后停止验证所有属性:

php
<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\Attributes\StopOnFirstFailure;
use Illuminate\Foundation\Http\FormRequest;

#[StopOnFirstFailure]
class StorePostRequest extends FormRequest
{
    // ...
}

自定义重定向位置

当表单请求验证失败时,将生成重定向响应以将用户发送回其上一个位置。但是,您可以自由自定义此行为。为此,您可以在表单请求上使用 RedirectTo 属性:

php
<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\Attributes\RedirectTo;
use Illuminate\Foundation\Http\FormRequest;

#[RedirectTo('/dashboard')]
class StorePostRequest extends FormRequest
{
    // ...
}

或者,如果您想将用户重定向到命名路由,可以改用 RedirectToRoute 属性:

php
<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\Attributes\RedirectToRoute;
use Illuminate\Foundation\Http\FormRequest;

#[RedirectToRoute('dashboard')]
class StorePostRequest extends FormRequest
{
    // ...
}

自定义错误包

如果您希望将请求的错误消息存储在命名错误包中,您可以在类上定义 $errorBag 属性:

php
<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class StorePostRequest extends FormRequest
{
    /**
     * 错误消息应存储在其中的错误包。
     *
     * @var string
     */
    protected $errorBag = 'post';

    // ...
}

授权表单请求

表单请求类还包含 authorize 方法。在此方法中,您可以确定经过身份验证的用户是否真正有权更新给定资源。例如,您可以确定用户是否真正拥有他们试图更新的博客评论:

php
use App\Models\Comment;

/**
 * 确定用户是否有权提出此请求。
 */
public function authorize(): bool
{
    $comment = Comment::find($this->route('comment'));

    return $comment && $this->user()->can('update', $comment);
}

由于上面的示例中我们正在调用路由模型绑定上的方法(Comment::find($this->route('comment')),我们应该将 {comment} 参数重命名为 {comment_id}

php
Route::post('/comment/{comment_id}');

由于 authorize 方法已经解析为布尔值,您可以返回 truefalse。如果该方法返回 false,将自动返回具有 403 状态码的 HTTP 响应,并且您的控制器方法将不会执行。

如果您计划在应用程序的其他地方处理授权逻辑,只需从 authorize 方法返回 true

php
/**
 * 确定用户是否有权提出此请求。
 */
public function authorize(): bool
{
    return true;
}

NOTE

您可以在 authorize 方法的签名中类型提示任何依赖项。它们将通过 Laravel 服务容器自动解析。

自定义错误消息

您可以通过重写 messages 方法来自定义表单请求使用的错误消息。此方法应返回属性/规则对及其对应错误消息的数组:

php
/**
 * 获取已定义验证规则的错误消息。
 *
 * @return array<string, string>
 */
public function messages(): array
{
    return [
        'title.required' => '标题是必填的',
        'body.required' => '消息是必填的',
    ];
}

自定义验证属性

Laravel 的许多内置验证规则错误消息包含 :attribute 占位符。如果您希望验证消息的 :attribute 部分替换为自定义属性名称,可以通过重写 attributes 方法指定自定义名称:

php
/**
 * 获取验证错误消息中的属性名称。
 *
 * @return array<string, string>
 */
public function attributes(): array
{
    return [
        'email' => '电子邮件地址',
    ];
}

准备验证输入

如果您需要在应用验证规则之前准备或清理请求中的任何数据,可以使用 prepareForValidation 方法:

php
use Illuminate\Support\Str;

/**
 * 准备验证数据。
 */
protected function prepareForValidation(): void
{
    $this->merge([
        'slug' => Str::slug($this->slug),
    ]);
}

同样,如果您需要在验证完成后但错误发生之前规范化任何请求数据,可以使用 passedValidation 方法:

php
/**
 * 处理通过验证尝试。
 */
protected function passedValidation(): void
{
    $this->replace(['name' => 'Taylor']);
}

手动创建验证器

如果您不想使用请求上的 validate 方法,可以使用 Validator facade 手动创建验证器实例。facade 上的 make 方法生成一个新的验证器实例:

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use Illuminate\View\View;

class PostController extends Controller
{
    /**
     * 存储新博客文章。
     */
    public function store(Request $request): RedirectResponse
    {
        $validator = Validator::make($request->all(), [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
        ]);

        if ($validator->fails()) {
            return redirect('post/create')
                ->withErrors($validator)
                ->withInput();
        }

        // 检索已验证的输入...
        $validated = $validator->validated();

        // 检索部分已验证的输入...
        $validated = $validator->safe()->only(['name', 'email']);
        $validated = $validator->safe()->except(['name', 'email']);

        // 存储博客文章...

        return redirect('/posts');
    }
}

传递给 make 方法的第一个参数是应该验证的数据。第二个参数是应该应用于数据的验证规则。

如果请求未通过验证规则,您可以使用 withErrors 方法将错误消息闪存到会话。使用此方法时,$errors 变量将在重定向后自动与您的视图共享,允许您轻松将其显示给用户。withErrors 方法接受验证器、MessageBag 或 PHP array

自动重定向

如果您想手动创建验证器实例但仍利用 HTTP 请求的自动重定向,可以在现有验证器实例上调用 validate 方法。如果验证失败,用户将自动重定向,或者在 XHR 请求的情况下,将返回 JSON 响应:

php
Validator::make($request->all(), [
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
])->validate();

您可以使用 validateWithBag 方法将错误消息存储在命名错误包中:

php
Validator::make($request->all(), [
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
])->validateWithBag('post');

命名错误包

如果您在一个页面中有多个表单,您可能希望命名包含验证错误的 MessageBag,以便您可以为特定表单检索错误消息。为此,将名称作为第二个参数传递给 withErrors

php
return redirect('register')
    ->withErrors($validator, 'login');

然后,您可以从 $errors 变量访问命名 MessageBag 实例:

blade
{{ $errors->login->first('email') }}

自定义错误消息

如果需要,验证器实例可用的自定义错误消息可以替代 Laravel 附带的默认错误消息。有几种方法可以指定自定义消息。首先,您可以将自定义消息作为第三个参数传递给 Validator::make 方法:

php
$validator = Validator::make($request->all(), [
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
], [
    'title.required' => '标题是必填的',
    'body.required' => '消息是必填的',
]);

如果您想为特定属性指定自定义消息,可以在自定义消息数组中使用点符号。属性名称在前,规则名称在后:

php
$validator = Validator::make($request->all(), [
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
], [
    'required' => ':attribute 字段是必填的。',
]);

使用语言文件自定义消息

在许多情况下,您可能希望在语言文件中而不是直接在传递给 Validator 的代码中指定自定义消息。为此,请将您的消息放在 lang/xx/validation.php 语言文件的 custom 数组中:

php
'custom' => [
    'email' => [
        'required' => '我们需要知道您的电子邮件地址!',
        'max' => '您的电子邮件地址太长了!',
    ],
],

在语言文件中指定自定义属性

如果您希望 :attribute 占位符被替换为自定义属性名称,可以在 lang/xx/validation.php 语言文件的 attributes 数组中指定名称:

php
'attributes' => [
    'email' => '电子邮件地址',
],

这允许您在验证消息中用「电子邮件地址」替换 :attribute 占位符。

在语言文件中指定值

有时您可能需要验证规则的 :value 占位符被替换为自定义值表示。例如,考虑以下规则,该规则指定当 payment_type 值为 cc 时需要信用卡号:

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

如果此验证规则失败,它将生成以下错误消息:

text
当支付类型为 cc 时,信用卡号字段是必填的。

您可以在 lang/xx/validation.php 语言文件的 values 数组中指定自定义值表示,从而使命错误消息更加用户友好:

php
'values' => [
    'payment_type' => [
        'cc' => '信用卡',
    ],
],

现在,如果验证规则失败,它将生成以下错误消息:

text
当支付类型为信用卡时,信用卡号字段是必填的。

执行额外验证

有时您需要在初始验证完成后执行额外验证。您可以使用验证器的 after 方法完成此操作:

php
use Illuminate\Support\Facades\Validator;

$validator = Validator::make(/* ... */);

$validator->after(function ($validator) {
    if ($this->somethingElseIsInvalid()) {
        $validator->errors()->add(
            'field',
            '此字段有问题!'
        );
    }
});

if ($validator->fails()) {
    // ...
}

after 方法接受闭包或可调用类的数组。为方便起见,可调用类可能通过 __invoke 方法实现 Illuminate\Contracts\Validation\InvokableRule 接口:

php
use App\Rules\Uppercase;

$validator->after([
    function ($validator) {
        // ...
    },
    new Uppercase,
]);

如果 after 方法提供的回调添加了错误,验证器实例将标记为失败,并返回适当的错误响应。

处理已验证输入

在使用 validateValidator::make 方法验证传入请求数据后,您可能希望检索实际经过验证的请求数据。这可以通过几种方式完成。首先,您可以在请求或验证器实例上调用 validated 方法。此方法返回已验证数据的数组:

php
$validated = $request->validated();

$validated = $validator->validated();

或者,您可以在请求或验证器实例上调用 safe 方法。此方法返回 Illuminate\Support\ValidatedInput 的实例。此对象公开 onlyexceptall 方法,以检索已验证数据的子集或整个已验证数据数组:

php
$validated = $request->safe()->only(['name', 'email']);

$validated = $request->safe()->except(['name', 'email']);

$validated = $request->safe()->all();

此外,Illuminate\Support\ValidatedInput 实例可以像数组一样迭代和访问:

php
// 迭代已验证数据...
foreach ($request->safe() as $key => $value) {
    // ...
}

// 像数组一样访问已验证数据...
$value = $request->safe()['email'];

如果您想将已验证输入合并到其他数据中,可以将 merge 方法传递给 safe 方法:

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

如果您想检索已验证输入的子集作为 Collection 实例,可以使用 collect 方法:

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

处理错误消息

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

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

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

php
$errors = $validator->errors();

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

检索字段的所有错误消息

如果您需要检索给定字段的所有消息数组,请使用 get 方法:

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

如果您正在验证数组表单字段,可以使用 * 字符检索数组中每个元素的所有消息:

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

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

要检索所有字段的所有消息,请使用 all 方法:

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

确定字段是否存在消息

has 方法可用于确定给定字段是否存在任何错误消息:

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

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

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

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

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

WARNING

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

在语言文件中指定属性

Laravel 的许多内置验证规则错误消息包含 :attribute 占位符。如果您希望验证消息的 :attribute 部分替换为自定义属性名称,可以在 lang/xx/validation.php 语言文件的 attributes 数组中指定自定义名称:

php
'attributes' => [
    'email' => '电子邮件地址',
],

在语言文件中指定值

有时您可能需要验证规则的 :value 占位符被替换为自定义值表示。例如,考虑以下规则,该规则指定当 payment_type 值为 cc 时需要信用卡号:

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

如果此验证规则失败,它将生成以下错误消息:

text
当支付类型为 cc 时,信用卡号字段是必填的。

您可以在 lang/xx/validation.php 语言文件的 values 数组中指定自定义值表示,从而使命错误消息更加用户友好:

php
'values' => [
    'payment_type' => [
        'cc' => '信用卡',
    ],
],

现在,如果验证规则失败,它将生成以下错误消息:

text
当支付类型为信用卡时,信用卡号字段是必填的。

可用验证规则

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

accepted

验证中的字段必须是 "yes""on"1true。这对于验证「服务条款」接受或类似字段很有用。

accepted_if:anotherfield,value,...

如果另一个正在验证的字段等于指定值,则验证中的字段必须是 "yes""on"1true。这对于验证「服务条款」接受或类似字段很有用。

active_url

验证中的字段必须具有有效的 A 或 AAAA 记录,根据 dns_get_record PHP 函数。提供的 URL 的主机名使用 parse_url PHP 函数提取,然后传递给 dns_get_record

after:date

验证中的字段必须是给定日期之后的值。日期将传递给 strtotime PHP 函数:

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

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

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

after_or_equal:date

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

alpha

验证中的字段必须完全是 Unicode 字母字符中包含的字母,如 \p{L}\p{M} 中所述。

如果您想将此验证规则限制为 ASCII 范围内的字符(a-z 和 A-Z),可以向验证规则提供 ascii 选项:

php
'username' => 'alpha:ascii',

alpha_dash

验证中的字段必须完全是 Unicode 字母字符中包含的字母,如 \p{L}\p{M}\p{N} 以及 ASCII 破折号(-)和 ASCII 下划线(_)中所述。

如果您想将此验证规则限制为 ASCII 范围内的字符(a-z、A-Z、0-9、-_),可以向验证规则提供 ascii 选项:

php
'username' => 'alpha_dash:ascii',

alpha_num

验证中的字段必须完全是 Unicode 字母字符中包含的字母,如 \p{L}\p{M}\p{N} 中所述。

如果您想将此验证规则限制为 ASCII 范围内的字符(a-z、A-Z 和 0-9),可以向验证规则提供 ascii 选项:

php
'username' => 'alpha_num:ascii',

array

验证中的字段必须是 PHP array

可以向 array 规则提供附加值,以强制数组中的每个键出现在输入数组中。在以下示例中,输入数组中的 admin 键无效,因为它不包含在传递给 array 规则的键列表中:

php
use Illuminate\Support\Facades\Validator;

$input = [
    'user' => [
        'name' => 'Taylor Otwell',
        'username' => 'taylorotwell',
        'admin' => true,
    ],
];

Validator::make($input, [
    'user' => 'array:name,username',
]);

通常,您应该始终指定数组中允许存在的数组键。否则,验证器的 validatevalidated 方法将返回所有已验证数据,包括数组及其所有键,即使这些键未被其他嵌套数组验证规则验证。

ascii

验证中的字段必须完全是 7 位 ASCII 字符。

bail

在第一次验证失败后停止对字段运行验证规则。

虽然 bail 规则仅在遇到验证失败时停止验证特定字段,但 stopOnFirstFailure 方法将通知验证器一旦发生单个验证失败就应停止验证所有属性:

php
if ($validator->stopOnFirstFailure()->fails()) {
    // ...
}

before:date

验证中的字段必须是给定日期之前的值。日期将传递给 PHP strtotime 函数。此外,与 after 规则类似,可以传递另一个正在验证的字段名称作为日期的值。

before_or_equal:date

验证中的字段必须是小于或等于给定日期的值。日期将传递给 PHP strtotime 函数。此外,与 after 规则类似,可以传递另一个正在验证的字段名称作为日期的值。

between:min,max

验证中的字段必须在给定 minmax 之间。字符串、数字、数组和文件的计算方式与 size 规则相同。

boolean

验证中的字段必须能够转换为布尔值。接受的输入包括 truefalse10"1""0"

can:ability,arguments,...

验证中的字段必须对应于当前经过身份验证的用户被授权的策略。这可用于验证用户是否有权在表单请求中执行特定操作:

php
'post' => [
    'required',
    Rule::can('update', 'post'),
],

can 规则接受策略方法的第二个参数。如果策略方法接受多个参数,可以将它们作为逗号分隔的列表传递给 can 规则:

php
'post' => [
    'required',
    Rule::can('update', 'post,user'),
],

confirmed

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

如果您想为确认字段使用自定义名称,可以向规则提供名称:

php
'password' => 'confirmed:password_repeat';

contains:foo,bar,...

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

current_password

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

php
'password' => 'current_password:api'

date

验证中的字段必须是日期有效的值,根据 strtotime PHP 函数。

date_equals:date

验证中的字段必须等于给定日期。日期将传递给 PHP strtotime 函数。

date_format:format,...

验证中的字段必须匹配给定的 format。验证字段时,您应该使用 要么 date 要么 date_format,而不是两者都使用。此验证规则支持 PHP DateTime 类支持的所有格式:

php
'started_at' => 'date_format:Y-m-d H:i:s'

decimal:min,max

验证中的字段必须是数字,并且必须具有指定的小数位数:

php
// 必须正好有两位小数 (9.99)...
'price' => 'decimal:2'

// 必须有 2 到 4 位小数...
'price' => 'decimal:2,4'

declined

验证中的字段必须是 "no""off"0false

declined_if:anotherfield,value,...

如果另一个正在验证的字段等于指定值,则验证中的字段必须是 "no""off"0false

different:field

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

digits:value

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

digits_between:min,max

验证中的整数必须在给定 minmax 之间。

dimensions

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

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

可用约束有:min_widthmax_widthmin_heightmax_heightwidthheightratio

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

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

由于此规则需要多个参数,通常更方便使用 Rule::dimensions 方法流畅地构建规则:

php
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

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

distinct

验证数组时,验证中的字段不得有任何重复值:

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

Distinct 默认使用宽松变量比较。要使用严格比较,可以向验证规则定义添加 strict 参数:

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

可以向验证规则参数添加 ignore_case 以使规则忽略大小写差异:

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

doesnt_start_with:foo,bar,...

验证中的字段不得以给定值之一开头。

doesnt_end_with:foo,bar,...

验证中的字段不得以给定值之一结尾。

email

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

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

上面的示例将应用 RFCValidationDNSCheckValidation 验证。以下是您可以应用的完整验证样式列表:

  • 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 字符。

为方便起见,可以使用流畅规则构建器构建电子邮件验证规则:

php
use Illuminate\Validation\Rule;

$request->validate([
    'email' => [
        'required',
        Rule::email()
            ->rfcCompliant(strict: false)
            ->validateMxRecord()
            ->preventSpoofing()
    ],
]);

WARNING

dnsspoof 验证器需要 PHP intl 扩展。

encoding:encoding_type

验证中的字段必须匹配指定的字符编码。此规则使用 PHP 的 mb_check_encoding 函数验证给定文件或字符串值的编码。为方便起见,可以使用 Laravel 的流畅文件规则构建器构建 encoding 规则:

php
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\File;

Validator::validate($input, [
    'attachment' => [
        'required',
        File::types(['csv'])
            ->encoding('utf-8'),
    ],
]);

ends_with:foo,bar,...

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

enum

Enum 规则是一个基于类的规则,用于验证验证中的字段是否包含有效的枚举值。Enum 规则接受枚举名称作为其唯一的构造函数参数。验证原始值时,应向 Enum 规则提供支持的枚举:

php
use App\Enums\ServerStatus;
use Illuminate\Validation\Rule;

$request->validate([
    'status' => [Rule::enum(ServerStatus::class)],
]);

可以使用 Enum 规则的 onlyexcept 方法限制哪些枚举情况应被视为有效:

php
Rule::enum(ServerStatus::class)
    ->only([ServerStatus::Pending, ServerStatus::Active]);

Rule::enum(ServerStatus::class)
    ->except([ServerStatus::Pending, ServerStatus::Active]);

可以使用 when 方法有条件地修改 Enum 规则:

php
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

验证中的字段将从 validatevalidated 方法返回的请求数据中排除。

exclude_if:anotherfield,value

如果 anotherfield 字段等于 value,则验证中的字段将从 validatevalidated 方法返回的请求数据中排除。

如果需要复杂的条件排除逻辑,可以使用 Rule::excludeIf 方法。此方法接受布尔值或闭包。给定闭包时,闭包应返回 truefalse 以指示是否应排除验证中的字段:

php
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,否则验证中的字段将从 validatevalidated 方法返回的请求数据中排除。如果 valuenullexclude_unless:name,null),则除非比较字段是 null 或请求数据中缺少比较字段,否则将排除验证中的字段。

exclude_with:anotherfield

如果 anotherfield 字段存在,则验证中的字段将从 validatevalidated 方法返回的请求数据中排除。

exclude_without:anotherfield

如果 anotherfield 字段不存在,则验证中的字段将从 validatevalidated 方法返回的请求数据中排除。

exists:table,column

验证中的字段必须存在于给定的数据库表中。

Exists 规则的基本用法

php
'state' => 'exists:states'

如果未指定 column 选项,将使用字段名。因此,在这种情况下,规则将验证 states 数据库表是否包含与请求的 state 属性值匹配的 state 列值的记录。

指定自定义列名

您可以通过将数据库列名放在数据库表名之后来明确指定验证规则应使用的数据库列名:

php
'state' => 'exists:states,abbreviation'

有时,您可能需要指定用于 exists 查询的特定数据库连接。可以通过将连接名前缀到表名来完成:

php
'email' => 'exists:connection.staff,email'

您可以指定应用于确定表名的 Eloquent 模型,而不是直接指定表名:

php
'user_id' => 'exists:App\Models\User,id'

如果您想自定义验证规则执行的查询,可以使用 Rule 类流畅地定义规则。在此示例中,我们还将验证规则指定为数组,而不是使用 | 字符分隔:

php
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 规则应使用的数据库列名:

php
'state' => Rule::exists('states', 'abbreviation'),

有时,您可能希望验证值数组是否存在于数据库中。可以通过向正在验证的字段添加 existsarray 规则来完成:

php
'states' => ['array', Rule::exists('states', 'abbreviation')],

当这两个规则都分配给字段时,Laravel 将自动构建单个查询以确定所有给定值是否存在于指定表中。

extensions:foo,bar,...

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

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

WARNING

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

file

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

filled

验证中的字段在存在时不得为空。

gt:field

验证中的字段必须大于给定的 fieldvalue。两个字段必须是相同类型。字符串、数字、数组和文件使用与 size 规则相同的约定进行评估。

gte:field

验证中的字段必须大于或等于给定的 fieldvalue。两个字段必须是相同类型。字符串、数字、数组和文件使用与 size 规则相同的约定进行评估。

hex_color

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

image

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

WARNING

默认情况下,image 规则不允许 SVG 文件,因为可能存在 XSS 漏洞。如果需要允许 SVG 文件,可以向 image 规则提供 allow_svg 指令(image:allow_svg)。

in:foo,bar,...

验证中的字段必须包含在给定值列表中。由于此规则通常需要您 implode 数组,可以使用 Rule::in 方法流畅地构建规则:

php
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 规则的机场列表中:

php
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

$input = [
    'airports' => ['NYC', 'LAS'],
];

Validator::make($input, [
    'airports' => [
        'required',
        'array',
    ],
    'airports.*' => Rule::in(['NYC', 'LIT']),
]);

in_array:anotherfield.*

验证中的字段必须存在于 anotherfield 的值中。

in_array_keys:value.*

验证中的字段必须是一个数组,该数组至少具有给定的 values 之一作为数组中的键:

php
'config' => 'array|in_array_keys:timezone'

integer

验证中的字段必须是整数。

您可以使用 strict 参数仅在字段类型为 integer 时才将其视为有效。具有整数值的字符串将被视为无效:

php
'age' => 'integer:strict'

WARNING

此验证规则不验证输入是否为「整数」变量类型,仅验证输入是否为 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 类型之一:

php
'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime',

'media' => 'mimetypes:image/*,video/*',

要确定上传文件的 MIME 类型,将读取文件内容,框架将尝试猜测 MIME 类型,这可能与客户端提供的 MIME 类型不同。

mimes:foo,bar,...

验证中的文件必须具有与列出的扩展名之一对应的 MIME 类型:

php
'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 方法流畅地构建规则:

php
use Illuminate\Validation\Rule;

Validator::make($data, [
    'toppings' => [
        'required',
        Rule::notIn(['sprinkles', 'cherries']),
    ],
]);

not_regex:pattern

验证中的字段不得匹配给定的正则表达式。

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

WARNING

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

nullable

验证中的字段可以是 null

numeric

验证中的字段必须是数字

您可以使用 strict 参数仅在值是整数或浮点类型时才将其视为有效。数字字符串将被视为无效:

php
'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

验证中的字段必须为空或不存在。

prohibited_if:anotherfield,value,...

如果 anotherfield 字段等于任何 value,则验证中的字段必须为空或不存在。

prohibited_unless:anotherfield,value,...

除非 anotherfield 字段等于任何 value,否则验证中的字段必须为空或不存在。

prohibits:anotherfield,...

验证中的字段必须为空或不存在。如果验证中的字段不为空或存在,则 anotherfield 中的所有字段必须为空或不存在。

regex:pattern

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

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

WARNING

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

required

验证中的字段必须存在于输入数据中且不为空。如果满足以下条件之一,则字段被视为「空」:

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

required_if:anotherfield,value,...

如果 anotherfield 字段等于任何 value,则验证中的字段必须存在且不为空。

如果您想为 required_if 规则构建更复杂的条件,可以使用 Rule::requiredIf 方法。此方法接受布尔值或闭包。传递闭包时,闭包应返回 truefalse 以指示是否需要验证中的字段:

php
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 必须存在于请求数据中,除非 valuenull。如果 valuenullrequired_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 对应于给定的整数值(属性必须也具有 numericinteger 规则)。对于数组,size 对应于数组的 count。对于文件,size 对应于文件大小(以千字节为单位)。让我们看一些示例:

php
// 验证字符串是否正好是 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 方法。

可以使用 allper_countryper_identifier_type 参数来限制可接受的时区标识符:

php
'timezone' => 'required|timezone:all';

'timezone' => 'required|timezone:per_country:US';

'timezone' => 'required|timezone:per_identifier_type:abbreviation';

per_identifier_type 参数接受 abbreviationaliasgroup 值。

unique:table,column

验证中的字段在给定的数据库表中必须唯一。

如果没有指定 column 选项,将使用字段名。

指定自定义表/列名:

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

指定自定义数据库连接:

有时,您可能需要为验证器进行的数据库查询设置自定义连接。为此,可以在表名前添加连接名:

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

强制忽略给定 ID 的唯一规则:

有时,您可能希望在唯一检查期间忽略给定的 ID。例如,考虑一个包含用户名、电子邮件地址和位置的「更新个人资料」屏幕。您可能需要验证电子邮件地址是否唯一。在这种情况下,您需要从唯一检查中排除当前用户的 ID。

为了告诉验证器忽略用户的 ID,我们使用 Rule 类流畅地定义规则。在以下示例中,我们将验证规则指定为数组,而不是使用 | 字符分隔:

php
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'email' => [
        'required',
        Rule::unique('users')->ignore($user->id),
    ],
]);

WARNING

您永远不应将任何用户控制的请求输入传递给 ignore 方法。相反,您应该只传递系统生成的唯一 ID,例如来自 Eloquent 模型实例的自增 ID 或 UUID。否则,您的应用程序将容易受到 SQL 注入攻击。

您可以传递整个模型实例,而不是将模型键的值传递给 ignore 方法。Laravel 将自动从模型中提取键:

php
Rule::unique('users')->ignore($user)

如果您的表使用的主键列名不是 id,可以在调用 ignore 方法时指定列名:

php
Rule::unique('users')->ignore($user->id, 'user_id')

默认情况下,unique 规则将检查与正在验证的属性名称匹配的列的唯一性。但是,您可以将不同的列名作为第二个参数传递给 unique 方法:

php
Rule::unique('users', 'email_address')->ignore($user->id)

添加额外的 Where 子句:

您可以通过使用 where 方法自定义查询来指定额外的查询约束。例如,让我们添加一个约束,将查询范围限制为仅搜索 account_id 列值为 1 的记录:

php
'email' => Rule::unique('users')->where(fn (Builder $query) => $query->where('account_id', 1))

仅检查软删除记录的唯一性:

默认情况下,唯一规则检查数据库中所有记录的唯一性,包括软删除的记录。如果您想仅检查未软删除记录的唯一性,可以使用 withoutTrashed 方法:

php
'email' => Rule::unique('users')->withoutTrashed()

如果您的软删除模型使用非 deleted_at 的列名,可以在调用 withoutTrashed 方法时指定列名:

php
'email' => Rule::unique('users')->withoutTrashed('was_deleted_at')

uppercase

验证中的字段必须是大写。

url

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

您可以为验证指定应使用的 URL 协议:

php
'photo' => 'url:http,https'

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

如果需要更强大的 URL 验证,可以使用 Rule::url 流畅规则构建器:

php
use Illuminate\Validation\Rule;

$url = Rule::url()
    ->scheme('http')
    ->scheme('https');

host 方法可用于限制 URL 的主机:

php
$url = Rule::url()
    ->host('laravel.com')
    ->host('www.laravel.com');

ulid

验证中的字段必须是有效的通用唯一字典排序标识符 (ULID)

uuid

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

条件添加规则

当字段具有某些值时跳过验证

您可能偶尔不希望如果另一个字段具有给定值则验证该字段。您可以使用 exclude_if 验证规则来实现此行为。在此示例中,如果 has_appointment 字段为 false,则 appointment_datedoctor_name 字段将不会验证:

php
use Illuminate\Support\Facades\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 规则在另一个字段具有给定值之前不验证给定字段:

php
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 规则添加到规则列表中:

php
$v = Validator::make($data, [
    'email' => 'sometimes|required|email',
]);

在此示例中,如果 $data 数组中存在 email 字段,则仅对其进行验证。

NOTE

如果您尝试验证应始终存在或可能不存在的字段,请查看可选字段说明

复杂条件验证

有时您可能希望根据更复杂的条件逻辑添加验证规则。例如,如果另一个字段的值大于 100,则可能希望仅当给定字段大于 100 时才要求该字段。或者,您可能需要两个字段仅在另一个字段存在时才具有给定值。添加这些验证规则不必是痛苦的。首先,使用永远不会改变的静态规则创建一个 Validator 实例:

php
use Illuminate\Support\Facades\Validator;

$validator = Validator::make($request->all(), [
    'email' => 'required|email',
    'games' => 'required|integer',
]);

假设我们的 Web 应用程序是为游戏收藏家设计的。如果游戏收藏家在我们的应用程序中注册并拥有超过 100 款游戏,我们希望他们解释为什么拥有这么多游戏。例如,也许他们经营一家游戏转售店,或者他们只是喜欢收集游戏。要有条件地添加此要求,我们可以在 Validator 实例上使用 sometimes 方法:

php
use Illuminate\Support\Fluent;

$validator->sometimes('reason', 'required|max:500', function (Fluent $input) {
    return $input->games >= 100;
});

传递给 sometimes 方法的第一个参数是我们有条件验证的字段名称。第二个参数是我们想要添加的规则列表。如果作为第三个参数传递的闭包返回 true,将添加规则。此方法使构建复杂的条件验证变得轻而易举。您甚至可以一次为多个字段添加条件验证:

php
$validator->sometimes(['reason', 'cost'], 'required', function (Fluent $input) {
    return $input->games >= 100;
});

NOTE

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

复杂条件数组验证

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

php
$input = [
    'channels' => [
        [
            'type' => 'email',
            'address' => 'abigail@example.com',
        ],
        [
            'type' => 'url',
            'address' => 'https://example.com',
        ],
    ],
];

$validator->sometimes('channels.*.address', 'email', function (Fluent $input, Fluent $item) {
    return $item->type === 'email';
});

$validator->sometimes('channels.*.address', 'url', function (Fluent $input, Fluent $item) {
    return $item->type !== 'email';
});

与传递给闭包的 $input 参数一样,当属性数据是数组时,$item 参数是 Illuminate\Support\Fluent 的实例;否则,它是字符串。

验证数组

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

php
use Illuminate\Support\Facades\Validator;

$input = [
    'user' => [
        'name' => 'Taylor Otwell',
        'username' => 'taylorotwell',
        'admin' => true,
    ],
];

Validator::make($input, [
    'user' => 'array:name,username',
]);

通常,您应该始终指定数组中允许存在的数组键。否则,验证器的 validatevalidated 方法将返回所有已验证数据,包括数组及其所有键,即使这些键未被其他嵌套数组验证规则验证。

验证嵌套数组输入

验证基于数组的嵌套表单输入字段不必是痛苦的。您可以使用「点」语法验证数组中的属性。例如,如果传入 HTTP 请求包含 photos[profile] 字段,您可以这样验证它:

php
use Illuminate\Support\Facades\Validator;

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

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

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

同样,您可以在语言文件中指定自定义验证消息时使用 * 字符,从而轻松地为基于数组的字段使用单个验证消息:

php
'custom' => [
    'users.*.email' => [
        'unique' => '每个用户必须有唯一的电子邮件地址',
    ]
],

访问嵌套数组数据

有时您可能需要在为属性分配验证规则时访问给定嵌套数组元素的值。您可以使用 Rule::forEach 方法完成此操作。forEach 方法接受一个闭包,该闭包将为正在验证的数组属性的每次迭代调用,并将接收属性的值和显式的、完全展开的属性名称。闭包应返回要分配给数组元素的规则数组:

php
use App\Rules\HasPermission;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

$validator = Validator::make($request->all(), [
    'companies.*.id' => Rule::forEach(function (string|null $value, string $attribute) {
        return [
            Rule::exists(Company::class, 'id'),
            new HasPermission('manage-company', $value),
        ];
    }),
]);

错误消息索引和位置

验证数组时,您可能希望在应用程序显示的错误消息中引用验证失败的特定项的索引或位置。为此,您可以在自定义验证消息中包含 :index(从 0 开始)、:position(从 1 开始)或 :ordinal-position(从 1st 开始)占位符:

php
use Illuminate\Support\Facades\Validator;

$input = [
    'photos' => [
        [
            'name' => 'BeachVacation.jpg',
            'description' => '我海滩度假的照片!',
        ],
        [
            'name' => 'GrandCanyon.jpg',
            'description' => '',
        ],
    ],
];

Validator::validate($input, [
    'photos.*.description' => 'required',
], [
    'photos.*.description.required' => '请描述照片 #:position。',
]);

给定上面的示例,验证将失败,用户将看到以下错误消息:「请描述照片 #2。」

如有必要,您可以通过 second-indexsecond-positionthird-indexthird-position 等引用更深层嵌套的索引和位置。

php
'photos.*.attributes.*.string' => '照片 #:second-position 的属性无效。',

验证文件

Laravel 提供了各种验证规则,可用于验证上传的文件,例如 mimesimageminmax。虽然您可以在验证文件时单独指定这些规则,但 Laravel 还提供了一个流畅的文件验证规则构建器,您可能会发现它很方便:

php
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

验证文件大小

为方便起见,最小和最大文件大小可以指定为带有指示文件大小单位后缀的字符串。支持 kbmbgbtb 后缀:

php
File::types(['mp3', 'wav'])
    ->min('1kb')
    ->max('10mb');

验证图像文件

如果您的应用程序接受用户上传的图像,可以使用 File 规则的 image 构造方法来确保验证中的文件是图像(jpg、jpeg、png、bmp、gif 或 webp)。

此外,可以使用 dimensions 规则限制图像的尺寸:

php
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;

Validator::validate($input, [
    'photo' => [
        'required',
        File::image()
            ->min(1024)
            ->max(12 * 1024)
            ->dimensions(Rule::dimensions()->maxWidth(1000)->maxHeight(500)),
    ],
]);

NOTE

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

WARNING

默认情况下,image 规则不允许 SVG 文件,因为可能存在 XSS 漏洞。如果需要允许 SVG 文件,可以向 image 规则传递 allowSvg: trueFile::image(allowSvg: true)

验证图像尺寸

您还可以验证图像的尺寸。例如,要验证上传的图像至少为 1000 像素宽和 500 像素高,可以使用 dimensions 规则:

php
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;

File::image()->dimensions(
    Rule::dimensions()
        ->maxWidth(1000)
        ->maxHeight(500)
)

NOTE

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

验证密码

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

php
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;

$validator = Validator::make($request->all(), [
    'password' => ['required', 'confirmed', Password::min(8)],
]);

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

php
// 至少需要 8 个字符...
Password::min(8)

// 至少需要一个字母...
Password::min(8)->letters()

// 至少需要一个大写和一个小写字母...
Password::min(8)->mixedCase()

// 至少需要一个数字...
Password::min(8)->numbers()

// 至少需要一个符号...
Password::min(8)->symbols()

此外,您可以使用 uncompromised 方法确保密码未在公共密码数据泄露中泄露:

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

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

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

php
// 确保密码在同一数据泄露中出现少于 3 次...
Password::min(8)->uncompromised(3);

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

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

定义默认密码规则

您可能会发现,在应用程序的单一位置指定密码的默认验证规则很方便。您可以使用 Password::defaults 方法轻松完成此操作,该方法接受闭包。传递给 defaults 方法的闭包应返回密码规则的默认配置。通常,defaults 规则应在应用程序的服务提供者之一的 boot 方法中调用:

php
use Illuminate\Validation\Rules\Password;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    Password::defaults(function () {
        $rule = Password::min(8);

        return $this->app->isProduction()
            ? $rule->mixedCase()->uncompromised()
            : $rule;
    });
}

然后,当您想将默认规则应用于正在验证的特定密码时,可以不带参数调用 defaults 方法:

php
'password' => ['required', Password::defaults()],

有时,您可能希望将额外的验证规则附加到默认密码验证规则。可以使用 rules 方法完成此操作:

php
use App\Rules\ZxcvbnRule;

Password::defaults(function () {
    $rule = Password::min(8)->rules([new ZxcvbnRule]);

    // ...
});

自定义验证规则

使用规则对象

Laravel 提供了各种有用的验证规则;但是,您可能希望指定一些自己的规则。注册自定义验证规则的一种方法是使用规则对象。要生成新的规则对象,可以使用 make:rule Artisan 命令。让我们使用此命令生成一个验证字符串是否为大写的规则。Laravel 将把新规则放在 app/Rules 目录中。如果此目录不存在,Laravel 将在执行 Artisan 命令创建规则时创建它:

shell
php artisan make:rule Uppercase

创建规则后,我们就可以定义其行为。规则对象包含一个方法:validate。此方法接收属性名称、其值和应在失败时调用的回调,并带有验证错误消息:

php
<?php

namespace App\Rules;

use Closure;
use Illuminate\Contracts\Validation\ValidationRule;

class Uppercase implements ValidationRule
{
    /**
     * 运行验证规则。
     */
    public function validate(string $attribute, mixed $value, Closure $fail): void
    {
        if (strtoupper($value) !== $value) {
            $fail(':attribute 必须是大写。');
        }
    }
}

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

php
use App\Rules\Uppercase;

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

翻译验证消息

您可以向 $fail 闭包提供翻译字符串键,而不是向 $fail 闭包提供字面错误消息,并指示 Laravel 翻译错误消息:

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

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

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

访问额外数据

如果您的自定义验证规则类需要访问所有其他正在验证的数据,您的规则类可以实现 Illuminate\Contracts\Validation\DataAwareRule 接口。此接口要求您的类定义 setData 方法。此方法将在验证继续之前由 Laravel 自动调用,并传入所有正在验证的数据:

php
<?php

namespace App\Rules;

use Illuminate\Contracts\Validation\DataAwareRule;
use Illuminate\Contracts\Validation\ValidationRule;

class Uppercase implements DataAwareRule, ValidationRule
{
    /**
     * 所有正在验证的数据。
     *
     * @var array<string, mixed>
     */
    protected $data = [];

    // ...

    /**
     * 设置正在验证的数据。
     *
     * @param  array<string, mixed>  $data
     */
    public function setData(array $data): static
    {
        $this->data = $data;

        return $this;
    }
}

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

php
<?php

namespace App\Rules;

use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Contracts\Validation\ValidatorAwareRule;
use Illuminate\Validation\Validator;

class Uppercase implements ValidationRule, ValidatorAwareRule
{
    /**
     * 验证器实例。
     *
     * @var \Illuminate\Validation\Validator
     */
    protected $validator;

    // ...

    /**
     * 设置当前验证器。
     */
    public function setValidator(Validator $validator): static
    {
        $this->validator = $validator;

        return $this;
    }
}

使用闭包

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

php
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("{$attribute} 无效。");
            }
        },
    ],
]);

隐式规则

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

php
use Illuminate\Support\Facades\Validator;

$rules = ['name' => 'unique:users,name'];

$input = ['name' => ''];

Validator::make($input, $rules)->passes(); // true

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

shell
php artisan make:rule Uppercase --implicit

WARNING

「隐式」规则仅 暗示 属性是必需的。是否实际使缺失或空属性无效取决于您。