表单验证

未匹配的标注

表单验证

简介

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 App\Http\Controllers\Controller;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\View\View;

class PostController extends Controller
{
    /**
     * 博客的表单视图
     */
    public function create(): View
    {
        return view('post.create');
    }

    /**
     * 存储博客的 Action
     */
    public function store(Request $request): RedirectResponse
    {
        // 验证并且执行存储逻辑

        $post = /** ... */

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

编写验证逻辑

现在我们开始在 store 方法中编写用来验证新的博客文章的逻辑代码。为此,我们将使用 Illuminate\Http\Request 类提供的 validate 方法。如果验证通过,你的代码会继续正常运行。如果验证失败,则会抛出 Illuminate\Validation\ValidationException 异常,并自动将对应的错误响应返回给用户。

如果在传统 HTTP 请求期间验证失败,则会生成对先前 URL 的重定向响应。如果传入的请求是 XHR,将将返回包含验证错误信息的 JSON 响应。

为了深入理解 validate 方法,让我们接着回到 store 方法中:

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

    // 博客文章验证通过...

    return redirect('/posts');
}

如你所见,验证规则被传递到 validate 方法中。不用担心——所有可用的验证规则均已 存档。 另外再提醒一次,如果验证失败,会自动生成一个对应的响应。如果验证通过,那我们的控制器会继续正常运行。

另外,验证规则可以使用数组,而不是单个 | 分隔的字符串:

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

此外,你可以使用 validateWithBag 方法来验证请求,并将所有错误信息储存在一个 命名错误信息包

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

在首次验证失败时停止运行

有时候我们希望某个字段在第一次验证失败后就停止运行验证规则,只需要将 bail 添加到规则中:

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

在这个例子中,如果 title 字段没有通过 unique 规则,那么不会继续验证 max 规则。规则会按照分配时的顺序来验证。

嵌套字段的说明

如果传入的 HTTP 请求包含「嵌套」参数,你可以在验证规则中使用.语法来指定这些参数:

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

另外,如果你的字段名称包含点,则可以通过使用反斜杠将点转义,以防止将其解释为.语法:

$request->validate([
    'title' => 'required|unique:posts|max:255',
    'v1\.0' => 'required',
]);

显示验证错误信息

那么,如果传入的请求字段没有通过验证规则呢?如前所述,Laravel 会自动将用户重定向到之前的位置。此外,所有的验证错误和请求输入都会自动存入到闪存 session 中。

Illuminate\View\Middleware\ShareErrorsFromSession中间件与应用程序的所有视图共享一个$errors变量,该变量由web中间件组提供。当应用该中间件时,$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文件中。在此文件中,你将找到每个验证规则的翻译条目。你可以根据应用程序的需求随意更改或修改这些消息。

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

注意
默认,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 由于验证错误而生成重定向响应时,框架将自动将所有请求的输入闪存到 session 中。这样做是为了方便你在下一个请求期间访问输入,并重新填充用户尝试提交的表单。

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

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

Laravel 还提供了一个全局性的old。如果要在 Blade 模板, 中显示旧输入,则使用old来重新填充表单会更加方便。如果给定字段不存在旧输入,则将返回null

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

关于可选字段的注意事项

默认情况下, 在你的 Laravel 应用的全局中间件堆栈App\Http\Kernel类中包含了TrimStringsConvertEmptyStringsToNull中间件。因此,如果你不想让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 生成的每个表单请求都有两个方法:authorizerules

你可能已经猜到了,authorize 方法负责确定当前已认证用户是否可以执行请求所代表的操作,而 rules 方法返回应用于请求数据的验证规则:

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

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

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

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

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

    // Retrieve a portion of the validated input data...
    $validated = $request->safe()->only(['name', 'email']);
    $validated = $request->safe()->except(['name', 'email']);

    // 存储博客文章...

    return redirect('/posts');
}

如果验证失败,将生成重定向响应以将用户发送回其先前的位置。错误也将被闪存到会话中,以便进行显示。如果请求是 XHR 请求,则会向用户返回带有 422 状态代码的 HTTP 响应,其中包含JSON 格式的验证错误表示

在表单请求后添加钩子

如果您想在表单请求「之后」添加验证钩子,可以使用 withValidator 方法。这个方法接收一个完整的验证构造器,允许你在验证结果返回之前调用任何方法:

