共计 3016 个字符,预计需要花费 8 分钟才能阅读完成。
在本周写我的项目时,须要将枚举类型作为参数进行传递。
测试
首先先建设一个枚举类:
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
2021-04-10