SpringBoot 接口对数据枚举类型的入参以及出参转换处理

2023-12-29 06:36
文章标签 java 类型 数据 接口 springboot spring 处理 转换 枚举 出参

本文主要是介绍SpringBoot 接口对数据枚举类型的入参以及出参转换处理，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

  • 1、在项目中使用枚举类型
  • 2、不做任何处理的演示效果
    • 2.1、接口出参
    • 2.2、接口入参
  • 3、用枚举的code作为参数和返回值
    • 3.1 代码案例
      • 3.1.1、定义枚举基础接口`BaseEnum`，每个枚举都实现该接口
      • 3.1.2、性别Sex枚举并实现接口`BaseEnum`
      • 3.1.3、定义BaseEnum枚举接口序列化
      • 3.1.4、自定义Enum枚举接口反序列化
      • 3.1.5、配置自定义的BaseEnum类的序列化和Enum类的反序列
      • 3.1.6、配置类型转换工厂IntegerCodeToEnumConverterFactory和StringCodeToEnumConverterFactory
      • 3.1.7、将转换工厂注册到Spring MVC中
    • 3.2 演示效果
  • 4、项目代码地址

1、在项目中使用枚举类型

一般我们在项目中，设置表的类型字段，都是用int存储，用0、1、2…代表不同类型的含义。
以性别字段为例：
数据库表字段设计为integer：

CREATE TABLE t_user_info
(...sex INT NOT NULL COMMENT '性别，0-女，1-男'...
);

实体成员变量设计为枚举：

public class UserInfoEntity extends BaseField {.../** 性别,0-女，1-男 */private Sex sex;...
}@Getter
public enum Sex implements BaseEnum {woman(0, "女"), man(1, "男");@EnumValue //标记数据库存的值是sexprivate Integer code;private String desc;Sex(int code, String desc) {this.code = code;this.desc = desc;}public String getStrCode() {return code.toString();}
}

2、不做任何处理的演示效果

如果我们不做任何额外处理，当使用Sex枚举作为出入参时。只能返回man或woman或用man或woman作为参数。

2.1、接口出参

封装出参实体中sex成员变量类型为Sex枚举，则出参为：man或woman
在这里插入图片描述

2.2、接口入参

若是使用Sex枚举类型接收请求参数，不论是从接口get请求url中获取，还是使用构造实体接收post请求参数。都只能用man或woman作为参数，如果使用0或1作为参数，则无法正确被转换为Sex枚举。但是在开发过程中前端下拉选选项一般都与0,1,2…相对应。
在这里插入图片描述

在这里插入图片描述

3、用枚举的code作为参数和返回值

以上面的Sex枚举为例子，我希望在返回sex字段时，用0和1作为返回值，并且希望能用0和1映射男和女作为接口入参。该如何实现呢？

3.1 代码案例

3.1.1、定义枚举基础接口BaseEnum，每个枚举都实现该接口

/*** 枚举基础接口* 注意：不要构造枚举name和code相互交叉使用的枚举，否则在进行转换时将获取意外的结果。例如：*public enum Sex2 implements BaseEnum {*     woman("man", "女"), man("woman", "男");**     private String code;*     private String desc;**     Sex2(String code, String desc) {*         this.code = code;*         this.desc = desc;*     }*     public String getStrCode() {*         return code;*     }* }** 若是这种则是可以的：woman("woman", "女"), man("man", "男");*/
public interface BaseEnum {/*** 根据枚举值或名称从枚举类型type中获取枚举对象*/public static <T extends BaseEnum> T getEnum(Class<T> type, Object codeOrName) {T[] enums = type.getEnumConstants();for (T em : enums) {if (em.getStrCode().equals(codeOrName.toString()) || em.name().equals(codeOrName.toString())) {return em;}}return null;}/*** 获取枚举值的字符串code** @return 编码*/String getStrCode();/*** 获取枚举名称** @return 名称*/String name();
}

3.1.2、性别Sex枚举并实现接口BaseEnum

