广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Spring:如何使用枚举参数
  • 688
分享到

Spring:如何使用枚举参数

2024-04-02 19:04:59 688人浏览 独家记忆

Python 官方文档:入门教程 => 点击学习

摘要

目录 枚举参数确认需求定义枚举Converter 和 ConverterFactory加载配置测试总结 枚举参数 接口开发过程中不免有表示类型的参数,比如 0 表

 枚举参数

接口开发过程中不免有表示类型的参数,比如 0 表示未知,1 表示男,2 表示女。通常有两种做法,一种是用数字表示,另一种是使用枚举实现。

使用数字表示就是通过契约形式,约定每个数字表示的含义,接口接收到参数,就按照约定对类型进行判断,接口维护成本比较大。

spring 体系中,使用枚举表示,是借助 Spring 的 Converter 机制,可以将数字或字符串对应到枚举的序号或者 name,然后将前端的输入转换为枚举类型。

在场景不复杂的场景中,枚举可以轻松胜任。

于是,迅速实现逻辑,准备提测。这个时候需求变了,不允许选择未知性别,只能选男或女,就没有 0 值。这样,因为取值是从 1 开始,而枚举的序号是从 0 开始,就会产生冲突。

还有一些不太多的场景,就是前端不期望类型都是用数字,可能期望用一些有意义的字符串表示。但是按照前端规范,需要用小写或者驼峰命名。但是后端的规范中,枚举必须是大写,又是冲突。

需求合不合理暂且不论,我们要保存对技术的探索精神。

确认需求

首先确认需求。我们期望定义一个枚举类作为参数,接口访问的时候,可以是 int 类型的 id,id 取值不限于枚举的序号;也可以是 String 类型的 code,code 取值不限于枚举的 name。换句话说,这个枚举有个 id 和 code,随意定义,只要接口传过来匹配上,就能够自动转成枚举类型。

既然这样,我们就规范下 id 和 code 取值。为了扩展,定义三个接口:IdBaseEnum、CodeBaseEnum 以及 IdCodeBaseEnum。


public interface IdBaseEnum {
    Integer getId();
}

public interface CodeBaseEnum {
    String getCode();
}

public interface IdCodeBaseEnum extends IdBaseEnum, CodeBaseEnum {
}

接下来就该定义我们的主角了。

定义枚举

前面定义了三个接口,分别是单独 id、单独 code,和有 id 和 code 的。这样,我们就可以定义三种枚举,分别对应三个接口。三种方式类似,所以就不在文中重复列举了。感兴趣的可以关注公众号「看山的小屋」回复 spring 获取源码

我们定义一个性别枚举,枚举包含 id 和 code 两个属性。


public enum GenderIdCodeEnum implements IdCodeBaseEnum {
    MALE(1, "male"),
    FEMALE(2, "female");

    private final Integer id;
    private final String code;

    GenderIdCodeEnum(Integer id, String code) {
        this.id = id;
        this.code = code;
    }

    @Override
    public String getCode() {
        return code;
    }

    @Override
    public Integer getId() {
        return id;
    }
}

这里需要注意一点,id 和 code 不能重复。

1.id 与 id、code 与 code 不能重复,比如 MaiL 定义 id 是 1,FAMLE 就不能定义 id 是 1 了。

2.id 与 code 之间也不能重复,比如,MALE 定义 id 是 1001,FEMALE 定义 code 是 1001。

这是由于 Spring 在转换参数的时候,将输入参数全部视为 String 类型。虽然我们定义 id 和 code 类型不同,但是在匹配的时候,都是按照字符串匹配的。如果存在相同值,就会产生歧义。

Converter 和 ConverterFactory

根据规范,接下来定义一下 Converter 和 ConverterFactory。这些是 Spring 留给我们的扩展口,按照规范定义即可。

Converter 类:


public class IdCodeToEnumConverter<T extends IdCodeBaseEnum> implements Converter<String, T> {
    private final Map<String, T> idEnumMap = Maps.newHashMap();
    private final Map<String, T> codeEnumMap = Maps.newHashMap();

    public IdCodeToEnumConverter(Class<T> enumType) {
        Arrays.stream(enumType.getEnumConstants())
                .forEach(x -> {
                    idEnumMap.put(x.getId().toString(), x);
                    codeEnumMap.put(x.getCode(), x);
                });
    }

