Laravel 中使用 Rule::in 进行数组值校验的实践指南
在 Laravel 表单验证场景中,经常需要校验某个字段的值是否属于指定的合法值集合,比如用户角色只能是 admin、editor、user 这三种,或者订单状态只能是指定的几个状态值。此时使用 Rule::in 方法可以快速实现这类校验逻辑,既简洁又易于维护。
Rule::in 基本用法
Rule::in 是 Laravel 验证规则中的一个便捷方法,用于校验字段的值是否包含在指定的数组中。它的基本语法是传入一个数组作为合法值集合,验证器会自动判断待校验字段的值是否存在于该集合中。
以下是一个简单的验证示例,校验用户提交的角色字段是否合法:
<?php
namespace AppHttpRequests;
use IlluminateFoundationHttpFormRequest;
use IlluminateValidationRule;
class UpdateUserRequest extends FormRequest
{
public function rules()
{
return [
'role' => [
'required',
'string',
Rule::in(['admin', 'editor', 'user']),
],
];
}
public function messages()
{
return [
'role.in' => '角色值不合法,请选择 admin、editor 或 user',
];
}
}上述代码中,我们先通过 required 和 string 规则确保角色字段存在且为字符串类型,再通过 Rule::in 限定合法值范围。如果用户提交的 role 值不在指定数组中,就会触发对应的错误提示。
动态合法值集合的场景
在实际业务中,合法值集合往往不是硬编码的,可能需要从数据库、配置文件或者业务逻辑中动态获取。比如订单状态的可选值可能存储在数据库的状态表中,或者是从枚举类中读取。
以下是一个动态获取合法值的示例,假设我们有一个订单状态枚举类,校验订单提交的状态是否合法:
<?php
namespace AppHttpRequests;
use IlluminateFoundationHttpFormRequest;
use IlluminateValidationRule;
use AppEnumsOrderStatus;
class CreateOrderRequest extends FormRequest
{
public function rules()
{
// 从枚举类获取所有合法的状态值
$validStatuses = OrderStatus::getValues();
return [
'status' => [
'sometimes',
'string',
Rule::in($validStatuses),
],
];
}
}如果合法值需要从数据库查询获取,也可以直接将查询结果传入 Rule::in,例如:
<?php
namespace AppHttpRequests;
use IlluminateFoundationHttpFormRequest;
use IlluminateValidationRule;
use AppModelsCategory;
class CreateArticleRequest extends FormRequest
{
public function rules()
{
// 查询所有可用的分类ID作为合法值
$validCategoryIds = Category::where('is_active', 1)->pluck('id')->toArray();
return [
'category_id' => [
'required',
'integer',
Rule::in($validCategoryIds),
],
];
}
}与数组字段结合使用
当需要校验一个数组字段中的每个元素是否都合法时,可以结合 .* 通配符和 Rule::in 实现。比如用户提交一个标签数组,需要校验每个标签都属于系统预设的合法标签集合。
<?php
namespace AppHttpRequests;
use IlluminateFoundationHttpFormRequest;
use IlluminateValidationRule;
class UpdateArticleRequest extends FormRequest
{
public function rules()
{
// 预设的合法标签集合
$validTags = ['laravel', 'php', 'mysql', 'redis', 'nginx'];
return [
'tags' => [
'required',
'array',
'min:1',
],
'tags.*' => [
'string',
Rule::in($validTags),
],
];
}
public function messages()
{
return [
'tags.*.in' => '标签 :input 不合法,请选择预设的标签',
];
}
}上述代码中,tags.* 表示校验 tags 数组中的每一个元素,只要有一个元素不在合法标签集合中,就会触发校验失败。
注意事项
Rule::in校验是严格匹配的,包括数据类型。比如如果合法值集合中是整数[1,2,3],那么提交字符串"1"也会校验失败,需要提前确保字段类型和合法值类型一致。如果合法值集合为空数组,那么所有值都会校验失败,使用前需要确保合法值集合不为空。
当合法值集合元素较多时,可以考虑将集合定义在配置文件或者枚举类中,避免验证逻辑中硬编码大量值,提升代码可维护性。
如果需要校验字段值不在指定集合中,可以使用
Rule::notIn方法,用法和Rule::in类似。
总结
Rule::in 是 Laravel 中处理值集合校验的高效工具,无论是静态的合法值列表还是动态的合法值集合都能很好地支持,结合数组通配符还可以实现数组元素的批量校验。合理使用该方法可以让表单验证代码更简洁、逻辑更清晰,减少重复的校验逻辑编写。