SpringBoot自定义枚举序列化方式

简介: SpringBoot自定义枚举序列化方式

在平常web开发中, 或多或少的会使用到枚举类型

但是springboot对枚举的序列化并不太符合实际开发需求

比如

public enum MerchantStatusEnum {
    NORMAL(100, "正常"),
    BAN(200, "封禁");
    private final Integer type;
    private final String name;
    MerchantStatusEnum(Integer type, String name) {
        this.name = name;
        this.type = type;
    }
}

复制

序列化后是这样的

{
    "status": "NORMAL"
}

复制

而且使用枚举接受请求参数时, 字段也必须采用如上格式, 对前端不太便利.

所以自定义枚举的序列化器进行自定义的序列化

改造如下

定义接口

public interface TypeEnum {
    /**
     * 由枚举实现
     *
     * @return 枚举类的type字段
     */
    Integer getType();
    /**
     * 由枚举实现
     *
     * @return 枚举类的name字段
     */
    String getName();
}

复制

实现接口, 标记此枚举使用自定义的序列化方式

@Getter
public enum MerchantStatusEnum implements TypeEnum {
    /**
     * 正常
     */
    NORMAL(100, "正常"),
    /**
     * 封禁
     */
    BAN(200, "封禁");
    @EnumValue
    private final Integer type;
    private final String name;
    MerchantStatusEnum(Integer type, String name) {
        this.name = name;
        this.type = type;
    }
}

复制

type到枚举的映射方法

public class EnumUtil {
    private static final Map<Class<? extends Enum<?>>, Map<Integer, ? extends Enum<? extends TypeEnum>>> CLASS_ENUM_MAP =
            new ConcurrentHashMap<>(16);
    @SuppressWarnings("unchecked")
    public static <E extends Enum<E> & TypeEnum> E match(Class<E> enumClass, Integer type) {
        var enumMap = CLASS_ENUM_MAP.get(enumClass);
        if (Objects.isNull(enumMap)) {
            var unmodifiableMap = Arrays.stream(enumClass.getEnumConstants())
                    .collect(Collectors.toUnmodifiableMap(TypeEnum::getType, v -> v));
            CLASS_ENUM_MAP.putIfAbsent(enumClass, unmodifiableMap);
            return unmodifiableMap.get(type);
        }
        return (E) enumMap.get(type);
    }
}

复制

自定义反序列化类

public class TypeEnumDeserializer extends StdDeserializer<TypeEnum> implements ContextualDeserializer {
    public TypeEnumDeserializer() {
        super((JavaType) null);
    }
    public TypeEnumDeserializer(JavaType valueType) {
        super(valueType);
    }
    @Override
    public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) {
        return new TypeEnumDeserializer(property.getType());
    }
    @Override
    @SuppressWarnings("all")
    public TypeEnum deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        return (TypeEnum) EnumUtil.match((Class) _valueClass, p.getIntValue());
    }
}

复制

注册到springboot中

@Configuration
@Slf4j
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        var stringHttpMessageConverter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
        var converter = new MappingJackson2HttpMessageConverter();
        converter.setObjectMapper(objectMapperForWebConvert());
        converters.add(0, stringHttpMessageConverter);
        converters.add(0, converter);
    }
    public ObjectMapper objectMapperForWebConvert() {
        var om = new ObjectMapper();
        om.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        var sm = new SimpleModule();
        //自定义查找规则
        sm.setDeserializers(new SimpleDeserializers() {
            @Override
            public JsonDeserializer<?> findEnumDeserializer(Class<?> type, DeserializationConfig config,
                                                            BeanDescription beanDesc) throws JsonMappingException {
                var enumDeserializer = super.findEnumDeserializer(type, config, beanDesc);
                if (enumDeserializer != null) {
                    return enumDeserializer;
                }
                //遍历枚举实现的接口, 查找反序列化器
                for (var typeInterface : type.getInterfaces()) {
                    enumDeserializer = this._classMappings.get(new ClassKey(typeInterface));
                    if (enumDeserializer != null) {
                        return enumDeserializer;
                    }
                }
                return null;
            }
        });
        sm.addDeserializer(TypeEnum.class, new TypeEnumDeserializer());
        sm.addSerializer(TypeEnum.class, new JsonSerializer<>() {
            @Override
            public void serialize(TypeEnum value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
                gen.writeStartObject();
                gen.writeNumberField("type", value.getType());
                gen.writeStringField("name", value.getName());
                gen.writeEndObject();
            }
            @Override
            public void serializeWithType(TypeEnum value, JsonGenerator gen, SerializerProvider serializers,
                                          TypeSerializer typeSer) throws IOException {
                var typeIdDef = typeSer.writeTypePrefix(gen, typeSer.typeId(value, JsonToken.VALUE_STRING));
                serialize(value, gen, serializers);
                typeSer.writeTypeSuffix(gen, typeIdDef);
            }
        });
        om.registerModule(sm);
        return om;
    }
}

复制

自此, 前端可以传递type值即可映射到枚举

{
    "status": 100
}

复制

后端的响应

{
    "status": {
        "type": 100,
        "name": "正常"
    }
}
目录
相关文章
|
1月前
|
XML Java 数据格式
Springboot中自定义组件
Springboot中自定义组件
|
1月前
|
Java
LocalDateTime的全局自定义序列化
LocalDateTime的全局自定义序列化
|
1月前
|
安全 Java Spring
SpringBoot2 | SpringBoot监听器源码分析 | 自定义ApplicationListener(六)
SpringBoot2 | SpringBoot监听器源码分析 | 自定义ApplicationListener(六)
59 0
|
1月前
|
消息中间件 存储 负载均衡
Kafka【付诸实践 01】生产者发送消息的过程描述及设计+创建生产者并发送消息(同步、异步)+自定义分区器+自定义序列化器+生产者其他属性说明(实例源码粘贴可用)【一篇学会使用Kafka生产者】
【2月更文挑战第21天】Kafka【付诸实践 01】生产者发送消息的过程描述及设计+创建生产者并发送消息(同步、异步)+自定义分区器+自定义序列化器+生产者其他属性说明(实例源码粘贴可用)【一篇学会使用Kafka生产者】
315 4
|
1月前
|
缓存 Java Sentinel
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
|
1月前
|
Java 数据库 数据安全/隐私保护
【SpringBoot】Validator组件+自定义约束注解实现手机号码校验和密码格式限制
【SpringBoot】Validator组件+自定义约束注解实现手机号码校验和密码格式限制
229 1
|
1月前
|
JSON 安全 Java
Spring Boot 序列化、反序列化
本文介绍了Spring Boot中的序列化和反序列化。Java提供默认序列化机制,通过实现Serializable接口实现对象到字节流的转换。Spring Boot默认使用Jackson处理JSON,可通过注解和配置自定义规则。然而,序列化可能引发安全问题,建议使用白名单、数据校验和安全库。最佳实践包括使用标准机制、自定义规则及注意版本控制。文章还提醒关注性能并提供了相关参考资料。
96 2
|
1月前
|
Java
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
|
1月前
|
前端开发 Java
SpringBoot之自定义注解参数校验
SpringBoot之自定义注解参数校验
27 2
|
1月前
|
消息中间件 分布式计算 Kafka
硬核!Apache Hudi中自定义序列化和数据写入逻辑
硬核!Apache Hudi中自定义序列化和数据写入逻辑
60 1