Laravel 11.x 中文文档

简体中文

English

简体中文

English

主题

预知 ​

介绍 ​

Laravel 预知允许您预测未来 HTTP 请求的结果。预知的主要用例之一是能够为您的前端 JavaScript 应用程序提供“实时”验证，而无需重复应用程序的后端验证规则。预知与 Laravel 的基于 Inertia 的 启动工具包 特别配合良好。

当 Laravel 接收到“预知请求”时，它将执行所有路由的中间件并解析路由的控制器依赖项，包括验证 表单请求 - 但实际上不会执行路由的控制器方法。

实时验证 ​

使用 Vue ​

使用 Laravel 预知，您可以为用户提供实时验证体验，而无需在前端 Vue 应用程序中重复验证规则。为了说明它是如何工作的，让我们构建一个用于在我们的应用程序中创建新用户的表单。

首先，要为路由启用预知，应该将 HandlePrecognitiveRequests 中间件添加到路由定义中。您还应该创建一个 表单请求 来存放路由的验证规则：

php
use App\Http\Requests\StoreUserRequest;
use Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests;

Route::post('/users', function (StoreUserRequest $request) {
    // ...
})->middleware([HandlePrecognitiveRequests::class]);

接下来，您应该通过 NPM 安装 Laravel 预知的 Vue 前端助手：

shell
npm install laravel-precognition-vue

安装 Laravel 预知包后，您现在可以使用预知的 useForm 函数创建一个表单对象，提供 HTTP 方法（post）、目标 URL（/users）和初始表单数据。

然后，为了启用实时验证，在每个输入的 change 事件上调用表单的 validate 方法，提供输入的名称：

vue
<script setup>
import { useForm } from 'laravel-precognition-vue';

const form = useForm('post', '/users', {
    name: '',
    email: '',
});

const submit = () => form.submit();
</script>

<template>
    <form @submit.prevent="submit">
        <label for="name">姓名</label>
        <input
            id="name"
            v-model="form.name"
            @change="form.validate('name')"
        />
        <div v-if="form.invalid('name')">
            {{ form.errors.name }}
        </div>

        <label for="email">电子邮件</label>
        <input
            id="email"
            type="email"
            v-model="form.email"
            @change="form.validate('email')"
        />
        <div v-if="form.invalid('email')">
            {{ form.errors.email }}
        </div>

        <button :disabled="form.processing">
            创建用户
        </button>
    </form>
</template>

现在，当用户填写表单时，预知将提供由路由的表单请求中的验证规则驱动的实时验证输出。当表单的输入被更改时，将向您的 Laravel 应用程序发送一个去抖动的“预知”验证请求。您可以通过调用表单的 setValidationTimeout 函数来配置去抖动超时：

js
form.setValidationTimeout(3000);

当验证请求正在进行时，表单的 validating 属性将为 true：

html
<div v-if="form.validating">
    正在验证...
</div>

在验证请求或表单提交期间返回的任何验证错误将自动填充表单的 errors 对象：

html
<div v-if="form.invalid('email')">
    {{ form.errors.email }}
</div>

您可以使用表单的 hasErrors 属性来确定表单是否有任何错误：

html
<div v-if="form.hasErrors">
    <!-- ... -->
</div>

您还可以通过将输入的名称传递给表单的 valid 和 invalid 函数来确定输入是否通过或未通过验证：

html
<span v-if="form.valid('email')">
    ✅
</span>

<span v-else-if="form.invalid('email')">
    ❌
</span>
exclamation

表单输入只有在更改并收到验证响应后才会显示为有效或无效。

如果您正在使用预知验证表单的输入子集，手动清除错误可能会很有用。您可以使用表单的 forgetError 函数来实现这一点：

html
<input
    id="avatar"
    type="file"
    @change="(e) => {
        form.avatar = e.target.files[0]

        form.forgetError('avatar')
    }"
>

正如我们所看到的，您可以挂钩到输入的 change 事件并在用户与之交互时验证单个输入；但是，您可能需要验证用户尚未与之交互的输入。这在构建“向导”时很常见，您希望在移动到下一步之前验证所有可见输入，无论用户是否与之交互。

要使用预知执行此操作，您应该通过将要验证的字段名称传递给 touch 方法来标记这些字段。然后，调用 validate 方法并提供 onSuccess 或 onValidationError 回调：