import com.baomidou.mybatisplus.annotation.EnumValue;
import lombok.Getter;@Getter
public enum Sex implements BaseEnum {woman(0, "女"), man(1, "男");@EnumValue //标记数据库存的值是sexprivate Integer code;private String desc;Sex(int code, String desc) {this.code = code;this.desc = desc;}public String getStrCode() {return code.toString();}
}

3.1.3、定义BaseEnum枚举接口序列化

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.study.enums.BaseEnum;
import java.io.IOException;/*** BaseEnum 序列化*/
public class BaseEnumSerializer extends JsonSerializer<BaseEnum> {@Overridepublic void serialize(BaseEnum value, JsonGenerator gen, SerializerProvider serializers) throws IOException {gen.writeNumber(value.getStrCode());// 增加一个字段，格式为【枚举类名称+Text】，存储枚举的namegen.writeStringField(gen.getOutputContext().getCurrentName() + "Text", value.name());}
}

3.1.4、自定义Enum枚举接口反序列化

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.study.enums.BaseEnum;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.BeanUtils;
import java.io.IOException;/*** BaseEnum反序列化*/
@Slf4j
public class BaseEnumDeserializer extends JsonDeserializer<Enum> {@Overridepublic Enum deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {JsonNode node = p.getCodec().readTree(p);String currentName = p.currentName();Object currentValue = p.getCurrentValue();Class findPropertyType = BeanUtils.findPropertyType(currentName, currentValue.getClass());if (findPropertyType == null) {log.info("在" + currentValue.getClass() + "实体类中找不到" + currentName + "字段");return null;}String asText = node.asText();if (StringUtils.isBlank(asText)) {return null;}if (BaseEnum.class.isAssignableFrom(findPropertyType)) {BaseEnum valueOf = null;if (StringUtils.isNotBlank(asText)) {valueOf = BaseEnum.getEnum(findPropertyType, asText);}if (valueOf != null) {return (Enum) valueOf;}}return Enum.valueOf(findPropertyType, asText);}
}

3.1.5、配置自定义的BaseEnum类的序列化和Enum类的反序列

配置Jackson在序列化BaseEnum和反序列化Enum时，使用我们自己定义的BaseEnumSerializer、EnumDeserializer进行处理。

因为Spring boot使用的是Jackson序列化接口出参的，所以若我们自定定义的枚举若是都实现了BaseEnum接口，那么就会调用BaseEnumSerializer序列化枚举对象，达到预期的效果。

package com.study.config;import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import com.study.enums.BaseEnum;
import com.study.serializer.EnumDeserializer;
import com.study.serializer.BaseEnumSerializer;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import java.util.TimeZone;/*** 加载baseEnum 构建bean定义，初始化Spring容器。*/
@Configuration
public class JacksonConfig {// JacksonConfig EnumBeanConfig@Beanpublic Jackson2ObjectMapperBuilderCustomizer jacksonObjectMapperCustomization() {BaseEnumSerializer baseEnumSerializer = new BaseEnumSerializer();EnumDeserializer enumDeserializer = new EnumDeserializer();return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder.timeZone(TimeZone.getDefault())// 配置Jackson在序列化BaseEnum和反序列化Enum时，使用我们自己定义的BaseEnumSerializer、EnumDeserializer进行处理.serializerByType(BaseEnum.class, baseEnumSerializer).deserializerByType(Enum.class, enumDeserializer);}
}

3.1.6、配置类型转换工厂IntegerCodeToEnumConverterFactory和StringCodeToEnumConverterFactory

作用是当我们使用枚举类型接收接口入参时，会根据请求参数是Integer或者String调用各自的转换器转为BaseEnum枚举类型

import com.study.converters.IntegerToEnumConverter;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory;
import java.util.HashMap;
import java.util.Map;/*** 枚举 转化器工厂类* 将Integer类型的参数转换为BaseEnum类型枚举对象* 参考：org.springframework.core.convert.support.IntegerToEnumConverterFactory*/
public class IntegerCodeToEnumConverterFactory implements ConverterFactory<Integer, BaseEnum> {private static final Map<Class, Converter> CONVERTERS = new HashMap<>();/*** 获取一个从 Integer 转化为 T 的转换器，T 是一个泛型，有多个实现** @param targetType 转换后的类型* @return 返回一个转化器*/@Overridepublic <T extends BaseEnum> Converter<Integer, T> getConverter(Class<T> targetType) {Converter<Integer, T> converter = CONVERTERS.get(targetType);if (converter == null) {converter = new IntegerToEnumConverter<>(targetType);CONVERTERS.put(targetType, converter);}return converter;}
}

import cn.hutool.core.util.ObjectUtil;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import java.util.HashMap;
import java.util.Map;/*** Integer类型参数枚举 转化器** @param <T>*/
public class IntegerToEnumConverter<T extends BaseEnum> implements Converter<Integer, T> {private Map<String, T> enumMap = new HashMap<>();public IntegerToEnumConverter(Class<T> enumType) {T[] enums = enumType.getEnumConstants();for (T e : enums) {enumMap.put(e.getStrCode(), e);}}@Overridepublic T convert(Integer source) {T t = enumMap.get(source);if (ObjectUtil.isNull(t)) {throw new IllegalArgumentException("无法匹配对应的枚举类型");}return t;}
}

import com.study.converters.StringToEnumConverter;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory;
import java.util.HashMap;
import java.util.Map;/*** 枚举 转化器工厂类* 将String类型的参数转换为BaseEnum类型枚举对象* 参考：org.springframework.core.convert.support.StringToEnumConverterFactory*/
public class StringCodeToEnumConverterFactory implements ConverterFactory<String, BaseEnum> {private static final Map<Class, Converter> CONVERTERS = new HashMap<>();/*** 获取一个从 Integer 转化为 T 的转换器，T 是一个泛型，有多个实现** @param targetType 转换后的类型* @return 返回一个转化器*/@Overridepublic <T extends BaseEnum> Converter<String, T> getConverter(Class<T> targetType) {Converter<String, T> converter = CONVERTERS.get(targetType);if (converter == null) {converter = new StringToEnumConverter<>(targetType);CONVERTERS.put(targetType, converter);}return converter;}
}

import cn.hutool.core.util.ObjectUtil;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import java.util.HashMap;
import java.util.Map;/*** String类型参数枚举 转化器** @param <T>*/
public class StringToEnumConverter<T extends BaseEnum> implements Converter<String, T> {private final Map<String, T> enumMap = new HashMap<>();public StringToEnumConverter(Class<T> enumType) {T[] enums = enumType.getEnumConstants();for (T e : enums) {enumMap.put(e.getStrCode(), e);enumMap.put(e.name(), e);}}@Overridepublic T convert(String source) {T t = enumMap.get(source);if (ObjectUtil.isNull(t)) {throw new IllegalArgumentException("无法匹配对应的枚举类型");}return t;}
}

3.1.7、将转换工厂注册到Spring MVC中

import com.study.converters.factory.IntegerCodeToEnumConverterFactory;
import com.study.converters.factory.StringCodeToEnumConverterFactory;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;@Configuration
public class WebConfigurer implements WebMvcConfigurer {/*** 枚举类的转换器工厂 addConverterFactory*/@Overridepublic void addFormatters(FormatterRegistry registry) {registry.addConverterFactory(new IntegerCodeToEnumConverterFactory());registry.addConverterFactory(new StringCodeToEnumConverterFactory());}
}

3.2 演示效果

使用0、1、man、woman都可以请求接口
在这里插入图片描述
接口返回值为0、1。还新增了字段sexText保存枚举的名称
在这里插入图片描述

4、项目代码地址

项目gitee链接: https://gitee.com/WillDistance/mybatis-plus-h2.git

这篇关于SpringBoot 接口对数据枚举类型的入参以及出参转换处理的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


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

相关文章

Spring Boot 实现 IP 限流的原理、实践与利弊解析

Spring Boot 实现 IP 限流的原理、实践与利弊解析

《SpringBoot实现IP限流的原理、实践与利弊解析》在SpringBoot中实现IP限流是一种简单而有效的方式来保障系统的稳定性和可用性,本文给大家介绍SpringBoot实现IP限... 目录一、引言二、IP 限流原理2.1 令牌桶算法2.2 漏桶算法三、使用场景3.1 防止恶意攻击3.2 控制资源
阅读更多...
Mac系统下卸载JAVA和JDK的步骤

Mac系统下卸载JAVA和JDK的步骤

《Mac系统下卸载JAVA和JDK的步骤》JDK是Java语言的软件开发工具包,它提供了开发和运行Java应用程序所需的工具、库和资源,：本文主要介绍Mac系统下卸载JAVA和JDK的相关资料,需... 目录1. 卸载系统自带的 Java 版本检查当前 Java 版本通过命令卸载系统 Java2. 卸载自定
阅读更多...
springboot下载接口限速功能实现

springboot下载接口限速功能实现

《springboot下载接口限速功能实现》通过Redis统计并发数动态调整每个用户带宽,核心逻辑为每秒读取并发送限定数据量,防止单用户占用过多资源,确保整体下载均衡且高效,本文给大家介绍spring... 目录 一、整体目标 二、涉及的主要类/方法✅ 三、核心流程图解（简化） 四、关键代码详解1️⃣ 设置
阅读更多...
Java Spring ApplicationEvent 代码示例解析

Java Spring ApplicationEvent 代码示例解析

《JavaSpringApplicationEvent代码示例解析》本文解析了Spring事件机制,涵盖核心概念（发布-订阅/观察者模式）、代码实现（事件定义、发布、监听）及高级应用（异步处理、... 目录一、Spring 事件机制核心概念1. 事件驱动架构模型2. 核心组件二、代码示例解析1. 事件定义
阅读更多...
SpringMVC高效获取JavaBean对象指南

SpringMVC高效获取JavaBean对象指南

《SpringMVC高效获取JavaBean对象指南》SpringMVC通过数据绑定自动将请求参数映射到JavaBean,支持表单、URL及JSON数据,需用@ModelAttribute、@Requ... 目录Spring MVC 获取 JavaBean 对象指南核心机制：数据绑定实现步骤1. 定义 Ja
阅读更多...
javax.net.ssl.SSLHandshakeException:异常原因及解决方案

javax.net.ssl.SSLHandshakeException:异常原因及解决方案

《javax.net.ssl.SSLHandshakeException:异常原因及解决方案》javax.net.ssl.SSLHandshakeException是一个SSL握手异常,通常在建立SS... 目录报错原因在程序中绕过服务器的安全验证注意点最后多说一句报错原因一般出现这种问题是因为目标服务器
阅读更多...
Java实现删除文件中的指定内容

Java实现删除文件中的指定内容

《Java实现删除文件中的指定内容》在日常开发中,经常需要对文本文件进行批量处理,其中,删除文件中指定内容是最常见的需求之一,下面我们就来看看如何使用java实现删除文件中的指定内容吧... 目录1. 项目背景详细介绍2. 项目需求详细介绍2.1 功能需求2.2 非功能需求3. 相关技术详细介绍3.1 Ja
阅读更多...
springboot项目中整合高德地图的实践

springboot项目中整合高德地图的实践

《springboot项目中整合高德地图的实践》：本文主要介绍springboot项目中整合高德地图的实践,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一：高德开放平台的使用二：创建数据库（我是用的是mysql）三：Springboot所需的依赖（根据你的需求再
阅读更多...
spring中的ImportSelector接口示例详解

spring中的ImportSelector接口示例详解

《spring中的ImportSelector接口示例详解》Spring的ImportSelector接口用于动态选择配置类,实现条件化和模块化配置,关键方法selectImports根据注解信息返回... 目录一、核心作用二、关键方法三、扩展功能四、使用示例五、工作原理六、应用场景七、自定义实现Impor
阅读更多...
SpringBoot3应用中集成和使用Spring Retry的实践记录

SpringBoot3应用中集成和使用Spring Retry的实践记录

《SpringBoot3应用中集成和使用SpringRetry的实践记录》SpringRetry为SpringBoot3提供重试机制,支持注解和编程式两种方式,可配置重试策略与监听器,适用于临时性故... 目录1. 简介2. 环境准备3. 使用方式3.1 注解方式 基础使用自定义重试策略失败恢复机制注意事项
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2