在Laravel项目开发中,我们经常会遇到需要支持多种类型用户的需求,不同类型的用户可能拥有不同的属性规则,比如普通用户和VIP用户的资料字段要求不同,这时候就需要用到Eloquent Attribute Inclusivity States属性包容性状态来管理这些差异化的属性规则。

Eloquent Attribute Inclusivity States核心概念
Eloquent Attribute Inclusivity States指的是Eloquent模型属性的包容性状态配置,它定义了不同场景下模型属性是否应该被包含、如何被赋值、是否可见等规则。通过配置这个状态,我们可以让同一个用户模型适配多种用户类型的属性需求,不需要为每个用户类型单独创建模型。
状态的核心作用
- 动态控制属性的可填充性,不同用户类型允许填充的字段不同
- 调整属性的可见性,接口返回时只展示对应用户类型允许查看的字段
- 统一属性校验规则,不同状态下对应不同的属性校验逻辑
在Laravel中实现属性包容性状态
我们可以通过在用户模型中定义状态配置和对应的处理方法来实现这一功能,首先先定义基础的包容性状态常量和处理逻辑。
定义状态和基础配置
首先在用户模型中定义不同的包容性状态,以及每个状态对应的属性规则:
<?php
namespace AppModels;
use IlluminateDatabaseEloquentModel;
use IlluminateSupportFacadesValidator;
class User extends Model
{
// 定义包容性状态常量
const INCLUSIVITY_STATE_NORMAL = 'normal'; // 普通用户状态
const INCLUSIVITY_STATE_VIP = 'vip'; // VIP用户状态
const INCLUSIVITY_STATE_ADMIN = 'admin'; // 管理员状态
// 当前模型的包容性状态,默认是普通用户状态
protected $inclusivityState = self::INCLUSIVITY_STATE_NORMAL;
// 不同状态对应的可填充属性配置
protected $stateFillable = [
self::INCLUSIVITY_STATE_NORMAL => ['name', 'email', 'password', 'avatar'],
self::INCLUSIVITY_STATE_VIP => ['name', 'email', 'password', 'avatar', 'vip_expire_time', 'custom_nickname'],
self::INCLUSIVITY_STATE_ADMIN => ['name', 'email', 'password', 'avatar', 'role_id', 'status', 'last_login_ip']
];
// 不同状态对应的可见属性配置
protected $stateVisible = [
self::INCLUSIVITY_STATE_NORMAL => ['id', 'name', 'email', 'avatar', 'created_at'],
self::INCLUSIVITY_STATE_VIP => ['id', 'name', 'email', 'avatar', 'vip_expire_time', 'custom_nickname', 'created_at'],
self::INCLUSIVITY_STATE_ADMIN => ['id', 'name', 'email', 'avatar', 'role_id', 'status', 'last_login_ip', 'created_at', 'updated_at']
];
// 设置当前包容性状态的方法
public function setInclusivityState($state)
{
if (in_array($state, [self::INCLUSIVITY_STATE_NORMAL, self::INCLUSIVITY_STATE_VIP, self::INCLUSIVITY_STATE_ADMIN])) {
$this->inclusivityState = $state;
}
return $this;
}
// 获取当前包容性状态
public function getInclusivityState()
{
return $this->inclusivityState;
}
}
重写模型的fillable和visible方法
接下来我们需要重写Eloquent模型的getFillable和getVisible方法,让它们根据当前的包容性状态返回对应的属性配置:
<?php
namespace AppModels;
use IlluminateDatabaseEloquentModel;
use IlluminateSupportFacadesValidator;
class User extends Model
{
// 上面的常量和属性定义省略,和之前代码一致
// 重写获取可填充属性的方法
public function getFillable()
{
// 如果当前状态有对应的可填充配置,返回该配置,否则返回父类的默认配置
if (isset($this->stateFillable[$this->inclusivityState])) {
return $this->stateFillable[$this->inclusivityState];
}
return parent::getFillable();
}
// 重写获取可见属性的方法
public function getVisible()
{
// 如果当前状态有对应的可见配置,返回该配置,否则返回父类的默认配置
if (isset($this->stateVisible[$this->inclusivityState])) {
return $this->stateVisible[$this->inclusivityState];
}
return parent::getVisible();
}
}
实际使用示例
下面展示在不同场景下如何使用属性包容性状态来处理多元化用户的需求。
创建不同状态的用户
当我们创建不同用户时,只需要先设置对应的包容性状态,再进行赋值操作即可:
<?php
// 创建普通用户,只能填充普通用户允许的字段
$normalUser = new User();
$normalUser->setInclusivityState(User::INCLUSIVITY_STATE_NORMAL);
$normalUser->fill([
'name' => '普通用户',
'email' => 'test@ipipp.com',
'password' => bcrypt('123456'),
'avatar' => 'default.png'
]);
$normalUser->save();
// 创建VIP用户,允许填充VIP专属字段
$vipUser = new User();
$vipUser->setInclusivityState(User::INCLUSIVITY_STATE_VIP);
$vipUser->fill([
'name' => 'VIP用户',
'email' => 'vip@ipipp.com',
'password' => bcrypt('123456'),
'avatar' => 'vip.png',
'vip_expire_time' => '2024-12-31 23:59:59',
'custom_nickname' => '专属昵称'
]);
$vipUser->save();
获取用户数据时按状态返回可见字段
在接口返回用户数据时,先设置对应的状态,再返回模型数据,就会自动过滤掉不允许可见的字段:
<?php // 获取普通用户数据,只返回普通用户可见字段 $user = User::find(1); $user->setInclusivityState(User::INCLUSIVITY_STATE_NORMAL); return response()->json($user->toArray()); // 获取VIP用户数据,返回VIP可见字段 $vipUser = User::find(2); $vipUser->setInclusivityState(User::INCLUSIVITY_STATE_VIP); return response()->json($vipUser->toArray());
扩展:添加状态对应的校验规则
我们还可以为每个包容性状态添加对应的属性校验规则,在保存数据前进行校验:
<?php
namespace AppModels;
use IlluminateDatabaseEloquentModel;
use IlluminateSupportFacadesValidator;
class User extends Model
{
// 之前的代码省略
// 不同状态对应的校验规则
protected $stateRules = [
self::INCLUSIVITY_STATE_NORMAL => [
'name' => 'required|string|max:20',
'email' => 'required|email|unique:users',
'password' => 'required|string|min:6'
],
self::INCLUSIVITY_STATE_VIP => [
'name' => 'required|string|max:20',
'email' => 'required|email|unique:users',
'password' => 'required|string|min:6',
'vip_expire_time' => 'required|date|after:now',
'custom_nickname' => 'nullable|string|max:30'
],
self::INCLUSIVITY_STATE_ADMIN => [
'name' => 'required|string|max:20',
'email' => 'required|email|unique:users',
'password' => 'required|string|min:8',
'role_id' => 'required|integer|exists:roles,id',
'status' => 'required|integer|in:0,1'
]
];
// 校验当前状态的数据
public function validateByState()
{
$rules = $this->stateRules[$this->inclusivityState] ?? [];
$validator = Validator::make($this->getAttributes(), $rules);
if ($validator->fails()) {
throw new Exception($validator->errors()->first());
}
return true;
}
// 重写save方法,保存前自动校验
public function save(array $options = [])
{
$this->validateByState();
return parent::save($options);
}
}
通过这种方式,我们就可以在Laravel中灵活处理Eloquent Attribute Inclusivity States属性包容性状态,轻松实现多元化用户的属性支持,后续如果需要新增用户类型,只需要新增状态常量和对应的配置即可,不需要修改大量现有逻辑,扩展性非常好。
PHPLaravelEloquent_Attribute_Inclusivity_States多元化用户支持修改时间:2026-07-10 02:21:39