html
<button
    type="button" 
    @click="form.touch(['name', 'email', 'phone']).validate({
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })"
>下一步</button>

当然，您还可以在表单提交的响应中执行代码。表单的 submit 函数返回一个 Axios 请求承诺。这提供了一种方便的方法来访问响应有效负载，在成功提交时重置表单输入，或处理失败的请求：

js
const submit = () => form.submit()
    .then(response => {
        form.reset();

        alert('用户已创建。');
    })
    .catch(error => {
        alert('发生错误。');
    });

您可以通过检查表单的 processing 属性来确定表单提交请求是否正在进行：

html
<button :disabled="form.processing">
    提交
</button>

使用 Vue 和 Inertia ​

lightbulb

如果您希望在使用 Vue 和 Inertia 开发 Laravel 应用程序时获得一个良好的开端，请考虑使用我们的 启动工具包。Laravel 的启动工具包为您的新 Laravel 应用程序提供后端和前端身份验证脚手架。

在使用 Vue 和 Inertia 之前，请确保查看我们关于 使用 Vue 的预知 的一般文档。当使用 Vue 和 Inertia 时，您需要通过 NPM 安装与 Inertia 兼容的预知库：

shell
npm install laravel-precognition-vue-inertia

安装后，预知的 useForm 函数将返回一个增强了上述验证功能的 Inertia 表单助手。

表单助手的 submit 方法已被简化，去掉了指定 HTTP 方法或 URL 的需要。相反，您可以将 Inertia 的 访问选项 作为第一个也是唯一的参数传递。此外，submit 方法不会像上面的 Vue 示例那样返回一个 Promise。相反，您可以在传递给 submit 方法的访问选项中提供任何 Inertia 支持的 事件回调：

vue
<script setup>
import { useForm } from 'laravel-precognition-vue-inertia';

const form = useForm('post', '/users', {
    name: '',
    email: '',
});

const submit = () => form.submit({
    preserveScroll: true,
    onSuccess: () => form.reset(),
});
</script>

使用 React ​

使用 Laravel 预知，您可以为用户提供实时验证体验，而无需在前端 React 应用程序中重复验证规则。为了说明它是如何工作的，让我们构建一个用于在我们的应用程序中创建新用户的表单。

首先，要为路由启用预知，应该将 HandlePrecognitiveRequests 中间件添加到路由定义中。您还应该创建一个 表单请求 来存放路由的验证规则：

php
use App\Http\Requests\StoreUserRequest;
use Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests;

Route::post('/users', function (StoreUserRequest $request) {
    // ...
})->middleware([HandlePrecognitiveRequests::class]);

接下来，您应该通过 NPM 安装 Laravel 预知的 React 前端助手：

shell
npm install laravel-precognition-react

安装 Laravel 预知包后，您现在可以使用预知的 useForm 函数创建一个表单对象，提供 HTTP 方法（post）、目标 URL（/users）和初始表单数据。

为了启用实时验证，您应该监听每个输入的 change 和 blur 事件。在 change 事件处理程序中，您应该使用 setData 函数设置表单的数据，传递输入的名称和新值。然后，在 blur 事件处理程序中调用表单的 validate 方法，提供输入的名称：

jsx
import { useForm } from 'laravel-precognition-react';

export default function Form() {
    const form = useForm('post', '/users', {
        name: '',
        email: '',
    });

    const submit = (e) => {
        e.preventDefault();

        form.submit();
    };

    return (
        <form onSubmit={submit}>
            <label htmlFor="name">姓名</label>
            <input
                id="name"
                value={form.data.name}
                onChange={(e) => form.setData('name', e.target.value)}
                onBlur={() => form.validate('name')}
            />
            {form.invalid('name') && <div>{form.errors.name}</div>}

            <label htmlFor="email">电子邮件</label>
            <input
                id="email"
                value={form.data.email}
                onChange={(e) => form.setData('email', e.target.value)}
                onBlur={() => form.validate('email')}
            />
            {form.invalid('email') && <div>{form.errors.email}</div>}

            <button disabled={form.processing}>
                创建用户
            </button>
        </form>
    );
};

现在，当用户填写表单时，预知将提供由路由的表单请求中的验证规则驱动的实时验证输出。当表单的输入被更改时，将向您的 Laravel 应用程序发送一个去抖动的“预知”验证请求。您可以通过调用表单的 setValidationTimeout 函数来配置去抖动超时：

