Precognition

• 簡介
• 即時驗證
  • 使用 Vue
  • 使用 React
  • 使用 Alpine 與 Blade
  • 設定 Axios
• 驗證陣列
• 自定義驗證規則
• 處理檔案上傳
• 管理副作用
• 測試

簡介

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

當 Laravel 收到一個「預知性請求 (precognitive request)」時，它會執行該路由所有的中介層並解析路由的控制器依賴，包含驗證 表單請求 (form requests) —— 但它實際上並不會執行該路由的控制器方法。

📌 備註

自 Inertia 2.3 起，已內建 Precognition 支援。請參閱 Inertia 表單文件 以取得更多資訊。較早版本的 Inertia 則需要 Precognition 0.x。

即時驗證

使用 Vue

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

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

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

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

接下來，您應該透過 NPM 安裝適用於 Vue 的 Laravel Precognition 前端輔助套件：

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 將根據路由表單請求中的驗證規則提供即時驗證輸出。當表單輸入內容變更時，一個經過防抖 (Debounced) 處理的「預認 (Precognitive)」驗證請求將被發送到您的 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>

⚠️ 警告

表單輸入欄位僅在發生變更並收到驗證回應後，才會顯示為有效或無效。

如果您正在使用 Precognition 驗證表單輸入的子集，手動清除錯誤可能會很有用。您可以使用表單的 forgetError 函式來達成此目的：

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

        form.forgetError('avatar')
    }"
>

正如我們所見，您可以掛鉤到輸入欄位的 change 事件，並在使用者與其互動時驗證個別輸入；然而，您可能需要驗證使用者尚未與其互動過的輸入欄位。這在建立「引導精靈 (Wizard)」時很常見，您會希望在進入下一步之前，驗證所有可見的輸入欄位，無論使用者是否已經與其互動過。

若要使用 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。這提供了一種方便的方法來存取回應內容 (Payload)、在成功提交後重設表單輸入，或處理失敗的請求：

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 中介層加入路由定義中。您還應該建立一個 表單請求 (Form Request) 來放置路由的驗證規則：

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

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

接著，您應該透過 NPM 安裝適用於 React 的 Laravel Precognition 前端輔助工具：

npm install laravel-precognition-react

安裝好 Laravel Precognition 套件後，您現在可以使用 Precognition 的 useForm 函式來建立一個表單物件，並提供 HTTP 方法 (post)、目標 URL (/users) 以及初始表單資料。

要啟用即時驗證，您應該監聽每個輸入的 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>
    );
};

現在，當使用者填寫表單時，Precognition 將提供由路由表單請求中的驗證規則所驅動的即時驗證輸出。當表單輸入發生變化時，一個經過防震 (debounced) 處理的「預知 (precognitive)」驗證請求將被發送到您的 Laravel 應用程式。您可以透過呼叫表單的 setValidationTimeout 函式來設定防震超時時間：

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>}

⚠️ 警告

只有在表單輸入發生更改且收到驗證回應後，輸入才會顯示為有效或無效。

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

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

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

正如我們所見，您可以掛接到輸入的 blur 事件，並在使用者與其互動時驗證個別輸入；但是，您可能需要驗證使用者尚未互動過的輸入。這在構建「精靈 (wizard)」介面時很常見，您希望在進入下一步之前驗證所有可見的輸入，無論使用者是否與其互動過。

要使用 Precognition 執行此操作，您應該呼叫 validate 方法，並將您希望驗證的欄位名稱傳遞給 only 設定鍵。您可以使用 onSuccess 或 onValidationError 回呼來處理驗證結果：

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

當然，您也可以針對表單提交的回應執行相對應的程式碼。表單的 submit 函式會回傳一個 Axios 請求的 Promise。這提供了一種便捷的方式來存取回應的承載內容 (payload)、在表單提交成功時重設表單輸入，或處理失敗的請求：

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 中介層加入到路由定義中。您還應該建立一個 表單請求 (Form Request) 來存放路由的驗證規則：

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

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

