Precognition

簡介
即時驗證
驗證陣列
自訂驗證規則
處理檔案上傳
管理副作用
測試

簡介

Laravel Precognition 允許您預測未來 HTTP 請求的結果。Precognition 的主要用例之一是能夠為前端 JavaScript 應用程式提供「即時」驗證，而無需複製應用程式的後端驗證規則。

當 Laravel 接收到「預知請求」時，它將執行所有路由的中介層並解析路由的控制器依賴項，包括驗證表單請求——但它不會實際執行路由的控制器方法。

[!NOTE] 從 Inertia 2.3 開始，Precognition 支援是內建的。請查閱 Inertia 表單文件以獲取更多資訊。較早的 Inertia 版本需要 Precognition 0.x。

即時驗證

使用 Vue

使用 Laravel Precognition，您可以為使用者提供即時驗證體驗，而無需在前端 Vue 應用程式中複製驗證規則。為了說明其工作原理，讓我們在應用程式中建立一個用於建立新使用者的表單。

首先，要為路由啟用 Precognition，應將 HandlePrecognitiveRequests 中介層添加到路由定義中。您還應該建立一個表單請求來存放路由的驗證規則：

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

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

接下來，您應該透過 NPM 安裝 Laravel Precognition 的 Vue 前端輔助工具：

npm install laravel-precognition-vue

安裝 Laravel Precognition 套件後，您現在可以使用 Precognition 的 useForm 函數建立一個表單物件，提供 HTTP 方法（post）、目標 URL（/users）和初始表單資料。

然後，要啟用即時驗證，請在每個輸入的 change 事件上呼叫表單的 validate 方法，並提供輸入的名稱：

<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">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">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">
            Create User
        </button>
    </form>
</template>

現在，隨著使用者填寫表單，Precognition 將提供由路由表單請求中的驗證規則驅動的即時驗證輸出。當表單的輸入發生變更時，一個防抖的「預知」驗證請求將被發送到您的 Laravel 應用程式。您可以透過呼叫表單的 setValidationTimeout 函數來配置防抖超時：

form.setValidationTimeout(3000);

當驗證請求正在進行時，表單的 validating 屬性將為 true：

<div v-if="form.validating">
    Validating...
</div>

在驗證請求或表單提交期間返回的任何驗證錯誤將自動填充表單的 errors 物件：

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

您可以使用表單的 hasErrors 屬性判斷表單是否有任何錯誤：

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

您還可以透過分別將輸入的名稱傳遞給表單的 valid 和 invalid 函數來判斷輸入是否通過或未通過驗證：

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

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

[!WARNING] 表單輸入只有在發生變更並收到驗證回應後才會顯示為有效或無效。

如果您正在使用 Precognition 驗證表單輸入的子集，手動清除錯誤可能很有用。您可以使用表單的 forgetError 函數來實現：

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

        form.forgetError('avatar')
    }"
>

如我們所見，您可以掛鉤到輸入的 change 事件，並在使用者與它們互動時驗證個別輸入；但是，您可能需要驗證使用者尚未互動的輸入。這在建立「向導」時很常見，您希望在進入下一步之前驗證所有可見的輸入，無論使用者是否與它們互動過。

要使用 Precognition 實現這一點，您應該呼叫 validate 方法，將您希望驗證的欄位名稱傳遞給 only 配置鍵。您可以使用 onSuccess 或 onValidationError 回呼來處理驗證結果：

<button
    type="button"
    @click="form.validate({
        only: ['name', 'email', 'phone'],
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })"
>Next Step</button>

當然，您也可以根據表單提交的回應來執行程式碼。表單的 submit 函數返回一個 Axios 請求 Promise。這提供了一種便利的方式來存取回應有效載荷、在成功提交時重設表單輸入或處理失敗的請求：

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

        alert('User created.');
    })
    .catch(error => {
        alert('An error occurred.');
    });

您可以透過檢查表單的 processing 屬性來判斷表單提交請求是否正在進行：

<button :disabled="form.processing">
    Submit
</button>

