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

Laravel 9 中正确序列化枚举字段到 API 资源的完整指南

星墨姑娘_8593

星墨姑娘_8593

发布时间:2026-10-29 17:28:05

|

980人浏览过

|

来源于php中文网

原创

Laravel 9 中正确序列化枚举字段到 API 资源的完整指南

在 Laravel 9 + PHP 8.1 中,当模型字段使用字符串枚举(enum)并配置了 $casts 后,资源类中直接访问该字段会返回对象而非原始值;需显式调用 ->value 获取底层字符串,否则 JSON 序列化将输出空数组。

在 laravel 9 + php 8.1 中,当模型字段使用字符串枚举(`enum`)并配置了 `$casts` 后,资源类中直接访问该字段会返回对象而非原始值;需显式调用 `->value` 获取底层字符串,否则 json 序列化将输出空数组。

当你将 Eloquent 模型的字段(如 status)声明为字符串枚举并配置 protected $casts = ['status' => OrderStatuses::class] 时,Laravel 会在读取属性时自动将数据库中的字符串值(如 'paid')转换为对应的枚举实例(如 OrderStatuses::Paid)。这本身是完全正确的——但问题出在后续的 序列化环节。

JsonResource 的 toArray() 方法最终会通过 PHP 的 json_encode() 输出响应。而默认情况下,枚举实例(如 OrderStatuses::Paid)不实现 JsonSerializable 接口,也没有定义 __toString(),因此 json_encode() 无法将其转换为有效 JSON 值,最终退化为一个空对象 {} —— 在数组上下文中则表现为 [](即你看到的 "status" => [])。

✅ 正确且简洁的解决方案是:在资源中显式访问枚举的 ->value 属性:

class OrdersResource extends JsonResource
{
    public function toArray($request): array
    {
        return [
            'id' => (string)$this->id,
            'type' => 'orders',
            'attributes' => [
                'status' => $this->status->value, // ✅ 关键修复:获取原始字符串值
                'payment_type' => $this->payment_type,
                'payment_transaction_no' => $this->payment_transaction_no,
                'subtotal' => $this->subtotal,
                'taxes' => $this->taxes,
                'total' => $this->total,
                'items' => OrderItemsResource::collection($this->whenLoaded('orderItems')),
                'created_at' => $this->created_at,
                'updated_at' => $this->updated_at,
            ]
        ];
    }
}

⚠️ 注意事项:

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
  • 移除冗余的 Attribute 访问器:你已在 $casts 中声明了 OrderStatuses::class,Laravel 已能正确完成从数据库值到枚举实例的转换。额外定义的 status() 访问器不仅不必要,还可能引发冲突(例如它返回的是 OrderStatus 实例而非 OrderStatuses 枚举),这正是导致 $this->status 类型为 PaidOrderStatus(而非 OrderStatuses::Paid)的根本原因。请删除该访问器,确保模型字段返回的是纯枚举实例。

  • 若你确实需要在资源中返回状态的语义化标签(如 'Paid' 而非 'paid'),可在枚举中添加 label() 方法:

    enum OrderStatuses: string
    {
        case New           = 'new';
        case Pending       = 'pending';
        case Canceled      = 'canceled';
        case Paid          = 'paid';
        case PaymentFailed = 'payment-failed';
    
        public function label(): string
        {
            return match($this) {
                self::New           => 'New',
                self::Pending       => 'Pending',
                self::Canceled      => 'Canceled',
                self::Paid          => 'Paid',
                self::PaymentFailed => 'Payment Failed',
            };
        }
    }

    然后在资源中使用 $this->status->label()。

总结:Laravel 枚举字段在资源中显示为空数组,本质是序列化失败。只需坚持“枚举用于类型安全,序列化时取 .value”这一原则,并清理掉干扰性的访问器逻辑,即可获得清晰、可靠、符合 REST 规范的 API 响应。

热门AI工具

更多
DeepSeek

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

WorkBuddy

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

豆包大模型

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

相关专题

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

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

11704

2023.09.01

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

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

6741

2023.10.11

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

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

2175

2023.10.11

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

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

4268

2023.10.23

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

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

4994

2023.10.23

html怎么上传
html怎么上传

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

3911

2023.11.03

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

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

5657

2023.11.09

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

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

4422

2023.11.13

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

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

精品课程

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

共1课时 | 215人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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