    @Override
    public T convert(String source) {
        return Optional.of(source)
                .map(codeEnumMap::get)
                .orElseGet(() -> Optional.of(source)
                        .map(idEnumMap::get)
                        .orElseThrow(() -> new CodeBaseException(ErrorResponseEnum.PARAMS_ENUM_NOT_MATCH)));
    }
}

ConverterFactory 类:


public class IdCodeToEnumConverterFactory implements ConverterFactory<String, IdCodeBaseEnum> {
    @SuppressWarnings("rawtypes")
    private static final Map<Class, Converter> CONVERTERS = Maps.newHashMap();

    @Override
    public <T extends IdCodeBaseEnum> Converter<String, T> getConverter(Class<T> targetType) {
        //noinspection unchecked
        Converter<String, T> converter = CONVERTERS.get(targetType);
        if (converter == null) {
            converter = new IdCodeToEnumConverter<>(targetType);
            CONVERTERS.put(targetType, converter);
        }
        return converter;
    }
}

这两个就是转换的核心了,我们只要将他们装配到 Spring 的类型转换器中,就能够实现枚举类型的自动转化了。

加载配置

将我们定义的 Converter 和 ConverterFactory 注册到 Spring 的类型转换器中。


@Configuration
public class WEBConfig implements WebmvcConfigurer {
    @Override
    public void addFORMatters(FormatterReGIStry registry) {
        registry.addConverterFactory(new IdCodeToEnumConverterFactory());
        registry.addConverterFactory(new CodeToEnumConverterFactory());
        registry.addConverterFactory(new IdToEnumConverterFactory());
    }
}

至此,核心定义全部结束。

测试

写一个 Controller 作为测试入口:


@RestController
@RequestMapping("echo")
public class EchoController {
    @GetMapping("gender-id-code")
    public String genderIdCode(@RequestParam("gender") GenderIdCodeEnum gender) {
        return gender.name();
    }
}

准备测试用例测试:


@SpringBootTest(classes = SpringEnumParamApplication.class)
@AutoConfigureMockMvc
class EchoControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @ParameterizedTest
    @ValueSource(strings = {"MALE", "male", "1"})
    void genderIdCode(String gender) throws Exception {
        final String result = mockMvc.perform(
                MockMvcRequestBuilders.get("/echo/gender-id-code")
                        .param("gender", gender)
        )
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print())
                .andReturn()
                .getResponse()
                .getContentAsString();

        Assertions.assertEquals("MALE", result);
    }
}

总结

实现枚举参数并不难,只要按照 Spring 的扩展规范实现即可。需要注意的是,注意枚举类中唯一的 id 和 code。

本文是应用,下篇说一下原理。以及 Http body 形式请求的枚举转换逻辑。

本篇文章就到这里了,希望能给你带来帮助,也希望您能够多多关注编程网的更多内容!

--结束END--

本文标题: Spring:如何使用枚举参数

