laravel 中的表单请求通过将验证和授权逻辑抽离至专用类中,使控制器更简洁。1. 使用 artisan 命令生成表单请求类;2. 在 rules() 方法中定义验证规则,并可通过 messages() 自定义错误提示;3. authorize() 方法用于检查用户权限;4. 控制器方法类型提示该类以自动触发验证;5. 可重写 failedvalidation 方法自定义错误响应;6. 对复杂逻辑可创建并使用自定义验证规则类,如 ensureageisappropriate。
表单请求在 laravel 中扮演着数据验证和授权的双重角色,它们能让控制器更简洁,逻辑更清晰。简单来说,就是把验证规则和权限检查从控制器里抽离出来,放到一个专门的类里去处理。
使用表单请求,可以有效提高代码的可维护性和可读性,减少控制器中的代码量,使逻辑更加集中。
解决方案
-
生成表单请求类:
使用 Artisan 命令生成一个表单请求类。例如,要创建一个用于处理用户创建请求的表单请求,可以运行:
php artisan make:request StoreUserRequest
这会在 app/http/Requests 目录下生成一个 StoreUserRequest.php 文件。
-
定义验证规则:
打开生成的表单请求类,你会看到 rules() 方法。在这里定义你的验证规则。例如:
<?php namespace AppHttpRequests; use IlluminateFoundationHttpFormRequest; class StoreUserRequest extends FormRequest { /** * Determine if the user is authorized to make this request. * * @return bool */ public function authorize() { // 检查用户是否有权限创建用户,例如: return auth()->check() && auth()->user()->can('create-user'); // 或者,如果所有用户都可以创建,则返回 true // return true; } /** * Get the validation rules that apply to the request. * * @return array */ public function rules() { return [ 'name' => 'required|string|max:255', 'email' => 'required|email|unique:users,email', 'password' => 'required|min:8|confirmed', ]; } public function messages() { return [ 'name.required' => '名字是必填的.', 'email.required' => '邮箱是必填的.', 'email.email' => '邮箱格式不正确.', 'email.unique' => '该邮箱已被注册.', 'password.required' => '密码是必填的.', 'password.min' => '密码至少8位.', 'password.confirmed' => '两次密码不一致.', ]; } }
authorize() 方法用于确定当前用户是否有权执行此请求。rules() 方法定义了验证规则。 messages() 方法定义了自定义错误信息,用于覆盖默认的错误提示。
-
在控制器中使用表单请求:
在你的控制器方法中,类型提示你创建的表单请求类。Laravel 会自动验证请求数据,如果验证失败,会返回一个包含错误信息的响应。
<?php namespace AppHttpControllers; use AppHttpRequestsStoreUserRequest; use AppModelsUser; use IlluminateHttpRequest; class UserController extends Controller { public function store(StoreUserRequest $request) { // 验证通过,创建用户 $user = User::create($request->validated()); return response()->json(['message' => 'User created successfully', 'user' => $user], 201); } }
注意 store 方法的参数类型提示为 StoreUserRequest。 validated() 方法返回经过验证的数据,可以安全地用于创建用户。
如何自定义表单请求的错误响应?
Laravel 默认会将验证失败的请求重定向回之前的页面,并附带错误信息。但有时你可能需要自定义错误响应,例如,返回 JSON 格式的错误信息。可以在表单请求类中重写 failedValidation 方法来实现。
use IlluminateContractsValidationValidator; use IlluminateHttpExceptionsHttpResponseException; protected function failedValidation(Validator $validator) { throw new HttpResponseException(response()->json([ 'errors' => $validator->errors(), 'message' => 'Validation failed' ], 422)); }
这段代码会返回一个包含错误信息的 JSON 响应,状态码为 422。
表单请求中的授权逻辑应该如何处理?
authorize() 方法是表单请求中处理授权逻辑的地方。可以在这里检查用户是否具有执行该操作的权限。可以使用 Laravel 的授权功能,例如 Policies,来管理授权逻辑。
例如,假设你有一个 UserPolicy 类,用于管理用户相关的授权逻辑:
public function authorize() { return auth()->user()->can('create', User::class); }
这段代码会检查当前用户是否具有创建用户的权限。
如何在表单请求中处理复杂的验证逻辑?
有时,你可能需要处理一些复杂的验证逻辑,例如,验证某个字段的值是否依赖于其他字段的值。可以使用自定义验证规则来实现。
-
创建自定义验证规则:
可以使用 Artisan 命令创建一个自定义验证规则类:
php artisan make:rule EnsureAgeIsAppropriate
这会在 app/Rules 目录下生成一个 EnsureAgeIsAppropriate.php 文件。
-
实现验证逻辑:
打开生成的验证规则类,实现 passes() 和 message() 方法。
<?php namespace AppRules; use IlluminateContractsValidationRule; class EnsureAgeIsAppropriate implements Rule { protected $minAge; public function __construct($minAge) { $this->minAge = $minAge; } public function passes($attribute, $value) { // $value 是要验证的年龄值 return $value >= $this->minAge; } public function message() { return '年龄必须大于等于 ' . $this->minAge . ' 岁。'; } }
-
在表单请求中使用自定义验证规则:
在表单请求的 rules() 方法中使用自定义验证规则。
public function rules() { return [ 'age' => ['required', 'integer', new EnsureAgeIsAppropriate(18)], ]; }
这样就可以在表单请求中使用自定义验证规则了。