Laravel FormRequest多语言验证错误定制化输出

本文将指导如何在laravel中实现多语言并行验证错误输出。通过定制formrequest的messages()方法，开发者可以为每个验证规则提供不同语言的错误信息，从而在api响应中同时返回多种语言的验证结果，满足国际化应用的需求。

理解Laravel验证与多语言机制

Laravel提供了一套强大且灵活的验证机制，通常通过FormRequest类或Validator门面来处理请求数据的验证。默认情况下，Laravel会根据当前应用的locale设置，从resources/lang/{locale}/validation.php文件中加载相应的错误消息。

例如，当验证规则失败时，Laravel会返回类似{"email": ["The email has already been taken." ]}的错误结构，其中错误消息的语言取决于当前的locale。然而，在某些国际化场景中，我们可能需要同时返回一个字段在多种语言下的错误消息，而不是仅仅依赖于当前locale。

挑战：同时返回多语言错误

传统的Laravel验证错误响应只会返回当前语言环境下的错误信息。例如，如果locale设置为en-CA，则所有错误都将是加拿大英文；如果设置为fr-CA，则所有错误都将是加拿大法文。

原有的failedValidation方法通常会捕获默认语言的验证消息包：

class APIRequest extends FormRequest
{
    protected function failedValidation(Validator $validator)
    {
        // 默认情况下，这里获取的是当前locale的错误消息
        throw new HttpResponseException($this->response($validator->getMessageBag()->toArray()));
    }
}

为了实现同时返回英文和法文（或其他多种语言）的错误消息，并可能以特定的JSON结构呈现，我们需要一种机制来为每个验证规则生成多语言消息，并将其注入到最终的错误响应中。

解决方案：定制FormRequest的messages()方法

Laravel的FormRequest类提供了一个messages()方法，允许我们为特定的验证规则定义自定义的错误消息。通过重写此方法，我们可以为每个规则定义一个包含多语言消息的数组。

以下是如何在SystemUserStoreRequest中实现这一点的示例：

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Http\Exceptions\HttpResponseException;

class SystemUserStoreRequest extends FormRequest // 假设ApiRequest最终继承FormRequest
{
    /**
     * 定义请求的验证规则。
     *
     * @return array
     */
    public function rules()
    {
        return [
            'email' => 'required|unique:users,email,' . $this->id,
            'first_name' => 'required|string|min:5', // 示例：增加一个字段
        ];
    }

    /**
     * 获取自定义的验证错误消息。
     *
     * @return array
     */
    public function messages()
    {
        return [
            'email.required' => [
               'en-CA' => __('validation.required', ['attribute' => __('portal.email', [], 'en-CA')], 'en-CA'),
               'fr-CA' => __('validation.required', ['attribute' => __('portal.email', [], 'fr-CA')], 'fr-CA'),
            ],
            'email.unique' => [
               'en-CA' => __('validation.unique', ['attribute' => __('portal.email', [], 'en-CA')], 'en-CA'),
               'fr-CA' => __('validation.unique', ['attribute' => __('portal.email', [], 'fr-CA')], 'fr-CA'),
            ],
            'first_name.required' => [
                'en-CA' => __('validation.required', ['attribute' => __('portal.first_name', [], 'en-CA')], 'en-CA'),
                'fr-CA' => __('validation.required', ['attribute' => __('portal.first_name', [], 'fr-CA')], 'fr-CA'),
            ],
            'first_name.min' => [
                'en-CA' => __('validation.min.string', ['attribute' => __('portal.first_name', [], 'en-CA'), 'min' => 5], 'en-CA'),
                'fr-CA' => __('validation.min.string', ['attribute' => __('portal.first_name', [], 'fr-CA'), 'min' => 5], 'fr-CA'),
            ],
        ];
    }

    /**
     * 处理验证失败的响应。
     *
     * @param  \Illuminate\Contracts\Validation\Validator  $validator
     * @return void
     *
     * @throws \Illuminate\Http\Exceptions\HttpResponseException
     */
    protected function failedValidation(Validator $validator)
    {
        // 格式化错误消息以匹配期望的结构
        $formattedErrors = [];
        foreach ($validator->getMessageBag()->toArray() as $field => $messages) {
            // $messages 数组中每个元素是一个包含多语言键值对的数组
            foreach ($messages as $messageBlock) {
                foreach ($messageBlock as $locale => $message) {
                    $formattedErrors[$field][$locale][] = $message;
                }
            }
        }

        throw new HttpResponseException(response()->json([
            'message' => 'The given data was invalid.',
            'detail' => $formattedErrors, // 将格式化后的错误放入 'detail' 键
        ], 422));
    }
}

在上述代码中，messages()方法返回一个关联数组，其键是field.rule（例如email.required），值是另一个包含多语言消息的数组。

关键在于__('key', ['replacements'], 'locale')辅助函数的使用：