js
form.setValidationTimeout(3000);

当验证请求正在进行时，表单的 validating 属性将为 true：

jsx
{form.validating && <div>正在验证...</div>}

在验证请求或表单提交期间返回的任何验证错误将自动填充表单的 errors 对象：

jsx
{form.invalid('email') && <div>{form.errors.email}</div>}

您可以使用表单的 hasErrors 属性来确定表单是否有任何错误：

jsx
{form.hasErrors && <div><!-- ... --></div>}

您还可以通过将输入的名称传递给表单的 valid 和 invalid 函数来确定输入是否通过或未通过验证：

jsx
{form.valid('email') && <span>✅</span>}

{form.invalid('email') && <span>❌</span>}
exclamation

表单输入只有在更改并收到验证响应后才会显示为有效或无效。

如果您正在使用预知验证表单的输入子集，手动清除错误可能会很有用。您可以使用表单的 forgetError 函数来实现这一点：

jsx
<input
    id="avatar"
    type="file"
    onChange={(e) => {
        form.setData('avatar', e.target.value);

        form.forgetError('avatar');
    }}
>

正如我们所看到的，您可以挂钩到输入的 blur 事件并在用户与之交互时验证单个输入；但是，您可能需要验证用户尚未与之交互的输入。这在构建“向导”时很常见，您希望在移动到下一步之前验证所有可见输入，无论用户是否与之交互。

要使用预知执行此操作，您应该标记您希望验证的字段为“已触摸”，通过将它们的名称传递给 touch 方法。然后，调用 validate 方法并提供 onSuccess 或 onValidationError 回调：

jsx
<button
    type="button"
    onClick={() => form.touch(['name', 'email', 'phone']).validate({
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })}
>下一步</button>

当然，您还可以在表单提交的响应中执行代码。表单的 submit 函数返回一个 Axios 请求承诺。这提供了一种方便的方法来访问响应有效负载，在成功提交时重置表单输入，或处理失败的请求：

js
const submit = (e) => {
    e.preventDefault();

    form.submit()
        .then(response => {
            form.reset();

            alert('用户已创建。');
        })
        .catch(error => {
            alert('发生错误。');
        });
};

您可以通过检查表单的 processing 属性来确定表单提交请求是否正在进行：

html
<button disabled={form.processing}>
    提交
</button>

使用 React 和 Inertia ​

lightbulb

如果您希望在使用 React 和 Inertia 开发 Laravel 应用程序时获得一个良好的开端，请考虑使用我们的 启动工具包。Laravel 的启动工具包为您的新 Laravel 应用程序提供后端和前端身份验证脚手架。

在使用 React 和 Inertia 之前，请确保查看我们关于 使用 React 的预知 的一般文档。当使用 React 和 Inertia 时，您需要通过 NPM 安装与 Inertia 兼容的预知库：

shell
npm install laravel-precognition-react-inertia

安装后，预知的 useForm 函数将返回一个增强了上述验证功能的 Inertia 表单助手。

表单助手的 submit 方法已被简化，去掉了指定 HTTP 方法或 URL 的需要。相反，您可以将 Inertia 的 访问选项 作为第一个也是唯一的参数传递。此外，submit 方法不会像上面的 React 示例那样返回一个 Promise。相反，您可以在传递给 submit 方法的访问选项中提供任何 Inertia 支持的 事件回调：

js
import { useForm } from 'laravel-precognition-react-inertia';

const form = useForm('post', '/users', {
    name: '',
    email: '',
});

const submit = (e) => {
    e.preventDefault();

    form.submit({
        preserveScroll: true,
        onSuccess: () => form.reset(),
    });
};

使用 Alpine 和 Blade ​

使用 Laravel 预知，您可以为用户提供实时验证体验，而无需在前端 Alpine 应用程序中重复验证规则。为了说明它是如何工作的，让我们构建一个用于在我们的应用程序中创建新用户的表单。

首先，要为路由启用预知，应该将 HandlePrecognitiveRequests 中间件添加到路由定义中。您还应该创建一个 表单请求 来存放路由的验证规则：

php
use App\Http\Requests\CreateUserRequest;
use Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests;