use Illuminate\Validation\Validator;

/**
 * 配置验证实例。
 */
public function withValidator(Validator $validator): void
{
    $validator->after(function (Validator $validator) {
        if ($this->somethingElseIsInvalid()) {
            $validator->errors()->add('field', 'Something is wrong with this field!');
        }
    });
}

单个验证规则失败后停止

通过向您的请求类添加 stopOnFirstFailure 属性,您可以通知验证器一旦发生单个验证失败后,停止验证所有规则。

/**
 * 表示验证器是否应在第一个规则失败时停止。
 *
 * @var bool
 */
protected $stopOnFirstFailure = true;

自定义重定向

如前所述,当表单请求验证失败时,将会生成一个让用户返回到先前位置的重定向响应。当然,您也可以自由定义此行为。如果您要这样做,可以在表单请求中定义一个 $redirect 属性:

/**
 * 如果验证失败,用户应重定向到的 URI。
 *
 * @var string
 */
protected $redirect = '/dashboard';

或者,如果你想将用户重定向到一个命名路由,你可以定义一个 $redirectRoute 属性来代替:

/**
 * 如果验证失败,用户应该重定向到的路由。
 *
 * @var string
 */
protected $redirectRoute = 'dashboard';

表单请求授权验证

表单请求类内也包含了 authorize 方法。在这个方法中,您可以检查经过身份验证的用户确定其是否具有更新给定资源的权限。例如,您可以判断用户是否拥有更新文章评论的权限。最有可能的是,您将通过以下方法与你的 授权与策略 进行交互:

use App\Models\Comment;

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

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

由于所有的表单请求都是继承了 Laravel 中的请求基类,所以我们可以使用 user 方法去获取当前认证登录的用户。同时请注意上述例子中对 route 方法的调用。这个方法允许你在被调用的路由上获取其定义的 URI 参数,譬如下面例子中的 {comment} 参数:

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

因此,如果您的应用程序正在使用 路由模型绑定,则可以通过将解析的模型作为请求从而让您的代码更加简洁:

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

如果 authorize 方法返回 false,则会自动返回一个包含 403 状态码的 HTTP 响应,也不会运行控制器的方法。

如果您打算在应用程序的其它部分处理请求的授权逻辑,只需从 authorize 方法返回 true

/**
 * 判断用户是否有请求权限。
 */
public function authorize(): bool
{
    return true;
}

注意
你可以向 authorize 方法传入所需的任何依赖项。它们会自动被 Laravel 提供的 服务容器 自动解析。

自定义错误消息

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

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

自定义验证属性

Laravel 的许多内置验证规则错误消息都包含 :attribute 占位符。如果您希望将验证消息的 :attribute 部分替换为自定义属性名称,则可以重写 attributes 方法来指定自定义名称。此方法应返回属性 / 名称对的数组:

/**
 * 获取验证错误的自定义属性
 *
 * @return array<string, string>
 */
public function attributes(): array
{
    return [
        'email' => 'email address',
    ];
}

准备验证输入

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

use Illuminate\Support\Str;

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

同样地,如果您需要在验证完成后对任何请求数据进行规范化,您可以使用 passedValidation 方法:

use Illuminate\Support\Str;

/**
 * Handle a passed validation attempt.
 */
protected function passedValidation(): void
{
    $this->replace(['name' => 'Taylor']);
}

手动创建验证器

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

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;

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

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

        // 获取验证后的输入...
        $validated = $validator->validated();

        // 获取验证后输入的一部分...
        $validated = $validator->safe()->only(['name', 'email']);
        $validated = $validator->safe()->except(['name', 'email']);

        // 存储博客文章...

        return redirect('/posts');
    }
}

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

在确定请求验证是否失败之后,您可以使用withErrors方法将错误消息闪存到会话中。使用此方法后,$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 方法实现:

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

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

$validator->after(function (Validator $validator) {
    if ($this->somethingElseIsInvalid()) {
        $validator->errors()->add(
            'field', 'Something is wrong with this field!'
        );
    }
});

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

处理验证字段

