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

wufei123 2025-01-26 阅读:72 评论:0

枚举类型在定义应用程序域内有限且明确的值集方面非常有效，有助于避免代码中出现无效状态。应用场景以下以一个Spring Boot 3.3.x 和 MongoDB 实现的笔记Web应用为例，演示枚举值的序列化和反序列化方法。我们将定义...

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

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

应用场景

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

PHP

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<String, Type> 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实体类：

PHP

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

我们将探讨以下场景：

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

1. 枚举作为查询参数

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

PHP

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

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

PHP

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

在配置类中注册转换器：

PHP

@Configuration
public 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类关联：

PHP

@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<Type, String> {
    @Override
    public Type convert(String source) {
        return Type.fromString(source);
    }

    @Override
    public String write(Type value) {
        return value.getValue();
    }
}