Springboot系列之RestApi中获取枚举类属性的几种方式

2024-06-01 05:38
文章标签 java springboot spring 系列 方式 属性 获取 几种 枚举 restapi

本文主要是介绍Springboot系列之RestApi中获取枚举类属性的几种方式，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

我们在日常开发中经常会遇到，实体类中的枚举属性，在通过@ResponseBody注解返回到前端后，默认被解析成了枚举对象的name值，当我们需要获取枚举类的详细属性时就会变得非常麻烦，今天给大家分享几种常用的获取枚举类属性的方式。

例子

我们先通过一个小例子讲解这个问题，首先我们要准备一个简单的接口，用于查询用户信息，用户实体中包含性别、用户类型和用户状态三种枚举属性，我们下面的例子中， 将会分别拿这三个枚举类进行测试。
代码如下：
用户实体User.java

@Data
public class User {private String username;private String site;private String[] git;private GenderEnum gender;private TypeEnum type;private StatusEnum status;
}

枚举类内容如下：
GenderEnum.java

public enum GenderEnum {MALE("男"),FAMALE("女");private String desc;GenderEnum(String desc) {this.desc = desc;}public String getDesc() {return desc;}
}

TypeEnum.java

public enum TypeEnum {ADMIN("管理员"),USER("普通用户");private String desc;TypeEnum(String desc) {this.desc = desc;}public String getDesc() {return desc;}
}

StatusEnum.java

public enum StatusEnum {INUSE("使用中"),UNUSED("未使用"),DISABLED("已禁用");private String desc;StatusEnum(String desc) {this.desc = desc;}public String getDesc() {return desc;}
}

Controller类RestApiController.java

@RestController
public class RestApiController {@RequestMapping("/users")public Object users() {List<User> userList = new ArrayList<>();User user = null;for (int i = 0; i < 2; i++) {user = new User();user.setGender(i % 2 == 0 ? GenderEnum.MALE : GenderEnum.FAMALE);user.setType(i % 2 == 0 ? TypeEnum.ADMIN : TypeEnum.USER);user.setStatus(i % 2 == 0 ? StatusEnum.INUSE : StatusEnum.DISABLED);user.setUsername("user_" + i);user.setSite("https://www.zhyd.me");user.setGit(new String[]{"https://gitee.com/yadong.zhang", "https://github.com/zhangyd-c"});userList.add(user);}return userList;}
}

接口返回数据的原始内容如下：