在使用表单请求或手动创建的验证器实例验证传入请求数据后,你可能希望检索经过验证的请求数据。 这可以通过多种方式实现。 首先,你可以在表单请求或验证器实例上调用 validated 方法。 此方法返回已验证的数据数组:

$validated = $request->validated();

$validated = $validator->validated();

或者,你可以在表单请求或验证器实例上调用 safe 方法。 此方法返回一个 Illuminate\Support\ValidatedInput的实例。 该实例对象包含 onlyexceptall 方法来检索已验证数据的子集或整个已验证数据数组:

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

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

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

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

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

// 访问验证数据数组...
$validated = $request->safe();

$email = $validated['email'];

merge 方法可以给验证过的数据添加额外的字段:

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

collect 方法以 collection 实例的形式来检索验证的数据:

$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 文件中。在这个文件中, 你会发现每个验证规则都有一个翻译条目。可以根据你的应用程序的需要,自由地改变或修改这些信息。

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

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

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

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

定义这个值后,验证规则将产生以下错误信息:

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

可用的验证规则

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

accepted

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

accepted_if:anotherfield,value,…

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

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-zA-Z),你可以为验证规则提供 ascii 选项:

'username' => 'alpha:ascii',

alpha_dash

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

为了将此验证规则限制在 ASCII 范围内的字符(a-zA-Z),你可以为验证规则提供 ascii 选项:

'username' => 'alpha_dash:ascii',

alpha_num

被验证的字段必须完全是 Unicode 字母数字字符中的 \p{L}, \p{M}\p{N}

为了将此验证规则限制在 ASCII 范围内的字符(a-zA-Z),你可以为验证规则提供 ascii 选项:

'username' => 'alpha_num:ascii',

array

待验证字段必须是有效的 PHP 数组

当向 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

待验证字段值的大小必须介于给定的最小值和最大值(含)之间。字符串、数字、数组和文件的计算方式都使用 size 方法。

boolean

验证的字段必须可以转换为 Boolean 类型。 可接受的输入为 true, false, 1, 0, 「1」, 和 「0」

confirmed

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

current_password

验证字段必须与已认证用户的密码匹配。 您可以使用规则的第一个参数指定 authentication guard:

'password' => 'current_password:api'

date

验证字段必须是 strtotime PHP 函数可识别的有效日期。

date_equals:date

验证字段必须等于给定日期。日期将传递到 PHP strtotime 函数中,以转换为有效的 DateTime 实例。

date_format:format,…

验证字段必须匹配给定的 format 。在验证字段时,您应该只使用 datedate_format 中的其中一个,而不是同时使用。该验证规则支持 PHP 的 DateTime 类支持的所有格式。

decimal:min,max

验证字段必须是数值类型,并且必须包含指定的小数位数:

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

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

declined

正在验证的字段必须是 「no」「off」0 或者 false

declined_if:anotherfield,value,…

如果另一个验证字段的值等于指定值,则验证字段的值必须为「no」「off」0false

different:field

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

digits:value

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

digits_between:min,max

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

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

验证的字段必须符合 e-mail 地址格式。当前版本,此种验证规则由 egulias/email-validator 提供支持。默认情况下,使用 RFCValidation 验证样式,但你也可以应用其他验证样式:

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

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

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

filter 验证器是 Laravel 内置的一个验证器,它使用 PHP 的 filter_var 函数实现。在 Laravel 5.8 版本之前,它是 Laravel 默认的电子邮件验证行为。

注意
dnsspoof 验证器需要 PHP 的 intl 扩展。

ends_with:foo,bar,…

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

enum

Enum 规则是一种基于类的规则,用于验证被验证字段是否包含有效的枚举值。 Enum 规则的构造函数只接受枚举的名称作为参数:

use App\Enums\ServerStatus;
use Illuminate\Validation\Rules\Enum;

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

exclude

validatevalidated 方法中会排除掉当前验证的字段。

exclude_if:anotherfield,value

如果 anotherfield 等于 valuevalidatevalidated 方法中会排除掉当前验证的字段。

在一些复杂的场景,也可以使用 Rule::excludeIf 方法,这个方法需要返回一个布尔值或者一个匿名函数。如果返回的是匿名函数,那么这个函数应该返回 truefalse去决定被验证的字段是否应该被排除掉:

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

如果表单数据中有 anotherfieldvalidatevalidated 方法中会排除掉当前的字段。