Route::post('/users', function (CreateUserRequest $request) {
    // ...
})->middleware([HandlePrecognitiveRequests::class]);

接下来，您应该通过 NPM 安装 Laravel 预知的 Alpine 前端助手：

shell
npm install laravel-precognition-alpine

然后，在您的 resources/js/app.js 文件中注册预知插件：

js
import Alpine from 'alpinejs';
import Precognition from 'laravel-precognition-alpine';

window.Alpine = Alpine;

Alpine.plugin(Precognition);
Alpine.start();

安装并注册 Laravel 预知包后，您现在可以使用预知的 $form “魔法”创建一个表单对象，提供 HTTP 方法（post）、目标 URL（/users）和初始表单数据。

为了启用实时验证，您应该将表单的数据绑定到其相关输入，然后监听每个输入的 change 事件。在 change 事件处理程序中，您应该调用表单的 validate 方法，提供输入的名称：

html
<form x-data="{
    form: $form('post', '/register', {
        name: '',
        email: '',
    }),
}">
    @csrf
    <label for="name">姓名</label>
    <input
        id="name"
        name="name"
        x-model="form.name"
        @change="form.validate('name')"
    />
    <template x-if="form.invalid('name')">
        <div x-text="form.errors.name"></div>
    </template>

    <label for="email">电子邮件</label>
    <input
        id="email"
        name="email"
        x-model="form.email"
        @change="form.validate('email')"
    />
    <template x-if="form.invalid('email')">
        <div x-text="form.errors.email"></div>
    </template>

    <button :disabled="form.processing">
        创建用户
    </button>
</form>

现在，当用户填写表单时，预知将提供由路由的表单请求中的验证规则驱动的实时验证输出。当表单的输入被更改时，将向您的 Laravel 应用程序发送一个去抖动的“预知”验证请求。您可以通过调用表单的 setValidationTimeout 函数来配置去抖动超时：

js
form.setValidationTimeout(3000);

当验证请求正在进行时，表单的 validating 属性将为 true：

html
<template x-if="form.validating">
    <div>正在验证...</div>
</template>

在验证请求或表单提交期间返回的任何验证错误将自动填充表单的 errors 对象：

html
<template x-if="form.invalid('email')">
    <div x-text="form.errors.email"></div>
</template>

您可以使用表单的 hasErrors 属性来确定表单是否有任何错误：

html
<template x-if="form.hasErrors">
    <div><!-- ... --></div>
</template>

您还可以通过将输入的名称传递给表单的 valid 和 invalid 函数来确定输入是否通过或未通过验证：

html
<template x-if="form.valid('email')">
    <span>✅</span>
</template>

<template x-if="form.invalid('email')">
    <span>❌</span>
</template>
exclamation

表单输入只有在更改并收到验证响应后才会显示为有效或无效。

正如我们所看到的，您可以挂钩到输入的 change 事件并在用户与之交互时验证单个输入；但是，您可能需要验证用户尚未与之交互的输入。这在构建“向导”时很常见，您希望在移动到下一步之前验证所有可见输入，无论用户是否与之交互。

要使用预知执行此操作，您应该标记您希望验证的字段为“已触摸”，通过将它们的名称传递给 touch 方法。然后，调用 validate 方法并提供 onSuccess 或 onValidationError 回调：

html
<button
    type="button"
    @change="form.touch(['name', 'email', 'phone']).validate({
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })"
>下一步</button>

您可以通过检查表单的 processing 属性来确定表单提交请求是否正在进行：

html
<button :disabled="form.processing">
    提交
</button>

重新填充旧表单数据 ​

在上述用户创建示例中，我们使用预知执行实时验证；但是，我们正在执行传统的服务器端表单提交以提交表单。因此，表单应该填充任何从服务器端表单提交返回的“旧”输入和验证错误：

html
<form x-data="{
    form: $form('post', '/register', {
        name: '{{ old('name') }}',
        email: '{{ old('email') }}',
    }).setErrors({{ Js::from($errors->messages()) }}),
}">

或者，如果您希望通过 XHR 提交表单，您可以使用表单的 submit 函数，该函数返回一个 Axios 请求承诺：

html
<form
    x-data="{
        form: $form('post', '/register', {
            name: '',
            email: '',
        }),
        submit() {
            this.form.submit()
                .then(response => {
                    form.reset();

                    alert('用户已创建。')
                })
                .catch(error => {
                    alert('发生错误。');
                });
        },
    }"
    @submit.prevent="submit"
