在Laravel项目开发中，从数据库查询得到的模型数据往往需要经过一定的加工处理才能适配前端展示或者后续业务逻辑，比如把时间戳转换成可读的日期格式，或者把用户的手机号中间几位替换成星号。这时候访问器和原始值获取功能就能派上大用场，既能保证数据处理的便捷性，又能在需要时拿到最原始的数据。
什么是Laravel模型访问器
访问器是Laravel模型中定义的特殊方法，用于在获取模型属性值时自动执行自定义逻辑，不需要我们手动调用方法就能得到处理后的结果。访问器的命名规则是get{属性名}Attribute，其中属性名采用驼峰式命名，对应数据库字段的下划线命名方式会自动转换匹配。
访问器的基本定义
比如我们有一个User模型，对应数据库有created_at字段存储的是时间戳，我们希望获取的时候自动转换成Y-m-d H:i:s的格式，就可以定义如下访问器：
<?php
namespace AppModels;
use IlluminateDatabaseEloquentModel;
class User extends Model
{
/**
* 获取格式化后的创建时间
*
* @param string $value
* @return string
*/
public function getCreatedAtAttribute($value)
{
// $value 是数据库存储的原始值
return date('Y-m-d H:i:s', strtotime($value));
}
}
当我们通过$user->created_at获取属性的时候，就会自动返回格式化后的时间，而不需要每次都手动调用转换函数。
访问器的常见使用场景
- 字段格式化：比如日期、金额、手机号等需要统一展示格式的场景
- 字段拼接：比如把
first_name和last_name拼接成完整姓名 - 状态转换：比如把数据库存储的
0/1状态码转换成对应的中文描述 - 敏感信息处理：比如对身份证号、手机号等字段进行脱敏处理
如何获取模型属性的原始值
当我们定义了访问器之后，默认获取属性得到的是访问器处理后的结果，但有时候我们需要拿到数据库存储的原始值，比如在做数据对比、数据校验的时候，这时候就需要用到原始值获取的方法。
使用getOriginal方法获取原始值
Laravel模型提供了getOriginal方法，可以获取属性的原始数据库值，不受访问器的影响。这个方法可以传入属性名作为参数，获取单个属性的原始值，也可以不传参数获取所有属性的原始值数组。
<?php
// 获取单个属性的原始值
$originalCreatedAt = $user->getOriginal('created_at');
// 获取所有属性的原始值数组
$originalAttributes = $user->getOriginal();
需要注意的是，getOriginal方法返回的是模型从数据库加载时的原始值，如果后续你手动修改了模型的属性值，这个修改后的值不会同步到getOriginal的返回结果中。
使用原始属性数组获取
模型的original属性是一个受保护的数组，存储了所有属性的原始值，我们可以通过getOriginal方法间接访问，不建议直接操作original数组，避免破坏模型的内部状态。
访问器与原始值获取的配合使用
在实际业务中，我们经常需要同时使用访问器和原始值，比如用户列表展示的时候显示脱敏的手机号，但是后台编辑用户的时候需要拿到完整的原始手机号。这时候就可以结合两者实现需求。
假设User模型有phone字段，我们定义脱敏访问器：
<?php
namespace AppModels;
use IlluminateDatabaseEloquentModel;
class User extends Model
{
/**
* 获取脱敏后的手机号
*
* @param string $value
* @return string
*/
public function getPhoneAttribute($value)
{
if (empty($value)) {
return '';
}
// 保留前3位和后4位，中间替换为4个星号
return substr($value, 0, 3) . '****' . substr($value, -4);
}
}
在控制器中，列表页展示脱敏手机号，编辑页获取原始手机号：
<?php
namespace AppHttpControllers;
use AppModelsUser;
use IlluminateHttpRequest;
class UserController extends Controller
{
// 用户列表页
public function index()
{
$users = User::all();
// 这里$user->phone会自动返回脱敏后的手机号
return view('user.index', compact('users'));
}
// 用户编辑页
public function edit($id)
{
$user = User::findOrFail($id);
// 获取原始手机号用于表单回填
$originalPhone = $user->getOriginal('phone');
return view('user.edit', compact('user', 'originalPhone'));
}
}
注意事项
- 访问器的属性名要和数据库字段对应，驼峰式和下划线式的转换是Laravel自动处理的，比如数据库字段是
user_name，访问器方法名就是getUserNameAttribute getOriginal方法获取的是模型加载时的原始值，如果执行了save方法之后，原始值会更新为保存后的值- 如果访问器中需要处理关联模型的属性，要确保关联已经预先加载，避免产生额外的数据库查询
- 不要在访问器中执行复杂的耗性能操作，因为访问器会在每次获取属性的时候执行，可能影响接口性能
访问器和原始值获取是Laravel模型提供的非常实用的功能，合理使用可以让我们的数据处理逻辑更清晰，代码更简洁，同时避免重复编写数据转换的代码。