exclude_without:anotherfield

如果表单数据中没有 anotherfieldvalidatevalidated 方法中会排除掉当前的字段。

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) {
            return $query->where('account_id', 1);
        }),
    ],
]);

您可以通过将列名作为 exists 方法的第二个参数来明确指定 Rule::exists 方法生成的 exists 规则应该使用的数据库列名:

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

file

要验证的字段必须是一个成功的已经上传的文件。

filled

当字段存在时,要验证的字段必须是一个非空的。

gt:field

要验证的字段必须要大于给定的字段。这两个字段必须是同一个类型。字符串、数字、数组和文件都使用 size 进行相同的评估。

gte:field

要验证的字段必须要大于或等于给定的字段。这两个字段必须是同一个类型。字符串、数字、数组和文件都使用 size 进行相同的评估。

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

验证的字段必须是一个整数。

警告
这个验证规则并不会验证输入是否为”integer”变量类型,它只会验证输入是否为 PHP 的 FILTER_VALIDATE_INT 规则接受的类型。如果你需要验证输入是否为数字,请结合 numeric 验证规则使用。

ip

验证的字段必须是一个 IP 地址。

ipv4

验证的字段必须是一个 IPv4 地址。

ipv6

验证的字段必须是一个 IPv6 地址。

json

验证的字段必须是一个有效的 JSON 字符串。

lt:field

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

lte:field

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

lowercase

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

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 类型。

MIME 规则的基本用法

'photo' => 'mimes:jpg,bmp,png'

尽管您只需要指定扩展名,但该规则实际上通过读取文件内容并猜测其 MIME 类型来验证文件的 MIME 类型。可以在以下位置找到 MIME 类型及其相应扩展名的完整列表:

svn.apache.org/repos/asf/httpd/htt...

min:value

验证的字段的值必须大于或等于最小值 value。字符串、数字、数组和文件的处理方式与 size 规则相同。

min_digits:value

验证的整数必须具有至少_value_位数。

multiple_of:value

验证的字段必须是_value_的倍数。

missing

验证的字段在输入数据中必须不存在。

missing_if:anotherfield,value,…

如果_anotherfield_字段等于任何_value_,则验证的字段必须不存在。

missing_unless:anotherfield,value

验证的字段必须不存在,除非_anotherfield_字段等于任何_value_。

missing_with:foo,bar,…

如果任何其他指定的字段存在,则验证的字段必须不存在。

missing_with_all:foo,bar,…

如果所有其他指定的字段都存在,则验证的字段必须不存在。

not_in:foo,bar,…

验证的字段不能包含在给定值列表中。可以使用Rule::notIn方法流畅地构建规则:

use Illuminate\Validation\Rule;

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

not_regex:pattern

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

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

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

nullable

需要验证的字段可以为 null。

numeric

需要验证的字段必须是数字类型

password

需要验证的字段必须与已认证用户的密码相匹配。

警告
这个规则在 Laravel 9 中被重命名为 current_password 并计划删除,请改用 Current Password 规则。

present

需要验证的字段必须存在于输入数据中。

prohibited

需要验证的字段必须不存在或为空。如果符合以下条件之一,字段将被认为是“空”:

  • 值为 null
  • 值为空字符串。
  • 值为空数组或空的可计数对象。
  • 值为上传文件,但文件路径为空。

prohibited_if:anotherfield,value,…

如果 anotherfield 字段等于任何 value,则需要验证的字段必须不存在或为空。如果符合以下条件之一,字段将被认为是“空”:

  • 值为 null
  • 值为空字符串。
  • 值为空数组或空的可计数对象。
  • 值为上传文件,但文件路径为空。

如果需要复杂的条件禁止逻辑,则可以使用 Rule::prohibitedIf 方法。该方法接受一个布尔值或一个闭包。当给定一个闭包时,闭包应返回 truefalse,以指示是否应禁止验证字段:

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'

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

required

验证的字段必须出现在输入数据中且不为空。如果一个字段符合以下任一标准,则它被认为是“空”的:

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

required_if:anotherfield,value,…

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

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

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

如果 anotherfield 字段的值不等于任何 value 值,则验证的字段必须存在且不为空。这也意味着,除非 anotherfield 字段等于任何 value 值,否则必须在请求数据中包含 anotherfield 字段。如果 value 的值为 nullrequired_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

