一篇文章帶了解如何用SpringBoot在RequestBody中優(yōu)雅的使用枚舉參數(shù)
確認需求
需求與前文類似，只不過這里需要是在 RequestBody 中使用。與前文不同的是，這種請求是通過 Http Body 的方式傳輸?shù)胶蠖?，通常?json 或 xml 格式，Spring 默認借助 Jackson 反序列化為對象。
同樣的，我們需要在枚舉中定義 int 類型的 id、String 類型的 code，id 取值不限于序號（即從 0 開始的 orinal 數(shù)據(jù)），code 不限于 name?？蛻舳苏埱筮^程中，可以傳 id，可以傳 code，也可以傳 name。服務(wù)端只需要在對象中定義一個枚舉參數(shù)，不需要額外的轉(zhuǎn)換，即可得到枚舉值。
好了，接下來我們定義一下枚舉對象。
定義枚舉和對象
先定義我們的枚舉類GenderIdCodeEnum，包含 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;
}
}
這個枚舉類的要求與前文一致，不清楚的可以再去看一下。
在定義一個包裝類GenderIdCodeRequestBody，用于接收 json 數(shù)據(jù)的請求體：
@Data
public class GenderIdCodeRequestBody {
private String name;
private GenderIdCodeEnum gender;
private long timestamp;
}
除了GenderIdCodeEnum參數(shù)外，其他都是示例，所以隨便定義一下。
實現(xiàn)轉(zhuǎn)換邏輯
前奏鋪墊好，接下來入正題了。Jackson 提供了兩種方案：
- 方案一：精準攻擊，指定需要轉(zhuǎn)換的字段，不影響其他類對象中的字段
- 方案二：全范圍攻擊，所有借助 Jackson 反序列化的枚舉字段，全部具備自動轉(zhuǎn)換功能
方案一：精準攻擊
這種方案中，我們首先需要實現(xiàn)JsonDeserialize抽象類：
public class IdCodeToEnumDeserializer extends JsonDeserializer<BaseEnum> {
@Override
public BaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
throws IOException {
final String param = jsonParser.getText();// 1
final JsonStreamContext parsingContext = jsonParser.getParsingContext();// 2
final String currentName = parsingContext.getCurrentName();// 3
final Object currentValue = parsingContext.getCurrentValue();// 4
try {
final Field declaredField = currentValue.getClass().getDeclaredField(currentName);// 5
final Class<?> targetType = declaredField.getType();// 6
final Method createMethod = targetType.getDeclaredMethod("create", Object.class);// 7
return (BaseEnum) createMethod.invoke(null, param);// 8
} catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException | NoSuchFieldException e) {
throw new CodeBaseException(ErrorResponseEnum.PARAMS_ENUM_NOT_MATCH, new Object[] {param}, "", e);
}
}
}
然后在指定枚舉字段上定義@JsonDeserialize注解，比如：
@JsonDeserialize(using = IdCodeToEnumDeserializer.class) private GenderIdCodeEnum gender;
具體說一下每行的作用：
- 獲取參數(shù)值。根據(jù)需要，此處可能是 id、code 或 name，也就是源值，需要將其轉(zhuǎn)換為枚舉；
- 獲取轉(zhuǎn)換上線文，這個是為 3、4 步做準備的；
- 獲取標記@JsonDeserialize注解的字段，此時currentName的值是gender；
- 獲取包裝對象，也就是GenderIdCodeRequestBody對象；
- 根據(jù)包裝對象的Class對象，以及字段名gender獲取Field對象，為第 5 步做準備；
- 獲取gender字段對應(yīng)的枚舉類型，也即是GenderIdCodeEnum。之所以這樣做，是要實現(xiàn)一個通用的反序列化類；
- 這里是寫死的一種實現(xiàn)，就是在枚舉類中，需要定義一個靜態(tài)方法，方法名是create，請求參數(shù)是Object；
- 通過反射調(diào)用create方法，將第一步獲取的請求參數(shù)傳入。
我們來看一下枚舉類中定義的create方法：
public static GenderIdCodeEnum create(Object code) {
final String stringCode = code.toString();
final Integer intCode = BaseEnum.adapter(stringCode);
for (GenderIdCodeEnum item : values()) {
if (Objects.equals(stringCode, item.name())) {
return item;
}
if (Objects.equals(item.getCode(), stringCode)) {
return item;
}
if (Objects.equals(item.getId(), intCode)) {
return item;
}
}
return null;
}
為了性能考慮，我們可以提前定義三組 map，分別以 id、code、name 為 key，以枚舉值為 value，這樣就可以通過 O(1) 的時間復(fù)雜度返回了?？梢詤⒖记拔牡腃onverter類的實現(xiàn)邏輯。
這樣，我們就可以實現(xiàn)精準轉(zhuǎn)換了。
方案二：全范圍攻擊
這種方案是全范圍攻擊了，只要是 Jackson 參與的反序列化，只要其中有目標枚舉參數(shù)，就會受到這種進入這種方案的邏輯中。這種方案是在枚舉類中定義一個靜態(tài)轉(zhuǎn)換方法，通過@JsonCreator注解注釋，Jackson 就會自動轉(zhuǎn)換了。
這個方法的定義與方案一中的create方法完全一致，所以只需要在create方法上加上注解即可：
@JsonCreator(mode = Mode.DELEGATING)
public static GenderIdCodeEnum create(Object code) {
final String stringCode = code.toString();
final Integer intCode = BaseEnum.adapter(stringCode);
for (GenderIdCodeEnum item : values()) {
if (Objects.equals(stringCode, item.name())) {
return item;
}
if (Objects.equals(item.getCode(), stringCode)) {
return item;
}
if (Objects.equals(item.getId(), intCode)) {
return item;
}
}
return null;
}
其中Mode類有四個值：DEFAULT、DELEGATING、PROPERTIES、DISABLED，這四種的差別會在原理篇中說明。還是那句話，對于應(yīng)用類技術(shù)，我們可以先知其然，再知其所以然，也一定要知其所以然。
測試
先定義一個 controller 方法：
@PostMapping("gender-id-code-request-body")
public GenderIdCodeRequestBody bodyGenderIdCode(@RequestBody GenderIdCodeRequestBody genderRequest) {
genderRequest.setTimestamp(System.currentTimeMillis());
return genderRequest;
}
然后定義測試用例，還是借助 JUnit5：
@ParameterizedTest
@ValueSource(strings = {"\"MALE\"", "\"male\"", "\"1\"", "1"})
void postGenderIdCode(String gender) throws Exception {
final String result = mockMvc.perform(
MockMvcRequestBuilders.post("/echo/gender-id-code-request-body")
.contentType(MediaType.APPLICATION_JSON_UTF8)
.accept(MediaType.APPLICATION_JSON_UTF8)
.content("{\"gender\": " + gender + ", \"name\": \"看山\"}")
)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print())
.andReturn()
.getResponse()
.getContentAsString();
ObjectMapper objectMapper = new ObjectMapper();
final GenderIdCodeRequestBody genderRequest = objectMapper.readValue(result, GenderIdCodeRequestBody.class);
Assertions.assertEquals(GenderIdCodeEnum.MALE, genderRequest.getGender());
Assertions.assertEquals("看山", genderRequest.getName());
Assertions.assertTrue(genderRequest.getTimestamp() > 0);
}
總結(jié)
本文主要說明了如何在 RequestBody 中優(yōu)雅的使用枚舉參數(shù)，借助了 Jackson 的反序列化擴展，可以定制類型轉(zhuǎn)換邏輯。
本篇文章就到這里了，希望能給你帶來幫助，也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容！
Java實現(xiàn)md5和base64加密解密的示例代碼
Java中FTPClient上傳中文目錄、中文文件名亂碼問題解決方法
SpringMVC 中HttpMessageConverter簡介和Http請求415 的問題
Java 數(shù)據(jù)結(jié)構(gòu)之時間復(fù)雜度與空間復(fù)雜度詳解
你知道怎么從Python角度學(xué)習(xí)Java基礎(chǔ)
使用JPA+querydsl如何實現(xiàn)多條件動態(tài)查詢
Java List接口與Iterator接口及foreach循環(huán)使用解析
