Java 中枚举怎么通过重写 toString 方法配合前端进行 JSON 序列化

落伟大大_1362

落伟大大_1362

2026-08-03

880人浏览

原创

重写 tostring() 对 json 序列化无效,因为 jackson 和 fastjson 默认使用 name() 而非 tostring() 输出枚举字符串;推荐用 @jsonvalue 注解 getter 方法返回友好文本,或用 @jsonformat(shape = object) 输出 code + label 结构化数据。

java 中枚举怎么通过重写 tostring 方法配合前端进行 json 序列化

Java 枚举默认的 toString() 返回的是枚举常量名(如 USER),而前端通常需要更友好的中文描述(如 "用户")或结构化字段。直接重写 toString() 并不能可靠控制 JSON 序列化结果,因为主流 JSON 库(如 Jackson、FastJSON)默认序列化枚举时,用的是 name() 或自定义序列化器,toString() 不会被自动调用。

为什么重写 toString() 对 JSON 序列化无效?

Jackson 默认将枚举序列化为字符串时,输出的是 name()(即大写常量名),不是 toString() 的返回值。FastJSON 行为类似。除非显式配置序列化器,否则 toString() 只在日志、打印、调试等场景生效,不参与 JSON 输出。

推荐做法:用 @JsonValue + 自定义字段

让枚举携带可读文本,并通过 @JsonValue 告诉 Jackson 使用哪个方法作为序列化值:

  • 定义一个私有字段(如 desc)存储前端需要的展示文本
  • 提供 getter 方法(如 getDesc())
  • 在该 getter 上加 @JsonValue 注解

示例:

public enum UserType {
    ADMIN("管理员"),
    USER("普通用户"),
    GUEST("访客");

    private final String desc;

    UserType(String desc) {
        this.desc = desc;
    }

    @JsonValue
    public String getDesc() {
        return desc;
    }
}

这样序列化后 JSON 就是 "管理员"、"普通用户" 等字符串,前端可直接使用。

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载

补充:前端需要 code + label 时,用 @JsonFormat 或自定义序列化器

如果前端需要同时拿到枚举的英文 code(如 "ADMIN")和中文 label(如 "管理员"),建议返回对象而非字符串:

  • 不重写 toString(),也不用 @JsonValue
  • 定义一个 DTO 或直接在枚举中提供 toMap() / toJson() 方法
  • 或配合 @JsonFormat(shape = JsonFormat.Shape.OBJECT)(Jackson 2.12+)

例如:

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum Status {
    ACTIVE("ACTIVE", "启用"),
    INACTIVE("INACTIVE", "停用");

    private final String code;
    private final String label;

    Status(String code, String label) {
        this.code = code;
        this.label = label;
    }

    public String getCode() { return code; }
    public String getLabel() { return label; }
}

序列化结果为:{"code":"ACTIVE","label":"启用"},前后端契约清晰。

不推荐:仅靠重写 toString() 配合 JSON 库

虽然可以强行让 Jackson 使用 toString()(如注册自定义 SimpleModule + ToStringSerializer),但这样做:

  • 全局影响所有枚举,容易误伤
  • 丧失 code 字段,无法做后端逻辑判断(比如 if (type == ADMIN))
  • 与前端约定脱节,不可扩展

维护成本高,且违背枚举的设计初衷——类型安全 + 明确语义。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java接口 java js 前端 json

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2203

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

4703

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5850

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5298

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

743

5

java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9417

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6582

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5852

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1024

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习