讲师中心 微信公众号
AI工具推荐 视频效率加速

PHP怎么实现Eloquent Attribute Casting属性转换进阶_Laravel自定义转换器【指南】

老辰酱_6846

老辰酱_6846

发布时间:2026-04-09 20:47:23

|

134人浏览过

|

来源于php中文网

原创

Eloquent自定义转换器(Laravel 7+)比get/setFooAttribute更推荐,因其统一可控、自动参与全链路序列化;需实现CastsAttributes接口,安全JSON数组转换器应兜底空值与解析失败。

php怎么实现eloquent attribute casting属性转换进阶_laravel自定义转换器【指南】

为什么 getFooAttribute 和 setFooAttribute 不再推荐用

因为 Eloquent 的 $casts 已支持自定义转换器(Laravel 7+),它比访问器/修改器更统一、更可控,且自动参与序列化、API 响应、模型数组转换等全链路。手动写访问器容易漏掉反向逻辑(比如只处理取值不处理设值),也绕过 toArray() 和 jsonSerialize() 的标准化流程。

常见错误现象:toArray() 返回的仍是原始类型(如字符串),但前端期望是数组;或数据库存的是 JSON 字符串,却没在读取时自动解码。

  • 自定义转换器必须实现 Illuminate\Contracts\Database\Eloquent\CastsAttributes 接口
  • 必须定义 get(从数据库值转 PHP 值)和 set(从 PHP 值转数据库可存值)两个方法
  • 返回值类型需与字段语义一致:比如 get 应返回 array,set 应返回 string 或 null
  • 不要在 get 中抛异常——Eloquent 在序列化时会静默忽略失败,导致字段消失

怎么写一个安全的 JSON 数组转换器

适用于存取 JSON 类型字段(如 MySQL 5.7+ 的 JSON 列,或通用 TEXT 字段),目标是让模型属性始终表现为 PHP array,且空值、null、非 JSON 字符串都能兜底处理。

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class JsonArrayCast implements CastsAttributes
{
    public function get($model, string $key, $value, array $attributes)
    {
        if ($value === null || $value === '') {
            return [];
        }

        if (is_array($value)) {
            return $value;
        }

        $decoded = json_decode($value, true);
        return is_array($decoded) ? $decoded : [];
    }

    public function set($model, string $key, $value, array $attributes)
    {
        if ($value === null || $value === []) {
            return null;
        }

        if (!is_array($value)) {
            $value = [];
        }

        return json_encode($value, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
    }
}

关键点:

立即学习“PHP免费学习笔记(深入)”;

  • 不依赖 json_last_error() ——json_decode 失败直接返回 null,避免后续 is_array(null) 导致意外空数组
  • set 方法里强制归一化输入,防止传入对象、字符串甚至布尔值导致 json_encode 输出不符合预期
  • 使用 JSON_UNESCAPED_UNICODE 避免中文被编码成 \uXXXX,提升可读性与调试友好度

如何在模型中注册并验证是否生效

在模型类中声明 $casts,键为字段名,值为转换器类完整命名空间路径:

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

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

下载
protected $casts = [
    'options' => \App\Casts\JsonArrayCast::class,
];

验证是否生效最直接的方式是:在 Tinker 中测试读写闭环:

  • 执行 $model->options = ['theme' => 'dark', 'lang' => 'zh']; $model->save(); → 检查数据库该字段是否存为合法 JSON 字符串
  • 执行 $fresh = Model::find($model->id); dd($fresh->options); → 确认输出是 array 而非 string
  • 执行 $fresh->toArray() → 确认 options 键对应值是数组,不是 JSON 字符串

容易踩的坑:

  • 忘记在 $casts 中写 ::class 后缀,写成字符串路径(如 'App\Casts\JsonArrayCast')会导致 Laravel 找不到类
  • 转换器类未放在自动加载路径下(如没运行 composer dump-autoload),Tinker 会报 Class not found
  • 字段在数据库中是 NULL,但转换器 get 方法没处理 null 分支,结果返回 null,而前端解析时崩掉

什么时候该用原生 cast 而不是自定义转换器

Laravel 内置 cast 已覆盖多数场景,优先用它们更轻量、更稳定:

  • 布尔值:'active' => 'boolean',比手写转换器更兼容 '1'、'true'、'on' 等各种伪布尔输入
  • 日期时间:'published_at' => 'datetime:Y-m-d',支持格式化输出,且自动处理时区和 Carbon 实例
  • JSON 对象(非数组):'meta' => 'object',底层已做容错,无需重复造轮子
  • 枚举(PHP 8.1+):'status' => \App\Enums\StatusEnum::class,配合原生 enum 更安全

只有当业务需要特殊序列化逻辑(如加密存储、带版本号的结构化解析、兼容旧数据格式)时,才值得投入成本写自定义转换器。否则,越简单越可靠。

真正难的不是写转换器,而是想清楚:这个字段在数据库里存什么、在内存里该是什么类型、前端要什么格式、出错时该怎么降级——这些边界没理清,代码写得再工整也会在某个深夜报错。

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

12144

2023.09.01

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

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

6941

2023.10.11

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

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

2215

2023.10.11

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

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

4428

2023.10.23

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

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

5134

2023.10.23

html怎么上传
html怎么上传

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

4031

2023.11.03

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

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

5837

2023.11.09

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

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

4582

2023.11.13

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn