Spring：如何使⽤枚举参数
⽬录
枚举参数
确认需求
定义枚举
Converter 和 ConverterFactory
加载配置
测试
总结
枚举参数
接⼝开发过程中不免有表⽰类型的参数，⽐如 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 获取源码。springboot原理和机制
我们定义⼀个性别枚举，枚举包含 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;
}
@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 = wHashMap();
private final Map<String, T> codeEnumMap = wHashMap();
public IdCodeToEnumConverter(Class<T> enumType) {
Arrays.EnumConstants())
.forEach(x -> {
idEnumMap.Id().toString(), x);
codeEnumMap.Code(), 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 = wHashMap();
@Override
public <T extends IdCodeBaseEnum> Converter<String, T> getConverter(Class<T> targetType) {
//noinspection unchecked
Converter<String, T> converter = (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(
<("/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 形式请求的枚举转换逻辑。
本篇⽂章就到这⾥了，希望能给你带来帮助，也希望您能够多多关注的更多内容！

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。