在 Laravel 中创建自定义 Eloquent Cast 类需实现 CastsAttributes 接口,定义 get 和 set 方法以处理数据库字段的读取与存储,如将字符串转为首字母大写。

在 Laravel 中,自定义 Eloquent Cast 类型可以让你更灵活地处理数据库字段的存储与读取。比如将 JSON 字符串自动转为对象,或对日期、加密数据等进行特殊处理。Laravel 8+ 支持创建可复用的自定义 Cast 类,下面介绍具体实现方法。
创建自定义 Cast 类
要创建一个自定义的 Eloquent Cast 类,你需要定义一个实现 CastsAttributes 接口的类。这个接口要求实现两个方法:get 和 set,分别用于从数据库获取值和写入数据库前的处理。
例如,我们创建一个将字符串转为首字母大写的 Cast:
namespace App\Casts;use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
class CapitalizeString implements CastsAttributes { /**
- 将数据库值转换为模型属性 */ public function get($model, string $key, $value, array $attributes) { return ucfirst($value); }
/**
* 将模型属性转换为数据库值
*/
public function set($model, string $key, $value, array $attributes)
{
return strtolower($value);
}}
在模型中使用自定义 Cast
定义好 Cast 类后,在 Eloquent 模型中通过 $casts 属性注册即可。
namespace App\Models;use App\Casts\CapitalizeString; use Illuminate\Database\Eloquent\Model;
class User extends Model { protected $casts = [ 'name' => CapitalizeString::class, ]; }
这样,每次访问 $user->name 时,值都会自动首字母大写;保存时则转为小写存入数据库(根据你的逻辑可调整)。
支持数组或复杂类型的 Cast 示例
如果你需要处理 JSON 或数组类型,比如将数据库中的 JSON 字符串转为特定对象:
namespace App\Casts;use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
class JsonToArrayObject implements CastsAttributes { public function get($model, string $key, $value, array $attributes) { return json_decode($value, true) ?? []; }
public function set($model, string $key, $value, array $attributes) { return json_encode($value, JSON_UNESCAPED_UNICODE); }}
然后在模型中使用:
'settings' => JsonToArrayObject::class
注意事项
- 自定义 Cast 类必须实现 CastsAttributes 接口。
- get 方法返回的是模型中使用的值,set 方法返回的是存入数据库的值。
- Laravel 还支持 inbound casts(只进不出)和 castables,适合更高级场景。
- 确保 Cast 类位于可自动加载的命名空间下(如 app/Casts)。
基本上就这些。自定义 Eloquent Cast 让数据处理更干净,避免在模型或控制器里写重复的格式化逻辑。










