Spring Boot 枚举类型的自动转换初探

2023-10-14 09:36:24

Spring Boot 是一个强大的 Java 框架，它可以帮助我们快速开发和部署 Spring 应用程序。在 Spring Boot 中，我们可以使用多种工具和技巧来实现枚举类型的自动转换，从而提高代码的可读性和可维护性。

需求

一般我们在数据库都会定义数值型的枚举常量，不管是序列化还是反序列化都是需要我们手动去转换成枚举类型的，既然这样我们能不能让它们自动转换呢？接下来我将会以 JSON 的序列化与反序列化为例演示如何配置让 Spring Boot 自动完成类型转换。

实现方式

1. 使用 Apache Commons Lang 的 EnumUtils

Apache Commons Lang 是一个流行的 Java 库，它提供了许多有用的实用程序类，其中包括 EnumUtils 类。EnumUtils 类提供了静态方法来帮助我们转换枚举类型。

例如，我们可以使用 EnumUtils.getEnum() 方法将字符串值转换为枚举值：

import org.apache.commons.lang3.EnumUtils;

public class EnumUtilsExample {

    public static void main(String[] args) {
        String status = "ACTIVE";
        StatusEnum statusEnum = EnumUtils.getEnum(StatusEnum.class, status);
        System.out.println(statusEnum); // prints ACTIVE
    }
}

enum StatusEnum {
    ACTIVE,
    INACTIVE
}

2. 使用 Spring Boot 的 `@JsonEnum` 注解

Spring Boot 还提供了一个 @JsonEnum 注解，我们可以使用这个注解来标记枚举类型，从而启用自动转换。

例如，我们可以使用 @JsonEnum 注解来标记 StatusEnum 枚举类型：

import com.fasterxml.jackson.annotation.JsonEnum;

@JsonEnum
enum StatusEnum {
    ACTIVE,
    INACTIVE
}

这样，当我们使用 Jackson 库来序列化或反序列化枚举值时，Spring Boot 会自动将枚举值转换为字符串值或字符串值转换为枚举值。

3. 使用 Jackson 的 `@JsonConverter` 注解

Jackson 库还提供了一个 @JsonConverter 注解，我们可以使用这个注解来定义自定义的类型转换器。

例如，我们可以使用 @JsonConverter 注解来定义一个自定义的类型转换器，用于将字符串值转换为枚举值：

import com.fasterxml.jackson.annotation.JsonConverter;
import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

@JsonConverter
public class StringToEnumConverter implements JsonSerializer<String> {

    private final Class<? extends Enum<?>> enumType;

    public StringToEnumConverter(Class<? extends Enum<?>> enumType) {
        this.enumType = enumType;
    }

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeString(EnumUtils.getEnum(enumType, value).name());
    }

    @Override
    public void serializeWithType(String value, JsonGenerator gen, SerializerProvider serializers, TypeSerializer typeSer) throws IOException {
        serialize(value, gen, serializers);
    }
}