从零搭建开发脚手架 SpringMvc中枚举类型参数的序列化和反序列化
admin
2024-04-12 21:25:27
0

文章目录

    • 背景
    • 优化
      • 针对普通请求参数
      • 针对RequestBody参数
      • 针对枚举类型响应

背景

以下是我们一般的枚举类配合SpringMvc使用方式。

枚举类如下

public enum Distance {KILOMETER("km", 1000),MILE("miles", 1609.34),METER("meters", 1);private String unit;private final double meters;Distance(String unit, double meters) {this.unit = unit;this.meters = meters;}

实体类如下

public class City {private String id;private Distance distance;

Controller如下

-- /api/v1?distance=KILOMETER
@GetMapping
public void get(Distance distance) -- /api/v1?distance=KILOMETER&id=1
@GetMapping
public void get(City city) -- json
{"id": "1","distance": "KILOMETER"
}
@PostMapping
public void post(@RequestBody City city)-- 反序列化    
@GetMapping
public City get()
-- json    
{"id": "1","distance": "KILOMETER"
}    

默认所有的参数和响应都是大写的字符串枚举名称

优化

我们想自定义序列化和反序列化字段,例如使用unit或者meters属性。

针对普通请求参数

-- /api/v1?distance=KILOMETER
@GetMapping
public void get(Distance distance) -- /api/v1?distance=KILOMETER&id=1
@GetMapping
public void get(City city) 

1. 定义IEnum接口

public interface IEnum {T getValue();
}

2.基于SpringMvc的Converter实现StringToEnum转换

public class StringToEnumConvertFactory implements ConditionalGenericConverter {@Overridepublic boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {return IEnum.class.isAssignableFrom(targetType.getObjectType()) && sourceType.getObjectType() == String.class;}@Overridepublic Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {IEnum[] enums = (IEnum[]) targetType.getObjectType().getEnumConstants();for (IEnum anEnum : enums) {if (Objects.equals(anEnum.getValue(), source)) {return anEnum;}}return null;}
}

3.把转换器注册到SpringMvc

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {@Overridepublic void addFormatters(FormatterRegistry registry) {registry.addConverter(new StringToEnumConvertFactory());}    

4.自定义枚举实现定义IEnum接口

public enum Distance implements IEnum {KILOMETER("km", 1000),MILE("miles", 1609.34),METER("meters", 1);private String unit;private final double meters;Distance(String unit, double meters) {this.unit = unit;this.meters = meters;}@Override // 这里选择转换的属性public String getValue() {return unit;}
}

实现效果如下

-- /api/v1?distance=km
-- /api/v1?distance=miles
@GetMapping
public void get(Distance distance) -- /api/v1?distance=km&id=1
@GetMapping
public void get(City city) 

针对RequestBody参数

-- json
{"id": "1","distance": "KILOMETER"
}
@PostMapping
public void post(@RequestBody City city)

直接在枚举的指定get方法使用@JsonValue注解即可。

public enum Distance implements IEnum {KILOMETER("km", 1000),MILE("miles", 1609.34),METER("meters", 1);private String unit;private final double meters;Distance(String unit, double meters) {this.unit = unit;this.meters = meters;}@Override@JsonValue // 这里配置public String getValue() {return unit;}
}

实现效果如下

-- json
{"id": "1","distance": "km"
}
@PostMapping
public void post(@RequestBody City city)

针对枚举类型响应

直接在get方法使用@JsonValue注解即可。跟上面方式一样

实现效果如下

-- 反序列化    
@GetMapping
public City get()
-- json    
{"id": "1","distance": "km"
}   

更多Jackson序列化和反序列化参考:https://blog.csdn.net/hj_5346/article/details/127269700

  • @JsonFormat(shape = JsonFormat.Shape.OBJECT)
  • @JsonValue
  • @JsonSerialize(using = DistanceSerializer.class)
  • @JsonProperty(“distance-in-km”)
  • @JsonCreator
  • @JsonDeserialize(using = CustomEnumDeserializer.class)

相关内容

热门资讯

安卓怎么传到苹果系统,从安卓到... 你是不是也有过这样的烦恼:手机里存了好多好用的安卓应用,可是一换到苹果系统,就发现这些宝贝们都不见了...
安卓改系统字体app,安卓系统... 你有没有想过,手机上的字体也能变得个性十足?没错,就是那个安卓改系统字体app,它可是让手机界面焕然...
安卓系统重启密码错误,破解与预... 手机突然重启了,屏幕上竟然出现了密码输入的界面!这可怎么办?别急,让我来帮你一步步解决这个安卓系统重...
安卓系统怎么删除相片,照片删除... 手机里的相片越来越多,是不是感觉内存都要不够用了?别急,今天就来教你怎么在安卓系统里轻松删除那些不再...
什么安卓机系统最好,安卓系统最... 你有没有想过,手机里那个默默无闻的系统,其实才是决定你手机体验好坏的关键呢?没错,说的就是安卓机系统...
小米手环8安卓系统,智能生活新... 你有没有注意到,最近小米手环8安卓系统成了大家热议的话题呢?这款智能手环自从上市以来,就凭借其强大的...
虹膜系统怎么换为安卓,技术革新... 你有没有想过,你的虹膜系统怎么换为安卓呢?这可是个挺酷的话题,不是吗?想象你的手机上装了个高科技的虹...
安卓刷苹果mac系统,探索跨平... 你有没有想过,你的安卓手机竟然能变身成为苹果Mac系统的超级战士?没错,这就是今天我要跟你分享的神奇...
安卓系统不模仿苹果,不模仿苹果... 你知道吗?在科技圈里,有一场关于操作系统的大戏正在上演。没错,就是安卓系统和苹果iOS系统之间的较量...
安卓系统计步开启,开启健康生活... 你有没有发现,最近你的手机里多了一个小助手——计步器?没错,就是那个默默记录你每一步的小家伙。今天,...
怎么备份安卓系统 recove... 你有没有想过,如果你的安卓手机突然间像顽皮的小猫一样,把你的照片、视频和重要文件都给“藏”了起来?别...
安卓系统同步功能停用,安卓系统... 最近发现了一个让人有点小郁闷的消息——安卓系统的同步功能竟然被停用了!这可真是让人有点措手不及呢。想...
安卓系统的平板重装系统,轻松恢... 你那安卓平板是不是突然间卡得跟蜗牛似的,系统反应慢得跟乌龟赛跑似的?别急,今天就来给你支个招,教你怎...
安卓操作系统语言,引领智能时代... 你知道吗?在手机世界里,有一个超级厉害的操作系统,它就是安卓!这个操作系统可是全球最流行的,几乎每个...
安卓系统声音录音软件,声音记录... 你有没有想过,在安卓手机上,那些美妙的旋律、有趣的对话或者重要的会议内容,如何变成你随时可以回顾的宝...
coloros系统和安卓9,创... 你知道吗?最近手机圈里可是热闹非凡呢!一款名为ColorOS的系统,还有那个大家熟悉的安卓9,它们俩...
安卓个推系统搭建,基于个推系统... 你有没有想过,自己的手机里那些推送消息是怎么悄无声息地出现在你眼前的?没错,就是安卓个推系统在默默为...
设置系统时间app安卓,安卓时... 你有没有想过,手机里那个默默无闻的系统时间,竟然能通过一个小巧的App变得如此有趣和个性化?没错,今...
安卓系统输出开关量,安卓系统开... 你有没有想过,你的安卓手机里竟然隐藏着这么一个神奇的开关量输出功能?没错,就是那个你可能从未留意过的...
安卓系统音乐软件推荐,五大热门... 你有没有发现,手机里音乐软件那么多,挑一款适合自己的真心不容易啊!安卓系统上的音乐软件更是五花八门,...