在 Spring Boot Web 应用程序中序列化枚举

在 spring boot web 应用程序中序列化枚举

枚举类型在定义应用程序域内有限且明确的值集方面非常有效,有助于避免代码中出现无效状态。

应用场景

以下以一个Spring Boot 3.3.x 和 MongoDB 实现的笔记Web应用为例,演示枚举值的序列化和反序列化方法。 我们将定义一个Type枚举,表示待办事项的类型:事件和活动。

public enum Type {    EVENT("event"),    ACTIVITY("activity");    private final String value;    Type(String value) {        this.value = value;    }    public String getValue() {        return value;    }    private static final Map ENUM_MAP;    static {        ENUM_MAP = Arrays.stream(values())                .collect(Collectors.toMap(Type::getValue, t -> t));    }    public static Type fromString(String value) {        return ENUM_MAP.get(value);    }}

登录后复制

我们的Todo实体类:

public class Todo {    private String id;    private String name;    private boolean completed;    private Type type;    // ... getters and setters ...}

登录后复制

我们将探讨以下场景:

枚举作为查询参数。枚举作为JSON请求体的一部分。枚举作为MongoDB文档字段。

1. 枚举作为查询参数

此场景只需反序列化,将字符串值转换为枚举。 以下是一个控制器方法片段,用于根据类型读取待办事项,类型作为查询参数传递:

@GetMapping("/todos")public Collection read(@RequestParam(required = false) Type type) {    // ... implementation ...}

登录后复制

由于查询参数为字符串,我们需要一个转换器:

public class StringToTypeConverter implements Converter {    @Override    public Type convert(String source) {        return Type.fromString(source);    }}

登录后复制

在配置类中注册转换器:

@Configurationpublic class WebConfig implements WebMvcConfigurer {    @Override    public void addFormatters(FormatterRegistry registry) {        registry.addConverter(new StringToTypeConverter());    }}

登录后复制

现在,当Type用作@RequestParam时,StringToTypeConverter将尝试将字符串值转换为枚举。

2. 枚举作为JSON请求体的一部分

为了正确处理JSON请求体中的枚举字段,我们需要在Type枚举中添加@JsonValue注解:

(上面的Type枚举已包含必要的fromString和ENUM_MAP)

3. 枚举作为MongoDB文档字段

为了在MongoDB中管理枚举的序列化/反序列化,我们需要使用@ValueConverter注解,并将文档字段与一个自定义的PropertyValueConverter类关联:

@Document(collection = "todos")public class Todo {    @Id    private String id;    // ... other fields ...    @ValueConverter(MongoEnumConverter.class)    private Type type;    // ... getters and setters ...}public class MongoEnumConverter implements PropertyValueConverter {    @Override    public Type convert(String source) {        return Type.fromString(source);    }    @Override    public String write(Type value) {        return value.getValue();    }}

登录后复制

MongoEnumConverter提供读写方法来管理转换。

总结

本文介绍了在常见Web场景中处理枚举序列化/反序列化的几种方法。 Spring和Jackson库提供了简化此过程的工具。 完整的代码示例可在一个公开的GitLab仓库中找到。(此处省略GitLab仓库链接,因为我没有访问权限)

本文中提供的代码已获得CC0许可。

以上就是在 Spring Boot Web 应用程序中序列化枚举的详细内容,更多请关注【创想鸟】其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至253000106@qq.com举报,一经查实,本站将立刻删除。

发布者:PHP中文网,转转请注明出处:https://www.chuangxiangniao.com/p/2607425.html

(0)
上一篇 2025年3月6日 20:27:34
下一篇 2025年2月26日 07:39:13

AD推荐 黄金广告位招租... 更多推荐

相关推荐

  • 如何使用 Micronaut 注释进行封装?

    这种封装设计有效防止了对userId和name的直接修改,确保只有授权操作才能更改其值。 Micronaut框架的实际应用 Micronaut是一个基于JVM的现代微服务框架,它通过注解提供了更高级别的封装和数据验证功能。让我们来分析示例中…

    2025年3月6日
    200
  • 何时使用 ResponseEntity?

    让我们来看一个控制器示例,它包含以下端点: @RestController@RequestMapping(“v1/hello”)public class ExampleController { @GetMapping public Resp…

    2025年3月6日
    200
  • 作为独立开发者打造独角兽初创公司

    从零开始打造科技独角兽:一位独立开发者的创业之旅 许多人梦想创办科技公司,但作为独立开发者创建一家独角兽初创企业?这正是我迎接的挑战。本系列文章将分享我的创业历程、技术选型及关键决策。敬请期待后续文章的详细解读。 愿景 我的创业灵感源于一个…

    2025年3月6日
    200
  • 后端微服务Webflux Java库简介(Reactor-core)

    GitHub链接:https://www.php.cn/link/e608961813ac47bc0cfbcac85dd2147f 1. Reactify-Core库概述 本库基于Spring WebFlux和Reactor-Core构建,…

    2025年3月6日
    200
  • 我的电动车计划

    2025年,我将开启一段充满挑战和成长的旅程,不仅在开发领域,更在个人层面。 这是我首次制定如此具体的年度目标,并希望通过记录分享我的进步。 1. 健康优先 远程工作固然便捷,但久坐不动并非良策。我的计划是:每周至少步行3次,每次30分钟。…

    2025年3月6日
    200
  • 基于 Spring Oauth App-Token 的混合令牌验证方法

    还在为搭建持久化OAuth2模块而苦恼吗?不妨试试这个简便方案: https://www.php.cn/link/3f826f30bc252fb41b7ef03b98ee98c8 这是一个基于App-Token的轻量级OAuth2实现,专为…

    2025年3月6日
    200
  • 将 JPA 实体转换为 Mendix

    最近在探索 mendix 时,我注意到他们有一个 platform sdk,允许您通过 api 与 mendix 应用程序模型进行交互。 这给了我一个想法,探索它是否可以用于创建我们的领域模型。具体来说,是基于现有的传统应用程序创建领域模型…

    2025年3月6日
    200
  • 微服务部分创建服务注册表应用程序

    构建微服务应用的第一步是搭建服务注册中心,它本身也是一个特殊的微服务,负责维护所有其他微服务的注册信息。 整个过程分为六个步骤: 步骤一:创建服务注册中心 使用 spring-cloud-starter-netflix-eureka-ser…

    2025年3月6日
    200
  • 在 Java 中传递属性

    Java 属性传递机制详解 Java 作为一门流行的面向对象编程语言,其参数传递机制至关重要。本文将深入探讨 Java 中属性传递的各种方法,帮助开发者编写高效、可靠的代码。 Java 采用严格的值传递机制。这意味着当将变量传递给方法时,会…

    2025年3月6日
    200
  • 面试中最常被问到的核心 Java 问题

    以下是一些 Java 技术面试中常见的核心问题: 核心 Java 面试题: Java 平台无关性的原因是什么?为什么 Java 不是纯粹的面向对象编程语言?Java 中堆内存和栈内存的区别是什么?Java 如何使用它们?Java 与 C 语…

    2025年3月6日
    200

发表回复

登录后才能评论