Laravel 中嵌套数组数据验证指南

在现代 Web 应用中，前端向后端发送复杂结构的数据是常见需求，其中就包括包含多个相同结构对象的数组。例如，当用户需要一次性提交多个成员的信息（如电子邮件和角色ID）时，数据可能会以以下 JSON 或数组形式发送：

[
  {
    "email": "user1@example.com",
    "role_id": 2
  },
  {
    "email": "user2@example.com",
    "role_id": 3
  }
]

在 Laravel 中，对这类嵌套数组数据进行有效性验证是确保数据完整性和安全性的关键步骤。Laravel 强大的验证系统提供了简洁而强大的方式来处理这类复杂场景。

核心：点表示法 (.*) 的应用

Laravel 验证系统通过“点表示法”（Dot Notation）来访问嵌套数组或对象的属性。当需要验证数组中的每个元素时，可以使用 .* 作为通配符，它会应用于数组中的所有项。

假设您的请求数据中，上述数组的顶级键名为 members，那么要验证 members 数组中每个对象的 email 和 role_id 字段，验证规则可以这样定义：

// 示例输入数据结构
// 'members' => [
//     ['email' => 'user1@example.com', 'role_id' => 2],
//     ['email' => 'user2@example.com', 'role_id' => 3],
// ]

public function rules(): array
{
    return [
        // 确保 'members' 字段存在且是一个数组
        'members' => ['required', 'array'],

        // 验证 'members' 数组中每个元素的 'email' 字段
        // 'members.*.email' 表示 'members' 数组中的所有项的 'email' 属性
        'members.*.email' => ['required', 'email'],

        // 验证 'members' 数组中每个元素的 'role_id' 字段
        // 'members.*.role_id' 表示 'members' 数组中的所有项的 'role_id' 属性
        'members.*.role_id' => ['required', 'integer'],
    ];
}

规则解析：

怪兽AI数字人

数字人短视频创作，数字人直播，实时驱动数字人

44

查看详情

• 'members' => ['required', 'array']: 这条规则首先确保请求中存在名为 members 的顶级键，并且它的值必须是一个数组。这是对整个数组结构进行验证的基础。
• 'members.*.email' => ['required', 'email']: 这是关键所在。
  • members: 指向请求中的 members 数组。
  • .*: 这是一个通配符，表示 members 数组中的每一个元素。
  • email: 指向当前数组元素中的 email 键。
  • ['required', 'email']: 对每一个 email 键应用 required（必需）和 email（有效的电子邮件格式）规则。
• 'members.*.role_id' => ['required', 'integer']: 类似地，这条规则对 members 数组中每一个元素的 role_id 键应用 required（必需）和 integer（整数类型）规则。

规则应用场景

这些验证规则可以在 Laravel 的两种主要验证方式中应用：

1. 表单请求类 (Form Request Classes)： 推荐使用 php artisan make:request YourFormRequest 命令生成的表单请求类。在这些类的 rules() 方法中定义验证逻辑，可以使控制器保持精简，并提高代码的可维护性。

   // app/Http/Requests/StoreMembersRequest.php
   namespace App\Http\Requests;
   
   use Illuminate\Foundation\Http\FormRequest;
   
   class StoreMembersRequest extends FormRequest
   {
       /**
        * Determine if the user is authorized to make this request.
        */
       public function authorize(): bool
       {
           // 根据业务逻辑判断用户是否有权限执行此请求
           return true; 
       }
   
       /**
        * Get the validation rules that apply to the request.
        * @return array
        */
       public function rules(): array
       {
           return [
               'members' => ['required', 'array'],
               'members.*.email' => ['required', 'email'],
               'members.*.role_id' => ['required', 'integer'],
           ];
       }
   }

   登录后复制

   然后在控制器中注入并使用：

   // app/Http/Controllers/MemberController.php
   namespace App\Http\Controllers;
   
   use App\Http\Requests\StoreMembersRequest;
   use Illuminate\Http\Request;
   
   class MemberController extends Controller
   {
       public function store(StoreMembersRequest $request)
       {
           // 验证通过，数据已在 $request 中
           $validatedData = $request->validated();
           // ... 处理数据 ...
           return response()->json(['message' => 'Members stored successfully']);
       }
   }

   登录后复制

2. 控制器中的 validate 方法： 对于简单的验证场景，可以直接在控制器方法中使用 Request 实例的 validate() 方法。

   // app/Http/Controllers/MemberController.php
   namespace App\Http\Controllers;
   
   use Illuminate\Http\Request;
   
   class MemberController extends Controller
   {
       public function store(Request $request)
       {
           $validatedData = $request->validate([
               'members' => ['required', 'array'],
               'members.*.email' => ['required', 'email'],
               'members.*.role_id' => ['required', 'integer'],
           ]);
   
           // ... 处理数据 ...
           return response()->json(['message' => 'Members stored successfully']);
       }
   }

   登录后复制

注意事项

• 错误消息：当使用点表示法时，Laravel 会自动为每个数组元素生成详细的错误消息。例如，如果 members 数组的第二个元素的 email 无效，错误消息可能类似于 The members.1.email field must be a valid email address.。您可以自定义这些错误消息，通过在表单请求类中重写 messages() 方法或在 validate 方法中传入第二个参数。

  public function messages(): array
  {
      return [
          'members.*.email.required' => '每个成员的邮箱地址都不能为空。',
          'members.*.email.email' => '每个成员的邮箱地址格式不正确。',
          'members.*.role_id.required' => '每个成员的角色ID都不能为空。',
          'members.*.role_id.integer' => '每个成员的角色ID必须是整数。',
      ];
  }

  登录后复制
• 更复杂的 role_id 验证：如果 role_id 必须存在于数据库的 roles 表中，可以使用 exists 规则： 'members.*.role_id' => ['required', 'integer', 'exists:roles,id'], 这将确保提交的 role_id 在 roles 表的 id 列中是存在的。
• 可选字段：如果数组中的某些字段是可选的，可以移除 required 规则。例如，如果 role_id 是可选的： 'members.*.role_id' => ['nullable', 'integer'],nullable 规则允许字段为空或不存在。
• 性能考量：对于包含大量元素的数组，验证过程可能会消耗更多资源。确保在处理大量数据时，服务器性能能够满足需求。

总结

通过巧妙运用 Laravel 验证规则中的点表示法（.*），开发者可以轻松地对复杂嵌套的数组数据进行精确和全面的验证。无论是采用表单请求类以保持代码整洁，还是直接在控制器中进行快速验证，这种方法都提供了高效、灵活且易于理解的解决方案，确保了传入数据的有效性和安全性。掌握这一技巧，对于构建健壮的 Laravel 应用程序至关重要。

以上就是Laravel 中嵌套数组数据验证指南的详细内容，更多请关注php中文网其它相关文章！