springboot枚举类型传递的步骤

 更新时间:2021年04月12日 11:59:27   作者:鲸冬香  
这篇文章主要介绍了springboot枚举类型传递的步骤,帮助大家更好的理解和学习使用springboot,感兴趣的朋友可以了解下

在本周写项目时,需要将枚举类型作为参数进行传递。

测试

首先先建立一个枚举类:

public enum ScoreType  {
    TOTAL_SCORE("总评成绩"),
    MIDDLE_SCORE("期中成绩"),
    FINAL_SCORE("期末成绩");
    String des; // 描述
    ScoreType(String des) {
        this.des = des;
    }
    public String getDes() {
        return des;
    } 
}

再建立一个枚举api接口:

@RestController
@RequestMapping("/Klass")
public class KlassController {
    @GetMapping("testEnum")
    public String testEnum(@RequestParam ScoreType scoreType) {
        return "枚举序号:" + scoreType.ordinal() + ",枚举名:" + scoreType.name();
    }
}

进行测试,使用枚举名发送数据:

使用枚举序号发送数据:

由此可见,在springboot默认请求参数映射中,枚举类型只能通过枚举名来进行参数映射,但有时候我们需要用序号来做映射。

Converter

顾明思议Converter就是转换的意思,我们可以通过定义的Converter来确定参数到枚举类型之间的转换:

public class BaseEnumConverter<T extends Enum> implements Converter<String, T> {
    private Map<String, T> enumMap = new HashMap<>();
    public BaseEnumConverter(Class<T> enumType) {
        T[] enums = enumType.getEnumConstants();
        for (T e : enums) {
            enumMap.put(String.valueOf(e.ordinal()), e);
            enumMap.put(e.name(), e);
        }
    }
    @Override
    public T convert(String source) {
        T t1 = enumMap.get(source.toLowerCase());
        T t2 = enumMap.get(source.toUpperCase());
        if (t1 == null && t2 == null) {
            throw new IllegalArgumentException("无法匹配对应的枚举类型");
        }
        return t1 == null ? t2 : t1;
    }
}

分析代码,根据运行时具体枚举类的参数,获取所有枚举值,并将各个枚举值序列和枚举值名与枚举值之间做映射(保存在Map中),如上述枚举类型,将会生成以下Map:

0 => ScoreType.TOTAL_SCORE
TOTAL_SCORE => ScoreType.TOTAL_SCORE
1 => ScoreType.MIDDLE_SCORE
MIDDLE_SCORE => ScoreType.MIDDLE_SCORE
2 => ScoreType.FINAL_SCORE
FINAL_SCORE => ScoreType.FINAL_SCORE

通过此Converter,就可以实现前台传序号和枚举名,都能成功映射到枚举类型,将此Converter通过工厂模式提供到springboot中:

public class BaseEnumConverterFactory implements ConverterFactory<String, Enum> {
    private static final Map<Class, Converter> CONVERTERS = new HashMap<>();
    @Override
    public <T extends Enum> Converter<String, T> getConverter(Class<T> targetType) {
        // 每一个类型创建一个转换器
        Converter<String, T> converter = CONVERTERS.get(targetType);
        if (converter == null) {
            converter = new BaseEnumConverter<>(targetType);
            CONVERTERS.put(targetType, converter);
        }
        return converter;
    }
}

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverterFactory(new BaseEnumConverterFactory());
    }
}

进行测试,使用枚举名发送数据:

灵活化

为了保证灵活性,每个枚举类型可以自定义转换的方式,建立一个接口,对接口进行类型转换,建立一个BaseEnum接口:

public interface BaseEnum {
    String[] getKeys(); //返回的keys可转换为BaseEnum
}

枚举类实现此接口,并定义映射方式

public enum ScoreType implements BaseEnum {
    TOTAL_SCORE("总评成绩"),
    MIDDLE_SCORE("期中成绩"),
    FINAL_SCORE("期末成绩");
    String des; // 描述
    ScoreType(String des) {
        this.des = des;
    }
    public String getDes() {
        return des;
    }
    @Override
    public String[] getKeys() {
        String[] s = {String.valueOf(this.ordinal()), this.name()}; // 次序和名字都可转为枚举,如0和total_score => ScoreType.TOTAL_SCORE
    return s;
    }
}

