PHP怎么处理Eloquent Casts自定义转换_Laravel复杂属性处理【技巧】

浅枫大大_3201

浅枫大大_3201

2026-04-04

873人浏览

原创

自定义 Cast 类必须实现 Castable 接口或继承 CastsAttributes 抽象类,否则报错;$casts 中须用 ::class 语法;带参 Cast 需通过 Castable 的 castUsing() 实现;Cast 内应无状态、不访问模型关系或未初始化属性。

php怎么处理eloquent casts自定义转换_laravel复杂属性处理【技巧】

自定义 Cast 类必须实现 Castable 接口或继承 Cast

直接写一个普通类当 Cast 会报错:Class "App\Casts\CustomJson" is not a valid cast。Laravel 要求自定义 Cast 必须显式声明可被识别——要么实现 Castable 接口(返回真实 Cast 类),要么继承 Illuminate\Contracts\Database\Eloquent\CastsAttributes(即 Cast 抽象类)。

推荐用后者,更直观可控:

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class CustomJson 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): string
    {
        return json_encode($value, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
    }
}

注意:set() 方法必须返回 string(或 null),否则 Eloquent 会静默丢弃该字段值,且不报错。

$casts 数组里写的是类名字符串,不是实例

在 Model 中配置时,$casts 的值是类的完整命名空间字符串,不是对象、不是 new 实例,也不是 class 关键字:

protected $casts = [
    'metadata' => CustomJson::class,
    'options' => 'array', // 内置 cast 可用字符串
];

常见错误包括:

  • 写成 'metadata' => new CustomJson() → Laravel 会尝试调用 __toString(),报错
  • 写成 'metadata' => CustomJson(缺 ::class)→ PHP 未定义常量
  • 写成 'metadata' => 'App\Casts\CustomJson' → 虽然能运行,但不推荐:硬编码字符串易出错,且 IDE 无法跳转

带参数的 Cast 需用 Castable 接口 + castUsing()

如果需要动态传参(比如指定 JSON 解码深度、是否关联数组),不能靠构造函数注入——Eloquent 实例化 Cast 时不传参。正确方式是让模型属性指向一个实现 Castable 的“代理类”:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
use Illuminate\Contracts\Database\Eloquent\Castable;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class JsonWithDepth implements Castable
{
    public function __construct(public int $depth = 512) {}

    public function castUsing(array $arguments): string
    {
        return JsonDepthCast::class;
    }
}

// 然后在 Model 中:
protected $casts = [
    'payload' => JsonWithDepth::class.':1024',
];

这里 ':1024' 会被作为 $arguments 传入 castUsing(),你可以解析并返回不同行为的 Cast 类。注意:冒号后内容是字符串,需手动 (int) 转换。

Cast 中访问模型状态要小心循环和延迟加载

在 get() 或 set() 里调用 $model->someRelation 很危险:可能触发无限递归(比如 relation 也用了同个 Cast)、或因模型尚未完全初始化导致属性为空。更糟的是,set() 执行时模型可能还没分配主键,save() 前无法可靠查库。

真正安全的做法是只处理当前字段原始值:

  • 避免在 Cast 里调用 $model->getAttribute() 或关系属性
  • 如需上下文(如租户 ID、用户权限),应通过模型的静态属性、请求上下文(如 request()->user())或服务容器获取,而非依赖模型实例状态
  • 若逻辑复杂到必须依赖其他字段,考虑改用 Accessor/Mutator,或在 saved 事件中后置处理

Cast 的设计初衷是字段级无状态转换,一旦掺入业务逻辑,就容易在批量更新、队列任务、API 资源转换等场景下表现不一致。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

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

下载

相关标签:

php

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

相关专题

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

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

2023.09.01

11644

6

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

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

2023.10.11

6701

5

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

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

2023.10.11

2175

5

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

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

2023.10.23

4248

4

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

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

2023.10.23

4974

6

html怎么上传
html怎么上传

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

2023.11.03

3911

9

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

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

2023.11.09

5617

8

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

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

2023.11.13

4402

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12322

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习