Laravel Rule::in 验证器自定义错误消息指南

本文旨在指导如何在 Laravel 中为 `Rule::in` 验证规则添加自定义错误消息。许多开发者在使用 `Rule` 对象时，可能会在定义自定义消息时遇到困惑。我们将阐明正确的语法，即通过 `field_name.rule_name`（例如 `agency-name.in`）来指定消息键，从而确保在验证失败时能提供准确且用户友好的错误提示。

理解 Laravel 验证与自定义消息

Laravel 的验证系统强大且灵活，允许开发者定义各种规则来确保输入数据的完整性。当使用 Request 实例的 validate 方法时，通常会传入两个参数：第一个是包含字段及其验证规则的数组，第二个是可选的自定义错误消息数组。

自定义错误消息的键通常遵循 field_name.rule_name 的格式。例如，对于 password 字段的 min 规则，自定义消息的键将是 'password.min'。这对于大多数直接以字符串形式定义的规则来说是直观的。

Rule::in 对象的特殊性与自定义消息的挑战

在某些场景下，为了更灵活地构建验证规则，Laravel 提供了 Rule 对象，例如 Rule::in($array)。这种方式允许将验证逻辑封装在对象中，使得代码更具可读性和可维护性。然而，当尝试为 Rule::in 这样的对象规则定义自定义错误消息时，开发者可能会遇到困惑，因为直接使用 Rule::in($array) 作为消息键并不能奏效。

例如，以下尝试为 agency-name 字段的 Rule::in 规则添加自定义消息的写法是无效的：

// 错误的自定义消息定义方式
'agency-name.Rule::in(agency_names)' => 'NEW MESSAGE (DOESN\'T WORK)',

这是因为 Laravel 在解析自定义消息时，仍然会查找底层规则的名称，而不是 Rule 对象的完整字符串表示。对于 Rule::in，其底层的规则名称就是 in。

稿定抠图

AI自动消除图片背景

30

查看详情

正确为 Rule::in 添加自定义错误消息

解决这个问题的关键在于理解，即使使用了 Rule::in 对象，Laravel 在内部处理自定义消息时，依然将其识别为 in 规则。因此，自定义错误消息的键应遵循 field_name.in 的标准格式。

以下是为 agency-name 字段的 Rule::in 规则添加自定义错误消息的正确方法：

1. 准备 in 规则所需的数据： 首先，你需要准备一个包含所有允许值的数组，供 Rule::in 使用。

   $agencies = Session::get('config.agency-names');
   $agency_names = [];
   foreach ($agencies['Agencies'] as $agency) {
       $agency_names[] = $agency["AgencyName"];
   }
   // 根据业务需求，可能需要允许空值
   $agency_names[] = '';

   登录后复制

2. 定义验证规则和自定义消息： 在 validate 方法中，将 agency-name 字段的规则定义为 ['required_if:referral,no', Rule::in($agency_names)]。 然后，在自定义消息数组中，使用 'agency-name.in' 作为键来定义你的自定义错误消息。

   $request->validate([
       'referral'    => 'required',
       'agency-name' => ['required_if:referral,no', Rule::in($agency_names)],
       'password'    => 'required|min:6|regex:/[A-Z]/|regex:/[a-z]/|regex:/[0-9]/|confirmed'
   ], [
       // 正确的自定义 agency-name 消息
       'agency-name.in' => '您选择的机构名称无效，请重新选择。',
       // 其他自定义密码消息
       'password.confirmed' => '确认密码不匹配，请重试。',
       'password.regex'     => '密码不符合要求，请重试。',
       'password.min'       => '密码不符合要求，请重试。',
   ]);

   登录后复制

完整示例代码

结合上述步骤，完整的代码示例如下：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Validation\Rule;
use Illuminate\Support\Facades\Session;

class YourController extends Controller
{
    public function processForm(Request $request)
    {
        // 1. 准备 Rule::in 所需的数据
        $agencies = Session::get('config.agency-names');
        $agency_names = [];
        if (isset($agencies['Agencies']) && is_array($agencies['Agencies'])) {
            foreach ($agencies['Agencies'] as $agency) {
                $agency_names[] = $agency["AgencyName"];
            }
        }
        // 根据业务逻辑，如果允许空值，则添加
        $agency_names[] = '';

        // 2. 定义验证规则和自定义消息
        $request->validate([
            'referral'    => 'required',
            'agency-name' => ['required_if:referral,no', Rule::in($agency_names)],
            'password'    => 'required|min:6|regex:/[A-Z]/|regex:/[a-z]/|regex:/[0-9]/|confirmed'
        ], [
            // 正确的自定义 agency-name 消息
            'agency-name.in' => '您选择的机构名称无效，请重新选择。',
            // 其他自定义密码消息
            'password.confirmed' => '确认密码不匹配，请重试。',
            'password.regex'     => '密码不符合要求，请重试。',
            'password.min'       => '密码不符合要求，请重试。',
        ]);

        // 验证通过，执行后续业务逻辑
        // ...

        return back()->with('success', '表单提交成功！');
    }
}

注意事项与总结

• 统一的命名约定： 核心要点是，无论您是直接使用字符串规则（如 'in:value1,value2'）还是通过 Rule::in() 对象，Laravel 在解析自定义错误消息时，都会将其视为 in 规则。因此，消息键应始终是 field_name.in。这一原则同样适用于其他 Rule 对象，例如 Rule::unique、Rule::exists 等，它们对应的消息键分别是 field_name.unique、field_name.exists。
• 可读性和维护性： 虽然直接在 validate 方法中定义自定义消息适用于简单场景，但对于更复杂的表单或需要多语言支持的应用，推荐使用 Laravel 的语言文件（resources/lang/{locale}/validation.php）来管理所有验证消息。
• Form Request 类： 对于复杂的验证逻辑，可以考虑使用 Form Request 类。它能将验证逻辑从控制器中分离出来，使控制器更简洁，并提供更结构化的方式来定义规则和自定义消息。

通过遵循 field_name.rule_name 的约定，即使在使用 Rule::in 这样的对象规则时，您也能轻松地为 Laravel 验证器添加精确且用户友好的自定义错误消息，从而提升用户体验。

以上就是Laravel Rule::in 验证器自定义错误消息指南的详细内容，更多请关注php中文网其它相关文章！