开发者社区> code-x> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

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": "正常"
    }
}

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
SpringBoot 整合 Redis
SpringBoot整合Redis 本实例应用redis做登录及状态检查 添加pom依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> application.
898 0
基于SpringBoot+Redis的Session共享与单点登录
title: 基于SpringBoot+Redis的Session共享与单点登录date: 2019-07-23 02:55:52categories: 架构author: mrzhoutags:SpringBootredissession单点登录基于SpringBoot+Redis的Session共享与单点登录前言使用Redis来实现Session共享,其实网上已经有很多例子了,这是确保在集群部署中最典型的redis使用场景。
2922 0
SpringBoot连接Redis哨兵模式
SpringBoot连接Redis哨兵模式
7054 0
SpringBoot(十)_springboot集成Redis
Redis 介绍 Redis是一款开源的使用ANSI C语言编写、遵守BSD协议、支持网络、可基于内存也可持久化的日志型、Key-Value高性能数据库。 数据模型 Redis 数据模型不仅与关系数据库管理系统(RDBMS)不同,也不同于任何简单的 NoSQL 键-值数据存储。
1108 0
SpringBoot中搭建Redis缓存
SpringBoot中搭建Redis缓存 (一)SpringBoot中搭建Redis缓存 这篇文章讲述如何在Springboot中搭建redis,参考了很多大神的文章但是运用在我的项目里却不能发挥出来 ,可能框架原因把,因为是在项目搭建完成后再来搭的redis的。
1200 0
SpringBoot+Redis实现Session数据共享
使用SpringBoot+Redis实现Session数据共享。
1838 0
springboot中redis的使用和分布式session共享问题
本文旨在解决分布式系统的session如何共享问题,大致思路:session放入redis。其他解决方案:持久化、放cache等都可以,但是自从有了redis,这完全可以变的简简单单。
1174 0
+关注
14
文章
1
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载