Laravel CustomCast_自定义Cast类实现复杂转换【说明】

夏杰小哥_3401

夏杰小哥_3401

2026-05-07

681人浏览

原创

自定义 cast 类必须实现 castsattributes 接口,否则报错;$casts 配置须用 ::class 语法;带参 cast 需通过 castable 接口 + castusing() 实现;cast 必须无状态、不依赖模型关系或外部副作用。

laravel customcast_自定义cast类实现复杂转换【说明】

自定义 Cast 类必须实现 CastsAttributes 接口

直接写个普通类当 Cast 会报错:Class "App\Casts\CustomJson" is not a valid cast。Laravel 要求所有自定义 Cast 必须显式声明可被识别——要么实现 Illuminate\Contracts\Database\Eloquent\CastsAttributes 接口,要么继承 Cast 抽象类(后者已不推荐,接口更清晰)。

常见错误包括:

  • 漏掉 implements CastsAttributes,只写了个空类
  • 写了 get() 但没写 set(),或方法签名参数顺序/类型不对(比如 $key 必须是 string)
  • set() 方法返回非 string 或 null,Eloquent 会静默丢弃字段值,不报错也不存库

$casts 数组里必须用 ::class 语法

模型中配置时,$casts 的值必须是类的完整命名空间 + ::class,不是字符串路径、不是 new 实例、也不是裸类名。

正确写法:'metadata' => CustomJson::class

错误写法举例:

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载
  • 'metadata' => new CustomJson() → Laravel 尝试调用 __toString(),报错
  • 'metadata' => CustomJson → PHP 认为是未定义常量
  • 'metadata' => 'App\Casts\CustomJson' → 虽能运行,但 IDE 无法跳转,重构易出错

带参 Cast 必须用 Castable 接口 + castUsing()

Eloquent 实例化 Cast 时不传任何参数,所以不能靠构造函数注入配置(如 JSON 解码深度、加密密钥)。要支持动态参数,得用 Castable 接口做“代理”。

典型结构:

  • 一个 JsonWithDepth 类,implements Castable,构造函数接收 $depth
  • 它的 castUsing() 方法返回真实 Cast 类名(如 JsonDepthCast::class)
  • 模型中写 'payload' => JsonWithDepth::class,等价于 'payload' => JsonWithDepth::castUsing(['depth' => 10])

注意:castUsing() 返回的是字符串类名,不是实例,也不是数组。

Cast 内部必须无状态、不访问模型关系

Cast 实例在模型生命周期中可能被复用,且在模型属性尚未初始化、关系未加载时就被调用。因此:

  • 不能在 get() 或 set() 里调用 $model->relation,会触发无限递归或空指针
  • 不能依赖 $model->id 等未保证存在的属性
  • 不能写日志、发 HTTP 请求、查数据库——它只负责纯数据转换
  • 若需加解密,密钥应硬编码或从 config 取,而非从模型某个字段读取

最易被忽略的一点:Cast 类里不要有私有属性存中间状态,否则多字段共用同一个 Cast 实例时会互相污染。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2749

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2148

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1140

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1078

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1296

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1978

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3060

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

13415

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 194人学习

Composer手册
Composer手册

共0课时 | 0人学习