Laravel FormRequest 获取路由参数与验证错误处理

本文旨在解决 Laravel 中使用 FormRequest 进行请求验证时，如何访问路由参数以及自定义验证错误处理的问题。通过示例代码和详细解释，帮助开发者理解如何在控制器和 FormRequest 类中获取路由参数，并提供自定义验证错误消息和逻辑的方法，从而更好地控制应用程序的验证流程。

访问路由参数

当在 Laravel 中使用 FormRequest 进行请求验证时，可能会遇到需要在控制器中访问路由参数的情况。以下介绍两种方法：

方法一：在控制器方法中同时声明 FormRequest 和路由参数

这是推荐的方法，因为它明确地将路由参数暴露给控制器方法。可以在控制器方法的签名中同时声明 FormRequest 实例和路由参数。Laravel 会自动将路由参数注入到方法中。

namespace App\Http\Controllers;

use App\Http\Requests\ShowRequest;
use App\Models\User;

class UserController extends Controller
{
    public function show(ShowRequest $request, string $name)
    {
        // 现在可以在 $name 变量中访问路由参数 'name'
        // 例如：
        // dd($name);

        // 也可以通过 $request 实例访问经过验证的请求数据
        // 例如：
        // dd($request->validated());

        // ... 其他逻辑
    }
}

在这个例子中，$name 变量将包含路由参数 name 的值。

方法二：通过 request 对象访问

虽然不推荐，但可以通过 request 对象访问路由参数。在控制器方法中，可以通过 $request->input('name') 或 $request->route('name') 来访问路由参数。

namespace App\Http\Controllers;

use App\Http\Requests\ShowRequest;

class UserController extends Controller
{
    public function show(ShowRequest $request)
    {
        // 通过 $request->input('name') 访问路由参数 'name'
        $name = $request->input('name');
        // 或者通过 $request->route('name')
        // $name = $request->route('name');

        // ... 其他逻辑
    }
}

建议使用第一种方法，因为它更清晰、更易于维护。

自定义验证错误处理

Laravel 默认的验证错误处理机制通常已经足够使用，但有时可能需要进行更精细的控制。以下介绍几种自定义验证错误处理的方法：

1. 自定义错误消息

可以在 FormRequest 类中定义 messages() 方法，以自定义验证规则对应的错误消息。

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

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

    public function rules()
    {
        return [
            'name' => 'required|string|max:255',
        ];
    }

    public function messages()
    {
        return [
            'name.required' => '名称是必填项。',
            'name.string' => '名称必须是字符串。',
            'name.max' => '名称不能超过 255 个字符。',
        ];
    }
}

在这个例子中，我们为 name 字段的 required、string 和 max 规则定义了自定义错误消息。

2. 在路由中添加验证约束

可以通过在路由定义中使用 where() 方法添加验证约束。这对于验证路由参数非常有用。

use Illuminate\Support\Facades\Route;

Route::get('/user/{name}', 'App\Http\Controllers\UserController@show')->where(['name' => '[a-zA-Z]+']);

这个路由定义要求 name 参数只能包含字母。

3. 隐式模型绑定

如果路由参数对应于数据库中的一个字段，可以使用隐式模型绑定。首先，在模型中定义 getRouteKeyName() 方法，指定用于路由绑定的字段。

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    public function getRouteKeyName()
    {
        return 'name';
    }
}

然后，在路由定义中使用模型类型提示。

use Illuminate\Support\Facades\Route;
use App\Models\User;
use App\Http\Controllers\UserController;

Route::get('/user/{user:name}', [UserController::class, 'show']);

最后，修改控制器方法，接收 User 实例。

namespace App\Http\Controllers;

use App\Http\Requests\ShowRequest;
use App\Models\User;

class UserController extends Controller
{
    public function show(ShowRequest $request, User $user)
    {
        // 现在可以通过 $user 变量访问数据库中的 User 模型
        // 例如：
        // dd($user);

        // ... 其他逻辑
    }
}

如果 name 参数在数据库中找不到对应的 User 模型，Laravel 会自动返回 404 错误。

4. 手动处理验证错误

虽然 FormRequest 会自动处理验证错误，但也可以手动处理。可以在控制器方法中调用 Validator::make() 方法，然后检查验证结果。

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

class UserController extends Controller
{
    public function store(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'name' => 'required|string|max:255',
        ]);

        if ($validator->fails()) {
            // 自定义验证失败的处理逻辑
            return response()->json(['errors' => $validator->errors()], 422);
        }

        // ... 其他逻辑
    }
}

在这个例子中，如果验证失败，我们会返回一个包含错误信息的 JSON 响应，状态码为 422。

总结

通过本文，我们学习了在 Laravel 中使用 FormRequest 时如何访问路由参数以及自定义验证错误处理的方法。掌握这些技巧可以帮助我们更好地控制应用程序的验证流程，并提供更友好的用户体验。记住，选择最适合你需求的方案，并始终保持代码的清晰和可维护性。