转换器统一对BaseEnum进行转换:

public class BaseEnumConverter<T extends BaseEnum> implements Converter<String, T> {
    private Map<String, T> enumMap = new HashMap<>();
    public BaseEnumConverter(Class<T> enumType) {
        T[] enums = enumType.getEnumConstants();
        // 根据keys建立转换
        for (T e : enums) {
            for (String key : e.getKeys()) {
                enumMap.put(key, e);
            }
        }
    }
    @Override
    public T convert(String source) {
        T t1 = enumMap.get(source.toLowerCase());
        T t2 = enumMap.get(source.toUpperCase());
        if (t1 == null && t2 == null) {
            throw new IllegalArgumentException("无法匹配对应的枚举类型");
        }
        return t1 == null ? t2 : t1;
    }
}

对于每个枚举类型,可通过返回的keys来自定义转换的方式。

以上就是springboot枚举类型传递的步骤的详细内容,更多关于springboot枚举类型传递的资料请关注脚本之家其它相关文章!

相关文章

  • 一次线上websocket返回400问题排查的实战记录

    一次线上websocket返回400问题排查的实战记录

    最近项目中有端对端通信场景,实时性要求较高,考虑后选用了websocket 这一通信协议,下面这篇文章主要给大家介绍了一次线上websocket返回400问题排查的实战记录,需要的朋友可以参考下
    2022-04-04
  • SpringBoot实现嵌入式 Servlet容器

    SpringBoot实现嵌入式 Servlet容器

    传统的Spring MVC工程部署时需要将WAR文件放置在servlet容器的文档目录内,而Spring Boot工程使用嵌入式servlet容器省去了这一步骤,本文就来设置一下相关配置,感兴趣的可以了解一下
    2023-12-12
  • Java的JSTL标签库详解

    Java的JSTL标签库详解

    JSTL包含用于编写和开发JSP页面的一组标准标签,它可以为用户提供一个无脚本环境。在此环境中,用户可以使用标签编写代码,而无须使用Java脚本
    2023-05-05
  • 重新启动IDEA时maven项目SSM框架文件变色所有@注解失效

    重新启动IDEA时maven项目SSM框架文件变色所有@注解失效

    这篇文章主要介绍了重新启动IDEA时maven项目SSM框架文件变色所有@注解失效,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • 如何在maven本地仓库中添加oracle的jdbc驱动

    如何在maven本地仓库中添加oracle的jdbc驱动

    文章介绍了在Maven项目中添加Oracle数据库驱动ojdbc5时遇到的问题以及解决问题的两种方法,方法一为简单粗暴,但没有体现Maven仓库的作用,需要手动管理jar包,方法二为在Maven本地仓库中添加Oracle的JDBC驱动,过程较为繁琐,但配置一次后可以多次使用
    2024-11-11
  • Java并发编程之浅谈ReentrantLock

    Java并发编程之浅谈ReentrantLock

    今天带大家学习Java并发编程的相关知识,文中对Java ReentrantLock作了非常详细的图文示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05
  • java集合遍历的几种方式总结及详细比较

    java集合遍历的几种方式总结及详细比较

    下面小编就为大家带来一篇java集合遍历的几种方式总结及详细比较。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • elasticsearch开发中data-streams使用解析

    elasticsearch开发中data-streams使用解析

    这篇文章主要为大家介绍了elasticsearch开发中data-streams使用解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • java设计模式之工厂方法详解

    java设计模式之工厂方法详解

    这篇文章主要为大家详细介绍了java设计模式之工厂方法的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • 利用hadoop查询两两之间有共同好友及他俩的共同好友都是谁

    利用hadoop查询两两之间有共同好友及他俩的共同好友都是谁

    一想到要实现求共同好友的功能,很多人都会想到redis来实现。但是redis存储和数据和计算时需要耗费较多的内存资源。所以文本将介绍另一种方法,即利用Hadoop中的MapReduce来实现,感兴趣的可以了解一下
    2022-01-01

最新评论