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 时会自动调用构造函数(若需依赖注入,得配合服务容器绑定)。

ModelGate
ModelGate

一站式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(),那得用访问器或查询时显式转换。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

340

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

293

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

773

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

385

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

141

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

80

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

569

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.5万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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