接著，您應該透過 NPM 安裝適用於 Alpine 的 Laravel Precognition 前端輔助工具：

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「Magic」，提供 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>

現在，當使用者填寫表單時，Precognition 將提供由路由表單請求中的驗證規則所驅動的即時驗證輸出。當表單的輸入內容變更時，一個經過「去彈跳 (debounced)」處理的「預判 (precognitive)」驗證請求將發送到您的 Laravel 應用程式。您可以透過呼叫表單的 setValidationTimeout 函式來設定去彈跳的超時時間：

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>

⚠️ 警告

表單輸入框只有在內容變更且收到驗證回應後，才會顯示為有效或無效。

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

若要使用 Precognition 執行此操作，您應該呼叫 validate 方法，並將您想要驗證的欄位名稱傳遞給 only 設定鍵。您可以使用 onSuccess 或 onValidationError 回呼來處理驗證結果：

<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 來執行即時驗證；但是，我們是執行傳統的伺服器端表單提交來提交表單。因此，表單應該要被填充從伺服器端表單提交回傳的任何「舊的 (old)」輸入內容與驗證錯誤：

<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)

驗證陣列

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

// Validate email for all users in an array...
form.validate('users.*.email');

// Validate all fields in a profile object...
form.validate('profile.*');

// Validate all fields for all users...
form.validate('users.*.*');

自定義驗證規則

您可以使用請求的 isPrecognitive 方法來客製化在 Precognition 請求期間執行的驗證規則。

例如，在建立使用者的表單中，我們可能希望僅在最終提交表單時才驗證密碼是否為 "uncompromised" (未洩漏)。對於 Precognition 驗證請求，我們只需驗證密碼為必填且至少 8 個字元。使用 isPrecognitive 方法，我們可以自定義由 form request 定義的規則：

<?php

namespace App\Http\Requests;

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

class StoreUserRequest extends FormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    protected function rules()
    {
        return [
            'password' => [
                'required',
                $this->isPrecognitive()
                    ? Password::min(8)
                    : Password::min(8)->uncompromised(),
            ],
            // ...
        ];
    }
}

處理檔案上傳

預設情況下，Laravel Precognition 不會在 Precognition 驗證請求期間上傳或驗證檔案。這可以確保大檔案不會被不必要地重複上傳多次。

由於這種行為，您應該確保您的應用程式自定義對應的 form request 驗證規則，以指定該欄位僅在完整表單提交時才是必填的：

/**
 * Get the validation rules that apply to the request.
 *
 * @return array
 */
protected function rules()
{
    return [
        'avatar' => [
            ...$this->isPrecognitive() ? [] : ['required'],
            'image',
            'mimes:jpg,png',
            'dimensions:ratio=3/2',
        ],
        // ...
    ];
}

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

form.validateFiles();

管理副作用

當為路由加入 HandlePrecognitiveRequests 中介層時，您應該考慮是否在「其他」中介層中存在應在 Precognition 請求期間跳過的副作用。

例如，您可能有一個中介層會增加每個使用者與應用程式的「互動 (interactions)」總數，但您可能不希望 Precognition 請求被計為一次互動。為了實現這一點，我們可以在增加互動計數之前檢查請求的 isPrecognitive 方法：

<?php

namespace App\Http\Middleware;

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

class InteractionMiddleware
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next): mixed
    {
        if (! $request->isPrecognitive()) {
            Interaction::incrementFor($request->user());
        }

        return $next($request);
    }
}

測試

如果您想在測試中發送 Precognition 請求，Laravel 的 TestCase 包含了一個 withPrecognition 輔助函式，它會加入 Precognition 請求標頭。

此外，如果您想斷言 Precognition 請求是否成功（例如，沒有回傳任何驗證錯誤），您可以在回應上使用 assertSuccessfulPrecognition 方法：

Pest

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

    $response->assertSuccessfulPrecognition();

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

PHPUnit

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

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