本教程详细介绍了如何在laravel应用程序中实现同时返回多种语言的验证错误。通过自定义`formrequest`的`messages()`方法来定义包含多语言信息的验证消息，并进一步在`failedvalidation`方法中处理这些信息，以生成符合特定多语言输出结构的api响应，从而满足复杂的多语言api接口需求。
在构建国际化的Web应用或API时，经常会遇到需要同时向客户端返回多种语言的验证错误信息。Laravel的默认验证机制通常只返回当前应用语言环境下的错误消息。当需求是为每个字段的每个错误同时提供多种语言版本时，就需要对默认行为进行定制。本教程将指导您如何通过扩展FormRequest类来实现这一目标，生成如以下结构的多语言验证错误响应：
{ "detail": { "email": { "en-CA" : [ "The email has already been taken." ], "fr-CA" : [ "The french text." ] }, "first_name": { "en-CA" : [ "The first name must be at least 5.", "The first name must be an integer." ], "fr-CA" : [ "The french text", "The french text." ] } }}
理解Laravel验证与多语言需求
Laravel的FormRequest提供了一种方便的方式来封装验证逻辑。当验证失败时，它会触发failedValidation方法，并注入一个包含错误信息的Validator实例。默认情况下，$validator->getMessageBag()->toArray()会根据当前应用的locale返回错误消息。为了同时获取多种语言的错误，我们需要在消息定义阶段就嵌入这些多语言信息。
核心策略：定制FormRequest的messages()方法
实现多语言验证错误的关键在于重写FormRequest中的messages()方法。这个方法允许您为特定的验证规则和字段定义自定义的错误消息。不同于简单的字符串，我们可以为每个规则定义一个包含多语言键值对的数组。
以下是一个SystemUserStoreRequest的示例，展示了如何为email字段的required和unique规则定义en-CA和fr-CA两种语言的错误消息：
// app/Http/Requests/SystemUserStoreRequest.phpid 用于在更新时排除当前用户 $userId = $this->route('user') ? $this->route('user')->id : null; return [ 'email' => 'required|email|unique:users,email,' . $userId, 'first_name' => 'required|string|min:5', // ... 其他验证规则 ]; } /** * Get the error messages for the defined validation rules. * * @return array */ public function messages() { return [ 'email.required' => [ 'en-CA' => __('validation.required', ['attribute' => __('attributes.email', [], 'en-CA')], 'en-CA'), 'fr-CA' => __('validation.required', ['attribute' => __('attributes.email', [], 'fr-CA')], 'fr-CA'), ], 'email.email' => [ 'en-CA' => __('validation.email', ['attribute' => __('attributes.email', [], 'en-CA')], 'en-CA'), 'fr-CA' => __('validation.email', ['attribute' => __('attributes.email', [], 'fr-CA')], 'fr-CA'), ], 'email.unique' => [ 'en-CA' => __('validation.unique', ['attribute' => __('attributes.email', [], 'en-CA')], 'en-CA'), 'fr-CA' => __('validation.unique', ['attribute' => __('attributes.email', [], 'fr-CA')], 'fr-CA'), ], 'first_name.required' => [ 'en-CA' => __('validation.required', ['attribute' => __('attributes.first_name', [], 'en-CA')], 'en-CA'), 'fr-CA' => __('validation.required', ['attribute' => __('attributes.first_name', [], 'fr-CA')], 'fr-CA'), ], 'first_name.min' => [ 'en-CA' => __('validation.min.string', ['attribute' => __('attributes.first_name', [], 'en-CA'), 'min' => 5], 'en-CA'), 'fr-CA' => __('validation.min.string', ['attribute' => __('attributes.first_name', [], 'fr-CA'), 'min' => 5], 'fr-CA'), ], // ... 其他字段和规则的多语言消息 ]; }}
在上面的messages()方法中：
我们为每个验证规则（如email.required）返回一个关联数组。这个数组的键是语言环境代码（例如en-CA, fr-CA），值是对应语言的错误消息。我们使用Laravel的__辅助函数来获取翻译字符串。__(‘validation.required’, [‘attribute’ => …], ‘en-CA’)：这会从lang/en-CA/validation.php文件中获取required规则的翻译。[‘attribute’ => __(‘attributes.email’, [], ‘en-CA’)]：这是关键！它解决了占位符替换的问题。我们通过再次调用__辅助函数来翻译:attribute占位符本身（例如，将email翻译成”Email Address”或”Adresse e-mail”），并指定目标语言。attributes.email表示从lang/en-CA/attributes.php（或您自定义的翻译文件，如portal.php）中获取email字段的翻译。
关于翻译文件：
为了使上述代码正常工作，您需要在resources/lang目录下创建相应的语言文件，例如：
resources/lang/en-CA/validation.phpresources/lang/fr-CA/validation.phpresources/lang/en-CA/attributes.php (或 portal.php)resources/lang/fr-CA/attributes.php (或 portal.php)
validation.php文件应包含标准验证规则的翻译，而attributes.php（或portal.php）文件则应包含字段名的翻译。
示例 resources/lang/en-CA/attributes.php:
'Email Address', 'first_name' => 'First Name',];
示例 resources/lang/fr-CA/attributes.php:
'Adresse e-mail', 'first_name' => 'Prénom',];
在failedValidation中构建多语言响应结构
现在，当SystemUserStoreRequest验证失败时，$validator->getMessageBag()->toArray()将返回一个包含我们定义的这种多语言结构（例如[’email.required’ => [‘en-CA’ => ‘…’, ‘fr-CA’ => ‘…’]]）的数组。我们需要在ApiRequest（或直接在SystemUserStoreRequest中）重写的failedValidation方法中，将这个结构转换为我们期望的最终API响应格式。
假设您的ApiRequest基类如下：
// app/Http/Requests/ApiRequest.phpgetMessageBag()->toArray(); $transformedErrors = []; foreach ($rawErrors as $fieldRule => $messages) { // $fieldRule 可能是 "email.required", "first_name.min" 等 // $messages 是一个包含多语言消息的数组，例如： // [0 => ['en-CA' => '...', 'fr-CA' => '...']] // 提取字段名，例如从 "email.required" 中获取 "email" $field = explode('.', $fieldRule)[0]; foreach ($messages as $messageItem) { // $messageItem 现在是 ['en-CA' => '...', 'fr-CA' => '...'] foreach ($messageItem as $locale => $message) { if (!isset($transformedErrors[$field])) { $transformedErrors[$field] = []; } if (!isset($transformedErrors[$field][$locale])) { $transformedErrors[$field][$locale] = []; } $transformedErrors[$field][$locale][] = $message; } } } // 抛出包含自定义响应的 HttpResponseException throw new HttpResponseException(response()->json([ 'message' => 'The given data was invalid.', 'detail' => $transformedErrors, ], 422)); }}
在上述failedValidation方法中：
我们首先通过$validator->getMessageBag()->toArray()获取包含多语言信息的原始错误数组。然后，我们遍历这个rawErrors数组。$fieldRule会是email.required、first_name.min等，而$messages则是一个包含多语言消息的数组（例如[0 => [‘en-CA’ => ‘…’, ‘fr-CA’ => ‘…’]]）。我们从$fieldRule中解析出实际的字段名（例如email）。接着，我们再次遍历$messages数组，处理每个语言环境的消息，并将其添加到$transformedErrors中，构建出期望的嵌套结构。最后，我们抛出一个HttpResponseException，其中包含自定义的JSON响应，其detail字段就是我们精心构造的多语言错误信息。
完整代码示例
app/Http/Requests/ApiRequest.php (基类)
getMessageBag()->toArray(); $transformedErrors = []; foreach ($rawErrors as $fieldRule => $messages) { $field = explode('.', $fieldRule)[0]; // 提取字段名 foreach ($messages as $messageItem) { foreach ($messageItem as $locale => $message) { if (!isset($transformedErrors[$field])) { $transformedErrors[$field] = []; } if (!isset($transformedErrors[$field][$locale])) { $transformedErrors[$field][$locale] = []; } $transformedErrors[$field][$locale][] = $message; } } } throw new HttpResponseException(response()->json([ 'message' => 'The given data was invalid.', 'detail' => $transformedErrors, ], 422)); }}
app/Http/Requests/SystemUserStoreRequest.php (具体的请求类)
route('user') ? $this->route('user')->id : null; return [ 'email' => 'required|email|unique:users,email,' . $userId, 'first_name' => 'required|string|min:5', ]; } public function messages() { return [ 'email.required' => [ 'en-CA' => __('validation.required', ['attribute' => __('attributes.email', [], 'en-CA')], 'en-CA'), 'fr-CA' => __('validation.required', ['attribute' => __('attributes.email', [], 'fr-CA')],
以上就是Laravel表单请求中同时返回多语言验证错误教程的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1338235.html
微信扫一扫 
支付宝扫一扫 
