Laravel Resource 中正确序列化枚举字段值的完整解决方案

酷敏君_8631

酷敏君_8631

2026-10-29

537人浏览

原创

Laravel Resource 中正确序列化枚举字段值的完整解决方案

在 Laravel 9+ 中使用 PHP 8.1 枚举时,若在 Eloquent 资源(JsonResource)中直接访问已类型转换的 enum 字段(如 $this->status),默认会返回整个对象而非字符串值,导致 JSON 序列化为 [];应显式调用 ->value 获取底层标量值。

在 laravel 9+ 中使用 php 8.1 枚举时,若在 eloquent 资源(jsonresource)中直接访问已类型转换的 enum 字段(如 `$this->status`),默认会返回整个对象而非字符串值,导致 json 序列化为 `[]`;应显式调用 `->value` 获取底层标量值。

当你将 Eloquent 模型字段声明为 enum 并配置了 $casts(例如 'status' => OrderStatuses::class),Laravel 会在模型属性访问时自动将数据库中的字符串(如 'paid')转换为对应的枚举实例(如 OrderStatuses::Paid)。这本身是正确的,但枚举实例本身不可直接 JSON 序列化为字符串——PHP 默认将其视为对象,而 JsonResource 在序列化过程中对未实现 JsonSerializable 或 __toString() 的对象会输出空数组 []。

你当前的 Attribute 访问器:

protected function status(): Attribute
{
    return new Attribute(
        get: fn(string $value) => OrderStatuses::from($value)->createOrderStatus($this),
    );
}

存在两个关键问题:

  1. 与 $casts 冲突:$casts 已完成 string → OrderStatuses 的转换,此访问器却进一步将 OrderStatuses 实例转为 OrderStatus 子类对象(如 PaidOrderStatus),导致 $this->status 不再是枚举,而是自定义业务状态对象;
  2. 缺乏可序列化支持:PaidOrderStatus 等类未实现 JsonSerializable 接口或 __toString() 方法,因此 json_encode() 对其结果为 []。

✅ 正确做法是:保持 $casts 定义,移除冗余的 Attribute 访问器,并在 Resource 中显式提取枚举值:

// ✅ 移除模型中的 status() Attribute 方法
// 只保留:
protected $casts = [
    'status' => OrderStatuses::class,
];

然后在 OrdersResource 中直接使用 ->value:

laravel-specialist
laravel-specialist

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

下载
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,
            ]
        ];
    }
}

? 进阶建议(可选):若需在资源中同时暴露状态名称(如 "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',
        };
    }
}

并在资源中按需使用:

'status' => [
    'value' => $this->status->value,
    'label' => $this->status->label(),
],

⚠️ 注意事项:

  • 不要同时使用 $casts 和 Attribute 访问器处理同一字段,否则会导致类型覆盖和意外行为;
  • 若必须保留 OrderStatus 对象逻辑(如状态流转校验),建议将其封装为独立服务(如 OrderStatusService::canTransition(...)),而非通过模型访问器注入,以保持数据层与领域逻辑分离;
  • 所有自定义对象若需 JSON 序列化,务必实现 JsonSerializable 接口或定义 __toString()(仅当语义上明确代表单一字符串时)。

通过精简类型转换路径并显式提取 ->value,即可在保持代码清晰性的同时,确保 API 响应中枚举字段正确输出为预期字符串值。

相关文章

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

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

下载

相关标签:

laravel

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

相关专题

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

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

2024.04.09

877

10

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

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

2024.04.09

855

9

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

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

2024.04.09

2508

10

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

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

2024.04.10

4501

7

laravel入门教程
laravel入门教程

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

2025.08.05

6550

22

laravel实战教程
laravel实战教程

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

2025.08.05

4316

13

laravel面试题
laravel面试题

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

2025.08.05

8089

7

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

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

2026.03.04

1496

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

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

共1课时 | 215人学习

Composer手册
Composer手册

共0课时 | 0人学习