[{"username": "user_0","site": "https://www.zhyd.me","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"gender": "MALE","type": "ADMIN","status": "INUSE",},{"username": "user_1","site": "https://www.zhyd.me","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"gender": "FAMALE","type": "USER","status": "DISABLED"}
]

从接口数据中可以清楚的看到，枚举类属性被解析成了字符串。接下来我们将分别通过几种方式，完成对枚举类属性的获取。

第一种：新增Get方法

这种方式，需要我们在User.java实体类中，为用户类型枚举属性添加对应的get方法：

@Data
public class User {private String username;private String site;private String[] git;private GenderEnum gender;private TypeEnum type;private StatusEnum status;public String getTypeEnumDesc() {return null == type ? null : type.getDesc();}
}

接口响应内容：

[{"username": "user_0","site": "https://www.zhyd.me","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"gender": "MALE","type": "ADMIN","status": "INUSE","typeEnumDesc": "管理员"},{"username": "user_1","site": "https://www.zhyd.me","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"gender": "FAMALE","type": "USER","status": "DISABLED","typeEnumDesc": "普通用户"}
]

这种方式的优缺点：

  • 优点
    • 简单，不需要集成其他代码
  • 缺点
    • 扩展性差，如果一个枚举类存在多个属性，那我们就要在业务bean中为每个枚举属性单独增加get方法，想想都觉得头疼。

一般用来应急

第二种：通过自定义FastJsonHttpMessageConverter完成对Enum的转换

注：本人开发环境的fastjson版本为1.2.37, 另外测试了1.2.34和1.2.52，其他版本可能有所差异

改进枚举类

本小节只以TypeEnum.java枚举类为例，重写枚举类的toString方法

TypeEnu.java

public enum TypeEnum {ADMIN("管理员"),USER("普通用户");private String desc;TypeEnum(String desc) {this.desc = desc;}public String getDesc() {return desc;}@Overridepublic String toString() {return "{\\\"name\\\": \\\"" + this.name() + "\\\", \\\"desc\\\": \\\"" + this.getDesc() + "\\\"}";}
}

新增配置类

@Configuration
public class WebMvcConf implements WebMvcConfigurer {@Overridepublic void extendMessageConverters(List<HttpMessageConverter<?>> converters) {converters.forEach(System.out::println);}/*** 自定义FastJsonHttpMessageConverter处理api中的枚举*/@Configuration@ConditionalOnClass({FastJsonHttpMessageConverter.class})@ConditionalOnProperty(name = {"spring.http.converters.preferred-json-mapper"},havingValue = "fastjson",matchIfMissing = true)public class FastJsonHttpMessageConvertersConfiguration {@Bean@ConditionalOnMissingBean({FastJsonHttpMessageConverter.class})public FastJsonHttpMessageConverter fastJsonHttpMessageConverter() {FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();FastJsonConfig fastJsonConfig = new FastJsonConfig();fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat,SerializerFeature.WriteEnumUsingToString);converter.setFastJsonConfig(fastJsonConfig);return converter;}}
}

注：

  • @ConditionalOnClass表示当存在FastJsonHttpMessageConverter类时，才会加载该配置
  • @@ConditionalOnProperty表示当spring.http.converters.preferred-json-mapper配置项的值为fastjson时，才会加载该配置，并且即使没有(matchIfMissing)该property也会正常加载
  • @ConditionalOnMissingBean表示当没有注入FastJsonHttpMessageConverter类时，才会执行当前的注入操作

需要注意的是，一定要在SerializerFeature中添加SerializerFeature.WriteEnumUsingToString，表示在对枚举类序列化的时候，返回枚举类的toString()方法的值。关于SerializerFeature其他参数的说明，请参考https://blog.csdn.net/u010246789/article/details/52539576

重新访问接口，返回内容如下：

[{"gender":"MALE","status": "INUSE","git":["https:\/\/gitee.com\/yadong.zhang","https:\/\/github.com\/zhangyd-c"],"site":"https:\/\/www.zhyd.me","type":"{"name": "ADMIN", "desc": "绠＄悊鍛�"}","typeEnumDesc":"绠＄悊鍛�","username":"user_0"},{"gender":"FAMALE","status": "DISABLED","git":["https:\/\/gitee.com\/yadong.zhang","https:\/\/github.com\/zhangyd-c"],"site":"https:\/\/www.zhyd.me","type":"{"name": "USER", "desc": "鏅€氱敤鎴�"}","typeEnumDesc":"鏅€氱敤鎴�","username":"user_1"}
]

汉字全部乱码了，通过Debug发现，FastJsonHttpMessageConverter的supportedMediaTypes属性默认为*/*，这样就会造成浏览器在解析的时候无法识别具体的编码而导致解析失败，出现乱码问题。

我们修改一下fastJsonHttpMessageConverter方法，重新配置一下supportedMediaTypes，增加以下代码：

List<MediaType> mediaTypes = new ArrayList<>();
mediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
converter.setSupportedMediaTypes(mediaTypes);

响应数据如下：

[{"gender": "MALE","status": "INUSE","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"site": "https://www.zhyd.me","type": "{\"name\": \"ADMIN\", \"desc\": \"管理员\"}","typeEnumDesc": "管理员","username": "user_0"},{"gender": "FAMALE","status": "DISABLED","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"site": "https://www.zhyd.me","type": "{\"name\": \"USER\", \"desc\": \"普通用户\"}","typeEnumDesc": "普通用户","username": "user_1"}
]

到这儿还有一个问题就是：接口返回的枚举属性，是一个字符串，前端使用时，并不能直接使用，需要通过JSON.parse(x)格式化成json串后才能使用，我们在后台处理一下，使接口直接返回map形式的内容。

改进

修改枚举类(TypeEnum)的toString方法，将枚举类的属性通过map包装成JSON

@Override
public String toString() {Map<String, Object> map = new HashMap<>();map.put("name", this.name());map.put("desc", this.getDesc());return JSONObject.toJSONString(map);
}

然后修改配置类的fastJsonHttpMessageConverter方法，通过ValueFilter处理序列化的参数

ValueFilter valueFilter = (o, s, o1) -> {if (o1 instanceof Enum) {String str = String.valueOf(o1);if (isJson(str)) {o1 = JSONObject.parseObject(String.valueOf(o1), Map.class);}}return o1;
};
fastJsonConfig.setSerializeFilters(valueFilter);

代码很好理解：当序列化参数为枚举类型时，将json字符串转为map（此处不是多余，因为SerializerFeature中针对枚举的序列化方式，只有两种（nameortoString），所以我们必须先将map转成字符串，然后再转成map）。
注：鉴于编码过程中可能会漏掉重写一些枚举类的toString方法（或者重写toString方法时并没有返回正确的json格式字符串），而枚举类默认的toString方法返回的并不是json形式的字符串，所以，需要使用isJson(str)判断当前枚举序列化的结果是否为json字符串。

WebMvcConf.java详细代码如下：

@Configuration
public class WebMvcConf implements WebMvcConfigurer {@Overridepublic void extendMessageConverters(List<HttpMessageConverter<?>> converters) {converters.forEach(System.out::println);}private boolean isJson(String str) {return !StringUtils.isEmpty(str) && (str.charAt(0) == '{' && str.charAt(str.length() - 1) == '}');}/*** 自定义FastJsonHttpMessageConverter处理api中的枚举*/@Configuration@ConditionalOnClass({FastJsonHttpMessageConverter.class})@ConditionalOnProperty(name = {"spring.http.converters.preferred-json-mapper"},havingValue = "fastjson",matchIfMissing = true)public class FastJsonHttpMessageConvertersConfiguration {@Bean@ConditionalOnMissingBean({FastJsonHttpMessageConverter.class})public FastJsonHttpMessageConverter fastJsonHttpMessageConverter() {FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();FastJsonConfig fastJsonConfig = new FastJsonConfig();fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat,SerializerFeature.WriteEnumUsingToString);List<MediaType> mediaTypes = new ArrayList<>();mediaTypes.add(MediaType.APPLICATION_JSON_UTF8);converter.setSupportedMediaTypes(mediaTypes);ValueFilter valueFilter = (o, s, o1) -> {if (o1 instanceof Enum) {String str = String.valueOf(o1);if (isJson(str)) {o1 = JSONObject.parseObject(String.valueOf(o1), Map.class);}}return o1;};fastJsonConfig.setSerializeFilters(valueFilter);converter.setFastJsonConfig(fastJsonConfig);return converter;}}}

