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 //标记数据库存的值是sex
    private 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 //标记数据库存的值是sex
    private 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> {
    @Override
    public void serialize(BaseEnum value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeNumber(value.getStrCode());
        // 增加一个字段，格式为【枚举类名称+Text】，存储枚举的name
        gen.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> {
    @Override
    public 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
    @Bean
    public 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 返回一个转化器
     */
    @Override
    public <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);
        }
    }

    @Override
    public 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 返回一个转化器
     */
    @Override
    public <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);
        }
    }

    @Override
    public 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
     */
    @Override
    public 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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/291484.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

P1029 [NOIP2001 普及组] 最大公约数和最小公倍数问题

P1029 [NOIP2001 普及组] 最大公约数和最小公倍数问题

网址如下&#xff1a;P1029 [NOIP2001 普及组] 最大公约数和最小公倍数问题 - 洛谷 | 计算机科学教育新生态 (luogu.com.cn) 水了道题 学了求最小公倍数和最大公因数的新方法 我对辗转相除法这个东西有所耳闻&#xff0c;但是从来没有用过 所以我只会枚举法求这两个东西 而…
阅读更多...
切换node.js不同版本

切换node.js不同版本

切换node.js不同版本 因新项目用到vite4创建项目&#xff0c;输入命令后报错&#xff0c;经查询得知是node版本过低导致&#xff0c;所以需要升级node版本&#xff0c;但是又有老的项目需要维护&#xff0c;因此需要多个版本的node使用需求。 流程&#xff1a; 卸载原有的node…
阅读更多...
人机交互主板定制_基于MT8735安卓核心板的自助查询机方案

人机交互主板定制_基于MT8735安卓核心板的自助查询机方案

人机交互主板是一种商显智能终端主板&#xff0c;广泛应用于广告机、工控一体机、教学一体机、智能自助终端、考勤机、智能零售终端、O2O智能设备、取号机、计算机视觉、医疗健康设备、机器人设备等领域。 人机交互主板采用联发科MTK8735芯片平台&#xff0c;四核Cortex-A53架构…
阅读更多...
使用fabric.js实现对图片涂鸦、文字编辑、平移缩放与保存功能

使用fabric.js实现对图片涂鸦、文字编辑、平移缩放与保存功能

文章目录 背景1.初始化画布1.创建画布2.设置画布大小 2.渲染图片3.功能&#xff1a;开启涂鸦4.功能&#xff1a;添加文字5.旋转图片6.画布平移7.画布缩放8.保存图片9.上传图片10.销毁实例11.总结 背景 项目中有个需求&#xff0c;需要对图片附件进行简单的编辑操作&#xff0c…
阅读更多...
C语言注意点（4）

C语言注意点（4）

1、void *a是什么意思 答&#xff1a;泛型指针&#xff0c;但不规定其类型(就是地址确定&#xff0c;但数据长度不确定)在动态分配内存时&#xff0c;malloc的返回值就是该类型&#xff0c;方便用户进行强制转换。 2、VS怎么一键规范格式 for(i0;i<10;i)enter后&#xff0c;…
阅读更多...
在C++11中利用for()循环遍历迭代器的同时，也可对容器内的数据进行更改

在C++11中利用for()循环遍历迭代器的同时，也可对容器内的数据进行更改

一、for (auto &&it : _groups){}含义&#xff1a; for (auto &&it : _groups) 是一个范围-based for 循环&#xff08;也称为 foreach 循环&#xff09;&#xff0c;用于遍历容器 _groups 中的元素。这种循环语法在 C11 及更高版本中引入&#xff0c;允许以一…
阅读更多...
自定义列表里面实现多选功能

自定义列表里面实现多选功能

需求 我们在开发过程中有时候会遇到列表里面会有多选&#xff0c;然后列表样式也要进行自定义。这里我们如果直接使用ElementUI组件el-table表格的时候这里实现起来可能比较复杂不方便&#xff0c;我们这里手写自定义一下列表里面多选的功能。 实现效果如下图所示&#xff1a…
阅读更多...
私域和微商有什么区别？

私域和微商有什么区别？

私域和微商到底有什么区别呢&#xff1f;其实这两个东西有着本质性区别。 私域&#xff1a; 通过原有商业或者新媒体方式获取粉丝或顾客&#xff0c;然后用微信等社交工具&#xff0c;多方位展现&#xff0c;人格专业。 最终目标是让粉丝或顾客成为品牌或IP的朋友&#xff0…
阅读更多...
【嵌入式】About USB Powering

【嵌入式】About USB Powering

https://www.embedded.com/usb-type-c-and-power-delivery-101-power-delivery-protocol/https://www.embedded.com/usb-type-c-and-power-delivery-101-power-delivery-protocol/ Type-C接口有多强&#xff1f;PD协议又是什么&#xff1f;-电子发烧友网由于Type-C接口自身的强…
阅读更多...
STM32入门教程-2023版【3-2】详细讲解实现LED流水灯

STM32入门教程-2023版【3-2】详细讲解实现LED流水灯

