? Laravel 表单请求的自定义错误格式与验证失败的重定向策略：一场轻松的技术讲座

大家好！欢迎来到今天的 Laravel 技术讲座 ?。今天我们要聊的是一个非常实用的话题——表单请求的自定义错误格式和验证失败的重定向策略。如果你曾经被 Laravel 的验证机制搞得头大，那么这篇文章一定会让你豁然开朗 ?。

在正式开始之前，先来个简单的热身问题：你知道 Laravel 默认的验证错误是什么样的吗？? 没错，默认情况下，Laravel 会返回一个 JSON 格式的数据或者将用户重定向到上一页，并附带错误消息。但有时候，这些默认行为并不能满足我们的需求，比如我们需要自定义错误格式，或者在验证失败时跳转到一个特定页面。别担心，今天我们就会解决这些问题！

---

? 第一章：自定义错误格式

1.1 默认的错误格式

Laravel 默认的错误格式长这样：

{
    "message": "The given data was invalid.",
    "errors": {
        "name": ["The name field is required."],
        "email": ["The email must be a valid email address."]
    }
}

这看起来还不错，但如果我们的 API 需要与其他系统集成，或者我们想让前端开发者更容易处理错误，就需要对这个格式进行调整。

1.2 自定义错误格式的方法

Laravel 提供了一个非常强大的工具——FormRequest，它可以帮助我们实现自定义错误格式。

步骤 1：创建 FormRequest 类

首先，使用 Artisan 命令创建一个新的 FormRequest 类：

php artisan make:request CustomErrorFormatRequest

步骤 2：重写 failedValidation 方法

在生成的 CustomErrorFormatRequest 类中，找到 failedValidation 方法并重写它：

use IlluminateContractsValidationValidator;
use IlluminateHttpExceptionsHttpResponseException;

public function failedValidation(Validator $validator)
{
    // 自定义错误格式
    $errors = [
        'status' => 'error',
        'messages' => $validator->errors()->all(),
    ];

    throw new HttpResponseException(response()->json($errors, 422));
}

结果

现在，当验证失败时，返回的 JSON 数据会变成这样：

{
    "status": "error",
    "messages": [
        "The name field is required.",
        "The email must be a valid email address."
    ]
}

是不是更符合你的需求了？?

---

? 第二章：验证失败的重定向策略

2.1 默认的重定向行为

默认情况下，Laravel 会在验证失败时将用户重定向到上一页（通常是表单所在的页面），并附带错误消息。例如：

return redirect()
    ->back()
    ->withErrors($validator)
    ->withInput();

这种行为对于大多数场景来说已经足够了，但在某些情况下，你可能希望用户被重定向到一个特定的页面，而不是简单地回到上一页。

2.2 自定义重定向策略

我们可以通过重写 FormRequest 中的 redirectRoute 或 redirectUrl 方法来实现这一点。

示例 1：重定向到指定路由

假设我们希望在验证失败时将用户重定向到 home 路由，可以这样做：

public function redirectRoute()
{
    return 'home';
}

示例 2：重定向到指定 URL

如果需要重定向到一个具体的 URL，可以使用 redirectUrl 方法：

public function redirectUrl()
{
    return '/custom-error-page';
}

示例 3：动态重定向

有时候，重定向的目标可能需要根据用户的输入动态决定。我们可以结合 rules 方法中的逻辑来实现这一点：

public function redirectUrl()
{
    if ($this->input('type') === 'admin') {
        return '/admin/dashboard';
    }

    return '/user/profile';
}

---

? 第三章：实战演练

为了让大家更好地理解，我们来看一个完整的例子。假设我们有一个用户注册表单，需要实现以下功能：

1. 如果验证失败，返回自定义的 JSON 错误格式。
2. 如果是 API 请求，直接返回 JSON；如果是普通请求，重定向到 /register/error 页面。

创建 FormRequest 类

php artisan make:request RegisterUserRequest

编辑 RegisterUserRequest 类

namespace AppHttpRequests;

use IlluminateFoundationHttpFormRequest;
use IlluminateContractsValidationValidator;
use IlluminateHttpExceptionsHttpResponseException;

class RegisterUserRequest extends FormRequest
{
    public function authorize()
    {
        return true;
    }

    public function rules()
    {
        return [
            'name' => 'required|string|max:255',
            'email' => 'required|email|unique:users',
            'password' => 'required|min:8',
        ];
    }

    public function failedValidation(Validator $validator)
    {
        if ($this->wantsJson()) {
            // 返回自定义 JSON 格式
            $errors = [
                'status' => 'error',
                'messages' => $validator->errors()->all(),
            ];

            throw new HttpResponseException(response()->json($errors, 422));
        }

        // 重定向到 /register/error
        throw new HttpResponseException(
            redirect('/register/error')
                ->withErrors($validator)
                ->withInput()
        );
    }
}

---

? 第四章：参考国外技术文档

1. Laravel 官方文档：Laravel 提供了详细的文档说明如何使用 FormRequest 和自定义验证逻辑。

   • 关键词：FormRequest, failedValidation, authorize, rules

2. Stack Overflow：很多开发者分享了他们如何通过重写 failedValidation 方法来自定义错误格式。

   • 关键词：Custom error format in Laravel validation

3. Laracasts：这是一个非常受欢迎的 Laravel 教程网站，其中有很多关于表单验证的视频教程。

   • 关键词：Laravel form request customization

---

? 总结

今天我们一起探讨了如何在 Laravel 中实现表单请求的自定义错误格式和验证失败的重定向策略。通过 FormRequest 类，我们可以轻松地控制验证失败时的行为，无论是返回自定义的 JSON 格式，还是将用户重定向到特定页面，都变得轻而易举。

希望这篇文章能对你有所帮助！如果有任何问题，欢迎在评论区留言 ?。下次见啦，拜拜?！