>

配置 Axios ​

预知验证库使用 Axios HTTP 客户端向您的应用程序后端发送请求。为了方便起见，如果您的应用程序需要，Axios 实例可以自定义。例如，当使用 laravel-precognition-vue 库时，您可以在应用程序的 resources/js/app.js 文件中为每个传出的请求添加额外的请求头：

js
import { client } from 'laravel-precognition-vue';

client.axios().defaults.headers.common['Authorization'] = authToken;

或者，如果您已经为您的应用程序配置了 Axios 实例，您可以告诉预知使用该实例：

js
import Axios from 'axios';
import { client } from 'laravel-precognition-vue';

window.axios = Axios.create()
window.axios.defaults.headers.common['Authorization'] = authToken;

client.use(window.axios)
exclamation

带有 Inertia 风味的预知库将仅使用配置的 Axios 实例进行验证请求。表单提交将始终通过 Inertia 发送。

自定义验证规则 ​

可以通过使用请求的 isPrecognitive 方法自定义在预知请求期间执行的验证规则。

例如，在用户创建表单上，我们可能希望仅在最终表单提交时验证密码是否“未泄露”。对于预知验证请求，我们只需验证密码是必需的并且至少有 8 个字符。使用 isPrecognitive 方法，我们可以自定义表单请求中定义的规则：

php
<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rules\Password;

class StoreUserRequest extends FormRequest
{
    /**
     * 获取适用于请求的验证规则。
     *
     * @return array
     */
    protected function rules()
    {
        return [
            'password' => [
                'required',
                $this->isPrecognitive()
                    ? Password::min(8)
                    : Password::min(8)->uncompromised(),
            ],
            // ...
        ];
    }
}

处理文件上传 ​

默认情况下，Laravel 预知不会在预知验证请求期间上传或验证文件。这确保不会不必要地多次上传大文件。

由于这种行为，您应该确保您的应用程序 自定义相应的表单请求的验证规则，以指定该字段仅在完整表单提交时为必需：

php
/**
 * 获取适用于请求的验证规则。
 *
 * @return array
 */
protected function rules()
{
    return [
        'avatar' => [
            ...$this->isPrecognitive() ? [] : ['required'],
            'image',
            'mimes:jpg,png',
            'dimensions:ratio=3/2',
        ],
        // ...
    ];
}

如果您希望在每个验证请求中包含文件，您可以在客户端表单实例上调用 validateFiles 函数：

js
form.validateFiles();

管理副作用 ​

在将 HandlePrecognitiveRequests 中间件添加到路由时，您应该考虑是否有任何其他中间件的副作用在预知请求期间应该被跳过。

例如，您可能有一个中间件会增加每个用户与您的应用程序的“交互”总数，但您可能不希望将预知请求计入交互。为了实现这一点，我们可以在增加交互计数之前检查请求的 isPrecognitive 方法：

php
<?php

namespace App\Http\Middleware;

use App\Facades\Interaction;
use Closure;
use Illuminate\Http\Request;

class InteractionMiddleware
{
    /**
     * 处理传入请求。
     */
    public function handle(Request $request, Closure $next): mixed
    {
        if (! $request->isPrecognitive()) {
            Interaction::incrementFor($request->user());
        }

        return $next($request);
    }
}

测试 ​

如果您希望在测试中进行预知请求，Laravel 的 TestCase 包含一个 withPrecognition 辅助函数，该函数将添加 Precognition 请求头。

此外，如果您希望断言预知请求成功，例如，没有返回任何验证错误，您可以在响应上使用 assertSuccessfulPrecognition 方法：

php
it('validates registration form with precognition', function () {
    $response = $this->withPrecognition()
        ->post('/register', [
            'name' => 'Taylor Otwell',
        ]);

    $response->assertSuccessfulPrecognition();

    expect(User::count())->toBe(0);
});
php
public function test_it_validates_registration_form_with_precognition()
{
    $response = $this->withPrecognition()
        ->post('/register', [
            'name' => 'Taylor Otwell',
        ]);

    $response->assertSuccessfulPrecognition();
    $this->assertSame(0, User::count());
}

版权所有 © 2024-2025 laravel.wiki