关注 点赞 不错过精彩内容 大家好&#xff0c;我是硬核王同学&#xff0c;最近在做免费的嵌入式知识分享&#xff0c;帮助对嵌入式感兴趣的同学学习嵌入式、做项目、找工作! 三、LED流水灯 依据电路图连接电路 复制LED闪烁的工程&#xff0c;改个名字叫3-2 LED流水灯 修改…
阅读更多...
Android 内容生成pdf文件

Android 内容生成pdf文件

1.引入itext7 implementation com.itextpdf:itext7-core:7.1.13上面比较大&#xff0c;可以直接下载需要集成的jar包 implementation files(libs\\layout-7.1.13.jar) implementation files(libs\\kernel-7.1.13.jar) implementation files(libs\\io-7.1.13.jar) implementatio…
阅读更多...
亚马逊站内广告位置在哪设置？怎么设置广告位置？-站斧浏览器

亚马逊站内广告位置在哪设置？怎么设置广告位置？-站斧浏览器

亚马逊站内广告位置在哪设置&#xff1f; 亚马逊提供了多种广告类型&#xff0c;包括&#xff1a; Sponsored Products&#xff08;赞助产品&#xff09;&#xff1a;在搜索结果和商品详情页中展示。 Sponsored Brands&#xff08;赞助品牌&#xff09;&#xff1a;在搜索结…
阅读更多...
C语言快速入门——前景引入

C语言快速入门——前景引入

计算机语言 计算机语言发展计算机的世界操作系统概述计算机编程语言C语言开发环境部署 各位小伙伴想要博客相关资料的话关注公众号&#xff1a;chuanyeTry即可领取相关资料&#xff01; 文章来自&#xff1a;https://www.itbaima.cn/document 计算机语言发展 在学习C语言之前&…
阅读更多...
进程的介绍及相关命令

进程的介绍及相关命令

首先&#xff0c;先了解一下计算机五大性能的命令 cpu top w 内存 top free 硬盘剩余 df 硬盘读写性能 iostat 网络带宽 iftop 一&#xff0c;进程与程序 1&#xff0c;什么是程序 &#xff1a; 硬盘上躺着&#xff0c;执行特点任务的一串代码 2&am…
阅读更多...
VS2010 ，创建DLL，并调用DLL

VS2010 ，创建DLL，并调用DLL

一、创建DLL 1. 新建Win32空项目 项目命名为genxls。 2. 创建DLL空项目 3. 头文件&#xff0c;新建项&#xff0c; genxls.h 头文件内容为 // genxls.h #ifndef _DLL_API #define _DLL_API _declspec(dllexport) #else #define _DLL_API _declspec(dllimport) #endif _DLL_A…
阅读更多...
我不想学JAVA---------JAVA和C的区别

我不想学JAVA---------JAVA和C的区别

前言 我一个研究方向是SLAM的为什么要来学JAVA。 从九月份开学到现在&#xff0c;已经学了Linux&#xff0c;数据结构&#xff0c;SLAM&#xff0c;C的基础操作&#xff0c;期间还参与编写了一本VHDL的教材。还有上课、考试什么的其他杂七杂八的事情就不说了。 读研好苦逼&…
阅读更多...
IPv6邻居发现协议(NDP)---路由发现

IPv6邻居发现协议(NDP)---路由发现

IPv6路由发现（前缀公告） 邻居发现 邻居发现协议NDP（Neighbor Discovery Protocol）是IPv6协议体系中一个重要的基础协议。邻居发现协议替代了IPv4的ARP（Address Resolution Protocol）和ICMP路由器发现（Router Discovery），它定义了使用ICMPv6报文实现地址解析，跟踪邻…
阅读更多...
利用蚁剑钓鱼上线CS

利用蚁剑钓鱼上线CS

前言 ​ 中国蚁剑使用Electron构建客户端软件&#xff0c;Electron实现上用的是Node.js&#xff0c;并且Node.js能执行系统命令&#xff0c;故可以利用蚁剑的webshell页面嵌入js来直接执行命令&#xff0c;进而钓鱼来上线CS。&#xff08;类似Goby&#xff0c;Goby也是使用Ele…
阅读更多...
小迪安全第一天

小迪安全第一天

一、常用的专业术语 参考&#xff1a; https://www.cnblogs.com/sunny11/p/13583083.html POC&#xff08;proof of concept&#xff09;验证漏洞的代码EXP(exploit) 利用对一段漏洞代码的利用Playload:有效载荷&#xff0c;当利用exploit成功后如何通过一个管道把这个权限给…
阅读更多...
制药企业符合CSV验证需要注意什么？

制药企业符合CSV验证需要注意什么？

在制药行业中&#xff0c;计算机化系统验证&#xff08;CSV&#xff09;是确保生产过程的合规性和数据完整性的关键要素。通过CSV验证&#xff0c;制药企业可以保证其计算机化系统的可靠性和合规性&#xff0c;从而确保产品质量和患者安全。然而&#xff0c;符合CSV验证并不是一…
阅读更多...
最新文章

Copyright @ 2022~2023