使用 React

使用 Laravel Precognition，您可以為使用者提供即時驗證體驗，而無需在前端 React 應用程式中複製驗證規則。為了說明其工作原理，讓我們在應用程式中建立一個用於建立新使用者的表單。

首先，要為路由啟用 Precognition，應將 HandlePrecognitiveRequests 中介層添加到路由定義中。您還應該建立一個表單請求來存放路由的驗證規則：

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

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

接下來，您應該透過 NPM 安裝 Laravel Precognition 的 React 前端輔助工具：

npm install laravel-precognition-react

要啟用即時驗證，您應該監聽每個輸入的 change 和 blur 事件。在 change 事件處理器中，您應該使用 setData 函數設定表單的資料，並傳遞輸入的名稱和新值。然後，在 blur 事件處理器中呼叫表單的 validate 方法，並提供輸入的名稱：

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">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">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}>
                Create User
            </button>
        </form>
    );
};

form.setValidationTimeout(3000);

當驗證請求正在進行時，表單的 validating 屬性將為 true：

{form.validating && <div>Validating...</div>}

在驗證請求或表單提交期間返回的任何驗證錯誤將自動填充表單的 errors 物件：

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

您可以使用表單的 hasErrors 屬性判斷表單是否有任何錯誤：

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

您還可以透過分別將輸入的名稱傳遞給表單的 valid 和 invalid 函數來判斷輸入是否通過或未通過驗證：

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

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

[!WARNING] 表單輸入只有在發生變更並收到驗證回應後才會顯示為有效或無效。

如果您正在使用 Precognition 驗證表單輸入的子集，手動清除錯誤可能很有用。您可以使用表單的 forgetError 函數來實現：

<input
    id="avatar"
    type="file"
    onChange={(e) => {
        form.setData('avatar', e.target.files[0]);

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

如我們所見，您可以掛鉤到輸入的 blur 事件，並在使用者與它們互動時驗證個別輸入；但是，您可能需要驗證使用者尚未互動的輸入。這在建立「向導」時很常見，您希望在進入下一步之前驗證所有可見的輸入，無論使用者是否與它們互動過。

<button
    type="button"
    onClick={() => form.validate({
        only: ['name', 'email', 'phone'],
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })}
>Next Step</button>

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

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

            alert('User created.');
        })
        .catch(error => {
            alert('An error occurred.');
        });
};

您可以透過檢查表單的 processing 屬性來判斷表單提交請求是否正在進行：

<button disabled={form.processing}>
    Submit
</button>

使用 Alpine 和 Blade

使用 Laravel Precognition，您可以為使用者提供即時驗證體驗，而無需在前端 Alpine 應用程式中複製驗證規則。為了說明其工作原理，讓我們在應用程式中建立一個用於建立新使用者的表單。

首先，要為路由啟用 Precognition，應將 HandlePrecognitiveRequests 中介層添加到路由定義中。您還應該建立一個表單請求來存放路由的驗證規則：

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

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

接下來，您應該透過 NPM 安裝 Laravel Precognition 的 Alpine 前端輔助工具：

npm install laravel-precognition-alpine

然後，在 resources/js/app.js 檔案中向 Alpine 註冊 Precognition 外掛：

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

window.Alpine = Alpine;

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

安裝並註冊 Laravel Precognition 套件後，您現在可以使用 Precognition 的 $form「魔法」建立一個表單物件，提供 HTTP 方法（post）、目標 URL（/users）和初始表單資料。

要啟用即時驗證，您應該將表單的資料綁定到其相關輸入，然後監聽每個輸入的 change 事件。在 change 事件處理器中，您應該呼叫表單的 validate 方法，並提供輸入的名稱：

<form x-data="{
    form: $form('post', '/register', {
        name: '',
        email: '',
    }),
}">
    @csrf
    <label for="name">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">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">
        Create User
    </button>
</form>

form.setValidationTimeout(3000);

當驗證請求正在進行時，表單的 validating 屬性將為 true：

<template x-if="form.validating">
    <div>Validating...</div>