响应数据如下：

[{"gender": "MALE","status": "INUSE","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"site": "https://www.zhyd.me","type": {"name": "ADMIN","desc": "管理员"},"typeEnumDesc": "管理员","username": "user_0"},{"gender": "FAMALE","status": "DISABLED","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"site": "https://www.zhyd.me","type": {"name": "USER","desc": "普通用户"},"typeEnumDesc": "普通用户","username": "user_1"}
]

这种方式的优缺点：

  • 优点
    • 不需要对业务bean进行定制化，减少不必要的代码冗余和耦合
    • 扩展性好，枚举类中可以自定义多个属性
  • 缺点
    • 代码量大，新增了一个配置类
    • 每个枚举类中都需要OverridetoString方法，对代码的维护造成一定的影响

第三种：使用fastjson的@JSONType注解

因为Springboot默认使用的jackson的Converter，而@JSONType是fastjson的注解，所以这种方式也是基于FastJsonHttpMessageConverter的。

我们以StatusEnum.java为例，演示该注解的用法

首先修改StatusEnum.java为以下内容：

@JSONType(serializeEnumAsJavaBean = true)
public enum StatusEnum {INUSE("使用中"),UNUSED("未使用"),DISABLED("已禁用");private String desc;StatusEnum(String desc) {this.desc = desc;}public String getDesc() {return desc;}public String getName() {return this.name();}
}

注：如果此处存在反序列化异常，请参考：https://github.com/alibaba/fastjson/issues/1452

响应结果：

[{"gender": "MALE","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"site": "https://www.zhyd.me","status": {"desc": "使用中","name": "INUSE"},"type": {"name": "ADMIN","desc": "管理员"},"typeEnumDesc": "管理员","username": "user_0"},{"gender": "FAMALE","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"site": "https://www.zhyd.me","status": {"desc": "已禁用","name": "DISABLED"},"type": {"name": "USER","desc": "普通用户"},"typeEnumDesc": "普通用户","username": "user_1"}
]

效果和第二步的一致。

这种方式的优缺点：

  • 优点
    • 不需要对业务bean进行定制化，减少不必要的代码冗余和耦合
    • 扩展性好，枚举类中可以自定义多个属性
    • 不用去定制toString方法
    • 使用注解配置枚举类，方便快捷
  • 缺点
    • 依赖FastJsonHttpMessageConverter，需要单独对HttpMessageConverter进行增强

第四种：使用jackson的@JsonFormat注解

这一步开始，我们先把第二种方案中添加的FastJsonHttpMessageConvertersConfiguration类注掉，这样能更清楚的对比效果。

我们修改GenderEnum类内容如下：

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum GenderEnum {MALE("男"),FAMALE("女");private String desc;GenderEnum(String desc) {this.desc = desc;}public String getDesc() {return desc;}
}

访问接口返回的数据结构如下：

[{"username": "user_0","site": "https://www.zhyd.me","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"gender": {"desc": "男"},"type": "ADMIN","status": "INUSE","typeEnumDesc": "管理员"},{"username": "user_1","site": "https://www.zhyd.me","git": ["https://gitee.com/yadong.zhang","https://github.com/zhangyd-c"],"gender": {"desc": "女"},"type": "USER","status": "DISABLED","typeEnumDesc": "普通用户"}
]

已经成功序列化了枚举，因为我们枚举类中只有一个getDesc方法，所以序列化出来的枚举内容，也只有这一个参数。当实际生产环境中的枚举类存在多个属性时，只需要分别加上getXxx方法即可。

这种方式的优缺点：

  • 优点
    • 不需要对业务bean进行定制化，减少不必要的代码冗余和耦合
    • 扩展性好，枚举类中可以自定义多个属性
    • 不用去定制toString方法
    • 使用注解配置枚举类，方便快捷
    • Jackson自带注解，不依赖自定义的HttpMessageConverter，减少代码量
  • 缺点
    • 暂无

测试中碰到的问题

作者在写测试用例的时候，因不小心，碰到过几个问题，在这儿记录一下，防止后面有朋友继续碰到。

  1. JSONType是fastjson的注解，JsonFormat是jackson的注解，在使用自定义的FastJsonHttpMessageConverter组件时，JsonFormat是不可用的，同理在禁用掉FastJsonHttpMessageConverter组件后，JSONType不可用
  2. 其他问题，多见于参考资料的链接

项目源码

https://github.com/zhangyd-c/springboot-learning/tree/master/springboot-enums

参考资料

  • https://www.jianshu.com/p/68a75c093023
  • https://blog.csdn.net/gottst0113/article/details/80978966
  • https://blog.csdn.net/u010246789/article/details/52539576
  • https://blog.csdn.net/mickjoust/article/details/51671060
  • https://blog.csdn.net/qq_41599820/article/details/86607029
  • https://blog.csdn.net/zhangfengaiCQ/article/details/82657926
  • https://github.com/alibaba/fastjson/issues/1452

相关文章

  • springboot系列（一）整合Freemark模板(详尽版)
  • springboot系列（二）整合Mybatis+Mapper+Pagehelper(修订-详尽版)
  • springboot系列（三）一文带你搞懂Scheduler定时器(详尽版)
  • springboot系列（四）实现Freemarker自定义标签

推荐文章：

  • 给大家分享一个不可错过的、超棒的学习资源！错过后悔【非广告】
  • 【安利】这应该是史上最全的整合第三方登录的开源库
  • blog-hunter，一款简单好用并且支持多个平台的博客爬取工具

其他开源作品

  • blog-hunter，一款简单好用并且支持多个平台的博客爬取工具
  • OneBlog，一个简洁美观、功能强大并且自适应的Java博客
  • JustAuth，史上最全的整合第三方登录的工具,目前已支持Github、Gitee、微博、钉钉、百度、Coding、腾讯云开发者平台、OSChina、支付宝、QQ、微信、淘宝、Google、Facebook、抖音、领英、小米、微软和今日头条等第三方平台的授权登录。Login, so easy!

关注我的公众号

如果本文帮助到了您，麻烦您关注一下本公号。更多原创技术文章、开源作品更新记录将会及时通知到您。
感谢生命中遇到你。

这篇关于Springboot系列之RestApi中获取枚举类属性的几种方式的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1020131。

相关文章

Python获取C++中返回的char*字段的两种思路

Python获取C++中返回的char*字段的两种思路

《Python获取C++中返回的char*字段的两种思路》有时候需要获取C++函数中返回来的不定长的char*字符串,本文小编为大家找到了两种解决问题的思路,感兴趣的小伙伴可以跟随小编一起学习一下... 有时候需要获取C++函数中返回来的不定长的char*字符串，目前我找到两种解决问题的思路，具体实现如下：
阅读更多...
java实现延迟/超时/定时问题

java实现延迟/超时/定时问题

《java实现延迟/超时/定时问题》：本文主要介绍java实现延迟/超时/定时问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java实现延迟/超时/定时java 每间隔5秒执行一次,一共执行5次然后结束scheduleAtFixedRate 和 schedu
阅读更多...
Java Optional避免空指针异常的实现

Java Optional避免空指针异常的实现

《JavaOptional避免空指针异常的实现》空指针异常一直是困扰开发者的常见问题之一,本文主要介绍了JavaOptional避免空指针异常的实现,帮助开发者编写更健壮、可读性更高的代码,减少因... 目录一、Optional 概述二、Optional 的创建三、Optional 的常用方法四、Optio
阅读更多...
Spring Boot项目中结合MyBatis实现MySQL的自动主从切换功能

Spring Boot项目中结合MyBatis实现MySQL的自动主从切换功能

《SpringBoot项目中结合MyBatis实现MySQL的自动主从切换功能》：本文主要介绍SpringBoot项目中结合MyBatis实现MySQL的自动主从切换功能,本文分步骤给大家介绍的... 目录原理解析1. mysql主从复制（Master-Slave Replication）2. 读写分离3.
阅读更多...
idea maven编译报错Java heap space的解决方法

idea maven编译报错Java heap space的解决方法

《ideamaven编译报错Javaheapspace的解决方法》这篇文章主要为大家详细介绍了ideamaven编译报错Javaheapspace的相关解决方法,文中的示例代码讲解详细,感兴趣的... 目录1.增加 Maven 编译的堆内存2. 增加 IntelliJ IDEA 的堆内存3. 优化 Mave
阅读更多...
Java String字符串的常用使用方法

Java String字符串的常用使用方法

《JavaString字符串的常用使用方法》String是JDK提供的一个类,是引用类型,并不是基本的数据类型,String用于字符串操作,在之前学习c语言的时候,对于一些字符串,会初始化字符数组表... 目录一、什么是String二、如何定义一个String1. 用双引号定义2. 通过构造函数定义三、St
阅读更多...
springboot filter实现请求响应全链路拦截

springboot filter实现请求响应全链路拦截

《springbootfilter实现请求响应全链路拦截》这篇文章主要为大家详细介绍了SpringBoot如何结合Filter同时拦截请求和响应,从而实现​​日志采集自动化,感兴趣的小伙伴可以跟随小... 目录一、为什么你需要这个过滤器？​​​二、核心实现：一个Filter搞定双向数据流​​​​三、完整代码
阅读更多...
SpringBoot利用@Validated注解优雅实现参数校验

SpringBoot利用@Validated注解优雅实现参数校验

《SpringBoot利用@Validated注解优雅实现参数校验》在开发Web应用时,用户输入的合法性校验是保障系统稳定性的基础,​SpringBoot的@Validated注解提供了一种更优雅的解... 目录​一、为什么需要参数校验二、Validated 的核心用法​1. 基础校验2. php分组校验3
阅读更多...
golang获取当前时间、时间戳和时间字符串及它们之间的相互转换方法

golang获取当前时间、时间戳和时间字符串及它们之间的相互转换方法

《golang获取当前时间、时间戳和时间字符串及它们之间的相互转换方法》：本文主要介绍golang获取当前时间、时间戳和时间字符串及它们之间的相互转换,本文通过实例代码给大家介绍的非常详细,感兴趣... 目录1、获取当前时间2、获取当前时间戳3、获取当前时间的字符串格式4、它们之间的相互转化上篇文章给大家介
阅读更多...
Java Predicate接口定义详解

Java Predicate接口定义详解

《JavaPredicate接口定义详解》Predicate是Java中的一个函数式接口,它代表一个判断逻辑,接收一个输入参数,返回一个布尔值,：本文主要介绍JavaPredicate接口的定义... 目录Java Predicate接口Java lamda表达式 Predicate<T>、BiFuncti
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2