0

0

如何为Laravel Eloquent创建自定义的Casting类型? (CastsAttributes接口)

尼克

尼克

发布时间:2026-01-13 16:29:03

|

253人浏览过

|

来源于php中文网

原创

该用CastsAttributes而非内置cast时,是需将数据库字段转为特定PHP类型且内置cast无法满足逻辑,如解析金额、反序列化配置、布尔掩码转枚举;须实现get()和set()方法,注意类型匹配与容错处理。

如何为laravel eloquent创建自定义的casting类型? (castsattributes接口)

什么时候该用 CastsAttributes 而不是内置 cast?

当你需要把数据库字段(比如 JSON 字符串、逗号分隔的字符串、加密内容)转成特定 PHP 类型(如 CollectionDateTimeImmutable、自定义 Value Object),且内置 cast('array''json''date')无法满足逻辑时,就必须实现 CastsAttributes。常见场景包括:解析带格式的金额字符串、反序列化带版本控制的配置、把数据库里的布尔掩码转成枚举集合。

如何正确实现 CastsAttributes 接口?

必须实现两个方法:get()(从数据库值转为属性值),set()(从属性值转为可存入数据库的值)。注意:返回值类型需与属性声明一致;set() 的返回值必须是能被 Eloquent 序列化写入数据库的类型(如 string、int、array)。

  • get() 第一个参数是 $value(原始数据库值),第二个是 $model(当前模型实例),可为空
  • set() 第一个参数是 $value(用户赋给属性的值),第二个是 $model,第三个是 $attribute(字段名),通常只用前两个
  • 不要在 get() 里抛异常——Eloquent 会静默失败并设为 null;应在内部做容错(如空值 fallback)
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class CommaSeparatedString implements CastsAttributes
{
    public function get($model, string $key, $value, array $attributes)
    {
        return $value ? explode(',', $value) : [];
    }

    public function set($model, string $key, $value, array $attributes)
    {
        return is_array($value) ? implode(',', $value) : '';
    }
}

在模型中注册自定义 cast 的关键写法

必须把类名(完整命名空间)作为字符串写进 $casts 数组,不能写对象实例,也不能漏掉 use。Eloquent 在实例化 cast 时会自动调用构造函数(若需依赖注入,得配合服务容器绑定)。

无界AI
无界AI

一站式AI创作、搜索、分享服务

下载
  • 错误写法:'tags' => new CommaSeparatedString'tags' => 'CommaSeparatedString'(没带命名空间)
  • 正确写法:'tags' => \App\Casts\CommaSeparatedString::class
  • 如果 cast 类有构造参数(如分隔符可配置),不能直接在 $casts 里传参——得改用 getAttribute()/setAttribute() 手动处理,或用闭包 cast(Laravel 9.2+ 支持)
use App\Casts\CommaSeparatedString;

class Post extends Model
{
    protected $casts = [
        'tags' => CommaSeparatedString::class,
        'metadata' => 'array',
    ];
}

调试 cast 不生效的三个高频原因

最常卡在这几个点上,而不是逻辑本身:

  • 模型用了 $appends 但没在 $casts 里声明对应字段——cast 只对数据库字段生效,$appends 是虚拟属性,需手动在 get{Attribute}Attribute() 里处理
  • 字段在数据库中是 NULL,而 get() 方法没处理 null 输入,导致返回 null 后被 Eloquent 当作未设置,最终属性值为 null 而非空数组/空字符串等预期值
  • 修改了 cast 类但没清缓存:php artisan config:clearphp artisan view:clear 不影响 cast,但若用了 opcache,需重启 PHP-FPM 或执行 opcache_reset()
Eloquent 对 cast 的调用时机很固定:取值走 get()(含 toArray()toJson())、赋值走 set()(含 fill()、批量赋值),但不会在 where() 查询条件里触发——也就是说,你不能靠 cast 把字符串字段“变”成日期然后直接 whereDate(),那得用访问器或查询时显式转换。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2489

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1586

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1482

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1414

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1305

2023.11.13

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.6万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号