</template>

在驗證請求或表單提交期間返回的任何驗證錯誤將自動填充表單的 errors 物件：

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

您可以使用表單的 hasErrors 屬性判斷表單是否有任何錯誤：

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

您還可以透過分別將輸入的名稱傳遞給表單的 valid 和 invalid 函數來判斷輸入是否通過或未通過驗證：

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

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

[!WARNING] 表單輸入只有在發生變更並收到驗證回應後才會顯示為有效或無效。

<button
    type="button"
    @click="form.validate({
        only: ['name', 'email', 'phone'],
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })"
>Next Step</button>

您可以透過檢查表單的 processing 屬性來判斷表單提交請求是否正在進行：

<button :disabled="form.processing">
    Submit
</button>

重新填充舊表單資料

在上面討論的使用者建立範例中，我們使用 Precognition 進行即時驗證；但是，我們正在執行傳統的伺服器端表單提交來提交表單。因此，表單應填充伺服器端表單提交返回的任何「舊」輸入和驗證錯誤：

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

或者，如果您希望透過 XHR 提交表單，可以使用表單的 submit 函數，該函數返回一個 Axios 請求 Promise：

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

                    alert('User created.')
                })
                .catch(error => {
                    alert('An error occurred.');
                });
        },
    }"
    @submit.prevent="submit"
>

配置 Axios

Precognition 驗證函式庫使用 Axios HTTP 客戶端向應用程式的後端發送請求。為了方便，Axios 實例可以根據應用程式的需求進行自訂。例如，使用 laravel-precognition-vue 函式庫時，您可以在應用程式的 resources/js/app.js 檔案中向每個外發請求添加額外的請求標頭：

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

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

或者，如果您已經為應用程式配置了 Axios 實例，可以告知 Precognition 改用該實例：

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)

驗證陣列

您可以使用萬用字元來驗證陣列或巢狀物件中的欄位。每個 * 匹配一個路徑段：

// 驗證陣列中所有使用者的電子郵件...
form.validate('users.*.email');

// 驗證 profile 物件中的所有欄位...
form.validate('profile.*');

// 驗證所有使用者的所有欄位...
form.validate('users.*.*');

自訂驗證規則

可以使用請求的 isPrecognitive 方法來自訂在預知請求期間執行的驗證規則。

例如，在使用者建立表單上，我們可能希望僅在最終表單提交時驗證密碼是否「未洩露」。對於預知驗證請求，我們將簡單地驗證密碼是必需的且最少 8 個字元。使用 isPrecognitive 方法，我們可以自訂表單請求定義的規則：

<?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 Precognition 不會在預知驗證請求期間上傳或驗證檔案。這確保了大檔案不會被不必要地多次上傳。

由於此行為，您應確保應用程式自訂相應表單請求的驗證規則，以指定該欄位僅在完整表單提交時為必需：

/**
 * 獲取適用於請求的驗證規則。
 *
 * @return array
 */
protected function rules()
{
    return [
        'avatar' => [
            ...$this->isPrecognitive() ? [] : ['required'],
            'image',
            'mimes:jpg,png',
            'dimensions:ratio=3/2',
        ],
        // ...
    ];
}

如果您希望在每個驗證請求中都包含檔案，可以呼叫客戶端表單實例上的 validateFiles 函數：

form.validateFiles();

管理副作用

將 HandlePrecognitiveRequests 中介層添加到路由時，您應該考慮其他中介層中是否有任何副作用應在預知請求期間被跳過。

例如，您可能有一個中介層用於遞增每個使用者與應用程式的「互動」總數，但您可能不希望預知請求被計為一次互動。為此，我們可以在遞增互動計數之前檢查請求的 isPrecognitive 方法：

<?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 方法：

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

    $response->assertSuccessfulPrecognition();

    expect(User::count())->toBe(0);
});

public function test_it_validates_registration_form_with_precognition()
{
    $response = $this->withPrecognition()
        ->post('/register', [
            'name' => 'Taylor Otwell',
        ]);

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