本文链接: https://www.lsjlt.com/news/132424.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Spring:如何使用枚举参数
    目录 枚举参数确认需求定义枚举Converter 和 ConverterFactory加载配置测试总结 枚举参数 接口开发过程中不免有表示类型的参数,比如 0 表...
    99+
    2022-11-12
  • 使用spring注入枚举类型作为参数
    目录spring注入枚举类型作为参数Spring参数注入1、通过构造方法实现参数注入2、通过set方法注入3、P命名空间注入spring注入枚举类型作为参数 //定义枚举类型 p...
    99+
    2022-11-12
  • SpringBoot实战:Spring如何找到对应转换器优雅使用枚举参数
    目录找入口请求入口是DispatcherServlet查找转换器Spring 如何查找转换器类型转换跟随源码找到自定义转换器工厂类和转换器类的实现逻辑无论是GET请求,还是传参式的P...
    99+
    2022-11-12
  • SpringBoot之使用枚举参数案例详解
    接口开发过程中不免有表示类型的参数,比如 0 表示未知,1 表示男,2 表示女。通常有两种做法,一种是用数字表示,另一种是使用枚举实现。 使用数字表示就是通过契约形式,约定每个数字表...
    99+
    2022-11-12
  • C# 枚举如何使用
    这篇文章主要介绍“C# 枚举如何使用”,在日常操作中,相信很多人在C# 枚举如何使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”C# 枚举如何使用”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!为什么使用...
    99+
    2023-06-14
  • 如何使用VB.NET枚举
    这篇文章主要介绍了如何使用VB.NET枚举,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。在程序运行的过程中始终固定不变的量称为常量。由于在程序设计和开发时经常会反复地运用一些...
    99+
    2023-06-17
  • python如何使用枚举
    小编给大家分享一下python如何使用枚举,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!使用枚举我们常用 For 循环来遍历某个列表,同样我们也能枚举列表的索引与...
    99+
    2023-06-27
  • SpringBoot在RequestBody中使用枚举参数案例详解
    前文说到 优雅的使用枚举参数 和 实现原理,本文继续说一下如何在 RequestBody 中优雅使用枚举。 本文先上实战,说一下如何实现。在 优雅的使用枚举参数 代码的基础上,我们继...
    99+
    2022-11-12
  • python如何使用枚举器
    这篇文章主要为大家展示了“python如何使用枚举器”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“python如何使用枚举器”这篇文章吧。玩枚举使用枚举器,在循环中很容易找到索引。testlis...
    99+
    2023-06-27
  • 枚举如何在MyBatis中使用
    这篇文章给大家介绍枚举如何在MyBatis中使用,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。具体方法如下:public enum ComputerState { OPEN(10), //开启 CLOSE(11),...
    99+
    2023-05-31
    mybatis 枚举
  • 在Java中如何使用枚举
    这篇文章给大家分享的是有关在Java中如何使用枚举的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。枚举类型(Enumerated Types) 让我们先看下面这一段小程序: enum Day {SUNDAY, MO...
    99+
    2023-06-03
  • C++中enum枚举如何使用
    这篇文章将为大家详细讲解有关C++中enum枚举如何使用,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。C++ enum枚举格式:enum < 枚举类型名> {< 枚举表&g...
    99+
    2023-06-17
  • 如何使用python创建枚举
    这篇文章主要为大家展示了“如何使用python创建枚举”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“如何使用python创建枚举”这篇文章吧。创建枚举Enum是Python中用于创建枚举的类,枚...
    99+
    2023-06-27
  • C++中的枚举如何使用
    这篇文章主要介绍了C++中的枚举如何使用的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇C++中的枚举如何使用文章都会有所收获,下面我们一起来看看吧。一、枚举是什么枚举(enumeration)类型用于存放用户指...
    99+
    2023-07-05
  • C语言的枚举如何使用
    这篇文章主要介绍“C语言的枚举如何使用”,在日常操作中,相信很多人在C语言的枚举如何使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”C语言的枚举如何使用”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!概述...
    99+
    2023-06-30
  • java枚举如何定义与使用
    在Java中,枚举是一种特殊的数据类型,用于定义一组常量。枚举常量在声明时就被确定,并且不能被修改。下面是定义和使用Java枚举的步...
    99+
    2023-08-21
    java
  • 使用Spring MVC如何实现将对象注入枚举类型中
    今天就跟大家聊聊有关使用Spring MVC如何实现将对象注入枚举类型中,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。首先:这是一个枚举类: public enum ENews { ...
    99+
    2023-05-31
    spring mvc 对象 枚举
  • 一篇文章带了解如何用SpringBoot在RequestBody中优雅的使用枚举参数
    目录确认需求定义枚举和对象实现转换逻辑方案一:精准攻击方案二:全范围攻击测试总结确认需求 需求与前文类似,只不过这里需要是在 RequestBody 中使用。与前文不同的是,这种请求是通过 Http Body 的方式传输到后端,通常是 js...
    99+
    2016-04-04
    SpringBoot RequestBody枚举参数
  • 如何使用vbscript枚举域内计算机个数
    这篇文章主要介绍了如何使用vbscript枚举域内计算机个数,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。代码如下:On Error Resume&nbs...
    99+
    2023-06-08
  • SpringBoot实战之高效使用枚举参数(原理篇)案例详解
    找入口 对 Spring 有一定基础的同学一定知道,请求入口是DispatcherServlet,所有的请求最终都会落到doDispatch方法中的ha.handle(process...
    99+
    2022-11-12
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作