给定的字段必须与验证的字段匹配。

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_identifiers_list PHP 函数的要求。

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\Database\Eloquent\Builder;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

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

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

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

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

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

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

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

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

添加额外的查询条件:

您可以通过自定义查询并使用 where 方法来指定其他查询条件。例如,让我们添加一个查询条件,将查询范围限定为仅搜索具有 account_id 列值为 1 的记录:

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

uppercase

验证字段必须为大写。

url

验证字段必须为有效的 URL。

ulid

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

uuid

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

有条件添加规则

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

有时,您可能希望在给定字段具有特定值时不验证另一个字段。您可以使用exclude_if验证规则来实现这一点。在下面的示例中,如果has_appointment字段的值为false,则不会验证appointment_datedoctor_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规则添加到您的规则列表中:

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

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

注意
如果您尝试验证始终应存在但可能为空的字段,请查看有关可选字段的说明

复杂条件验证

有时,您可能希望根据更复杂的条件逻辑添加验证规则。例如,您可能只希望在另一个字段的值大于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;
});

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

复杂条件数组验证

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

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

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

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

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

验证数组

正如在 array 验证规则文档 中讨论的那样,array 规则接受允许的数组键列表。如果数组中存在任何额外的键,则验证将失败:

use Illuminate\Support\Facades\Validator;

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

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

通常情况下,您应该始终指定允许出现在数组中的键。否则,验证器的 validatevalidated 方法将返回所有经过验证的数据,包括数组及其所有键,即使这些键没有通过其他嵌套数组验证规则进行验证。

验证嵌套数组输入

验证基于嵌套数组的表单输入字段并不需要很痛苦。您可以使用 “点符号” 来验证数组中的属性。例如,如果传入的 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' => '我的海滩假期照片!',
        ],
        [
            'name' => 'GrandCanyon.jpg',
            'description' => '',
        ],
    ],
];

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

上述示例将验证失败,并且用户会看到以下错误:“请描述第 2 张照片。”

验证文件

Laravel提供了多种上传文件的验证规则,如mimesimageminmax。虽然你可以在验证文件时单独指定这些规则,但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\Rules\File;

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

技巧
更多验证图片尺寸的信息,请参见尺寸规则文档

文件类型

尽管在调用 types 方法时只需要指定扩展名,但该方法实际上是通过读取文件的内容并猜测其MIME类型来验证文件的MIME类型的。MIME类型及其相应扩展的完整列表可以在以下链接中找到:

svn.apache.org/repos/asf/httpd/htt...

验证密码

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

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

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

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

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

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

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

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

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

此外,你可以使用 uncompromised 方法确保密码没有在公共密码数据泄露事件中被泄露:

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

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

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

    // 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 方法的闭包应该返回密码规则的默认配置。通常,应该在应用程序服务提供者之一的 boot 方法中调用 defaults 规则:

use Illuminate\Validation\Rules\Password;

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

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

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

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

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

use App\Rules\ZxcvbnRule;

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

    // ...
});

自定义验证规则

使用规则对象

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

php artisan make:rule Uppercase

一旦规则被创建,我们就可以定义其行为。一个规则对象包含一个单一的方法:validate。该方法接收属性名、其值和一个回调函数,如果验证失败应该调用该回调函数并传入验证错误消息:

<?php

namespace App\Rules;

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

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

    // ...

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

        return $this;
    }
}

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

<?php

namespace App\Rules;

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

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

    // ...

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

        return $this;
    }
}

使用闭包函数

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

use Illuminate\Support\Facades\Validator;

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

隐式规则

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

use Illuminate\Support\Facades\Validator;

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

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

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

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

php artisan make:rule Uppercase --implicit

*警告 *
隐式规则仅 暗示 该属性是必需的。实际上,缺少或空属性是否无效取决于您。

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/laravel/10.x/va...

译文地址:https://learnku.com/docs/laravel/10.x/va...

上一篇 下一篇
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
贡献者:20
讨论数量: 1
发起讨论 只看当前版本


肌无力猛男
captcha验证不通过
0 个点赞 | 4 个回复 | 问答 | 课程版本 10.x