PHP enum 输出 JSON 时如何固定 backed value
来源:17golang原创
时间:2026-09-15 04:02:33 258浏览 收藏
PHP enum 要稳定输出 JSON,关键不是在 json_encode() 外面再包一层转换,而是把枚举声明为 backed enum,并给每个 case 写死唯一的 string 或 int 值。这样,接口序列化时会直接得到这个 value;接收请求时再用 from() 或 tryFrom() 把标量还原成 case。
官方地址:https://www.php.net/manual/en/language.enumerations.serialization.php
- backed enum 的 JSON 结果是 case 的标量 value,不是 case 名称。
- 字符串和整数类型不能混用,value 必须显式且唯一。
- 可信输入用
from(),外部输入优先用tryFrom()处理未知值。
先把 enum 定义成有标量值的 backed enum
例如订单状态需要落库、传给前端或进入消息队列时,可以把接口契约固定为小写字符串。不要依赖 case 名称自动推导 value,PHP 不会替你生成连续数字。
同一个 enum 只能选择一种 backed 类型;如果声明为 int,所有 case 都必须使用整数。两个 case 不能共享同一个标量值,否则定义阶段就会失败。

默认 json_encode 如何保持 value 类型
backed enum 不需要额外实现接口,直接放进数组或对象属性即可。字符串 backed enum 输出 JSON 字符串,整数 backed enum 输出 JSON 数字。
1024,
'status' => PaymentStatus::Paid,
];
// JSON_THROW_ON_ERROR 让序列化失败变成异常,避免静默得到 false。
$json = json_encode($payload, JSON_THROW_ON_ERROR);
echo $json;
{"order_id":1024,"status":"paid"}
这里的 paid 来自 PaymentStatus::Paid->value,不是字符串 Paid。如果业务要求数字协议,就声明 enum PaymentStatus: int 并给出明确整数;不要在序列化前临时把不同类型拼在一起。
| 场景 | 默认结果 | 建议 |
|---|---|---|
| backed enum | 输出 string 或 int value | 把 value 当作接口契约维护 |
| pure enum | JSON 化会报错 | 需要传输时改为 backed enum 或显式映射 |
| 自定义对象结构 | 默认不会自动生成 | 实现 JsonSerializable |
接收 JSON 时用 from 还是 tryFrom
输出固定 value 只是半程。读回请求或数据库字段时,from() 找不到 value 会抛出 ValueError,适合已通过约束的内部数据;tryFrom() 找不到时返回 null,更适合用户输入或旧数据兼容。
value;
若输入来自内部白名单,也可以写 PaymentStatus::from($rawStatus),让异常尽早暴露。两种方法都不会把未知字符串“猜成”某个 case。

需要对象结构时再实现 JsonSerializable
如果前端不仅要 value,还要显示名、颜色或是否终态,别把默认 backed value 和自定义响应混为一谈。枚举可以实现 JsonSerializable,明确返回一个数组;这会覆盖默认的标量序列化行为。
$this->value,
'label' => match ($this) {
self::Pending => '待支付',
self::Paid => '已支付',
self::Cancelled => '已取消',
},
];
}
}
只需要机器可读状态时,保留默认 backed value 更简单;需要复合对象时,才用 JsonSerializable,并为新增字段补充接口兼容策略。
常见问题
为什么输出的是 value,不是 case 名称?
这是 backed enum 的默认 JSON 规则。名称是 PHP 代码标识,value 才是你显式定义的传输标识。
可以让一个 enum 同时有字符串和整数 value 吗?
不可以。一个 backed enum 只能选择 string 或 int 一种类型。
pure enum 怎么传给前端?
纯 enum 不能直接 JSON 化;可以改成 backed enum,或在 DTO 映射层显式返回名称和业务值。
未知 value 应该返回哪个状态?
不要静默猜测。用 tryFrom() 得到 null 后返回校验错误,只有业务明确允许默认值时才做降级。
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
226 收藏
-
271 收藏
-
文章 · php教程 | 4小时前 | HTTP · PHP · 响应头 · 输出缓冲 · 排错 · php 响应头 output_buffering headers_sent header_remove180 收藏
-
文章 · php教程 | 5小时前 | php教程 · session_start · PHP会话 · PHP配置排查 · 目录权限 · session.save_path PHP session_start PHP会话保存路径 session_save_path排查 PHP会话目录权限489 收藏
-
139 收藏
-
323 收藏
-
369 收藏
-
315 收藏
-
201 收藏
-
337 收藏
-
444 收藏
-
文章 · php教程 | 16小时前 | php教程 · 日期处理 · DatePeriod · 时间区间 · 参数语义 · PHP DatePeriod DatePeriod INCLUDE_END_DATE PHP 日期区间结束日期 PHP 日期周期边界 DatePeriod recurrences355 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习