springboot枚举类型传递的步骤

时间:2022-09-23 11:14:42

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

测试

首先先建立一个枚举类:

  1. public enum ScoreType {
  2. TOTAL_SCORE("总评成绩"),
  3. MIDDLE_SCORE("期中成绩"),
  4. FINAL_SCORE("期末成绩");
  5. String des; // 描述
  6. ScoreType(String des) {
  7. this.des = des;
  8. }
  9. public String getDes() {
  10. return des;
  11. }
  12. }

再建立一个枚举api接口:

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

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

springboot枚举类型传递的步骤

使用枚举序号发送数据:

springboot枚举类型传递的步骤

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

Converter

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

  1. public class BaseEnumConverter<T extends Enum> implements Converter<String, T> {
  2. private Map<String, T> enumMap = new HashMap<>();
  3. public BaseEnumConverter(Class<T> enumType) {
  4. T[] enums = enumType.getEnumConstants();
  5. for (T e : enums) {
  6. enumMap.put(String.valueOf(e.ordinal()), e);
  7. enumMap.put(e.name(), e);
  8. }
  9. }
  10. @Override
  11. public T convert(String source) {
  12. T t1 = enumMap.get(source.toLowerCase());
  13. T t2 = enumMap.get(source.toUpperCase());
  14. if (t1 == null && t2 == null) {
  15. throw new IllegalArgumentException("无法匹配对应的枚举类型");
  16. }
  17. return t1 == null ? t2 : t1;
  18. }
  19. }

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

  1. 0 => ScoreType.TOTAL_SCORE
  2. TOTAL_SCORE => ScoreType.TOTAL_SCORE
  3. 1 => ScoreType.MIDDLE_SCORE
  4. MIDDLE_SCORE => ScoreType.MIDDLE_SCORE
  5. 2 => ScoreType.FINAL_SCORE
  6. FINAL_SCORE => ScoreType.FINAL_SCORE

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

  1. public class BaseEnumConverterFactory implements ConverterFactory<String, Enum> {
  2. private static final Map<Class, Converter> CONVERTERS = new HashMap<>();
  3. @Override
  4. public <T extends Enum> Converter<String, T> getConverter(Class<T> targetType) {
  5. // 每一个类型创建一个转换器
  6. Converter<String, T> converter = CONVERTERS.get(targetType);
  7. if (converter == null) {
  8. converter = new BaseEnumConverter<>(targetType);
  9. CONVERTERS.put(targetType, converter);
  10. }
  11. return converter;
  12. }
  13. }
  14.  
  15. @Configuration
  16. @EnableWebMvc
  17. public class WebConfig implements WebMvcConfigurer {
  18. @Override
  19. public void addFormatters(FormatterRegistry registry) {
  20. registry.addConverterFactory(new BaseEnumConverterFactory());
  21. }
  22. }

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

springboot枚举类型传递的步骤

灵活化

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

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

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

  1. public enum ScoreType implements BaseEnum {
  2. TOTAL_SCORE("总评成绩"),
  3. MIDDLE_SCORE("期中成绩"),
  4. FINAL_SCORE("期末成绩");
  5. String des; // 描述
  6. ScoreType(String des) {
  7. this.des = des;
  8. }
  9. public String getDes() {
  10. return des;
  11. }
  12. @Override
  13. public String[] getKeys() {
  14. String[] s = {String.valueOf(this.ordinal()), this.name()}; // 次序和名字都可转为枚举,如0和total_score => ScoreType.TOTAL_SCORE
  15. return s;
  16. }
  17. }

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

  1. public class BaseEnumConverter<T extends BaseEnum> implements Converter<String, T> {
  2. private Map<String, T> enumMap = new HashMap<>();
  3. public BaseEnumConverter(Class<T> enumType) {
  4. T[] enums = enumType.getEnumConstants();
  5. // 根据keys建立转换
  6. for (T e : enums) {
  7. for (String key : e.getKeys()) {
  8. enumMap.put(key, e);
  9. }
  10. }
  11. }
  12. @Override
  13. public T convert(String source) {
  14. T t1 = enumMap.get(source.toLowerCase());
  15. T t2 = enumMap.get(source.toUpperCase());
  16. if (t1 == null && t2 == null) {
  17. throw new IllegalArgumentException("无法匹配对应的枚举类型");
  18. }
  19. return t1 == null ? t2 : t1;
  20. }
  21. }

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

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

原文链接:https://segmentfault.com/a/1190000039803020