你也許寫過(guò)很多Controller，那你可曾和我一樣好奇最初字符串格式的HTTP請(qǐng)求參數(shù)如何轉(zhuǎn)化成類型各異的Controller方法參數(shù)？
引子：假設(shè)現(xiàn)在有一個(gè)Long型的請(qǐng)求參數(shù)，需要轉(zhuǎn)化為OffsetDateTime類型的方法參數(shù)，請(qǐng)問(wèn)如何實(shí)現(xiàn)？
1 常見的POST請(qǐng)求格式
首先，讓我們看一下3種常見的POST請(qǐng)求格式：
-
application/x-www-form-urlencoded: 默認(rèn)的表單提交格式，不支持文件 -
multipart/form-data: 用于上傳文件，同時(shí)也支持普通類型的參數(shù) -
application/json: 提交JSON格式的raw數(shù)據(jù)，適用于AJAX請(qǐng)求和REST風(fēng)格的接口
對(duì)于不同類型的請(qǐng)求格式，Spring有著不同的轉(zhuǎn)換過(guò)程（從請(qǐng)求參數(shù)到方法參數(shù)），請(qǐng)看下圖。
2 Spring MVC中的數(shù)據(jù)類型轉(zhuǎn)換過(guò)程
從上圖可以看到，Spring在解析請(qǐng)求參數(shù)時(shí)，會(huì)根據(jù)請(qǐng)求格式進(jìn)入到不同的轉(zhuǎn)換流程：
- 如果是非raw請(qǐng)求（即包含參數(shù)數(shù)組），則交由ModelAttributeMethodProcessor處理，ModelAttributeMethodProcessor再調(diào)用Spring Converter SPI對(duì)請(qǐng)求參數(shù)逐個(gè)進(jìn)行轉(zhuǎn)換。
- 如果是raw請(qǐng)求，則交由RequestResponseBodyMethodProcessor處理，對(duì)于JSON格式的請(qǐng)求體，會(huì)再調(diào)用MappingJackson2HttpMessageConverter，最終通過(guò)ObjectMapper完成轉(zhuǎn)換。
<i>*關(guān)于Spring Converter SPI的進(jìn)一步解讀，可參考這篇文章</i>
回到開頭的那個(gè)問(wèn)題，答案就很簡(jiǎn)單了。如果是非raw請(qǐng)求，則需要實(shí)現(xiàn)一個(gè)自定義的Long->OffsetDatetime的Converter；如果是raw請(qǐng)求，則確保ObjectMapper中包含一個(gè)Long->OffsetDatetime的反序列化器，注冊(cè)Jackon自帶的JavaTimeModule即可。
2.1 如何注冊(cè)自定義Converter？
以Spring Boot為例，
1. 實(shí)現(xiàn)org.springframework.core.convert.converter.Converter接口生成一個(gè)自定義Converter。
public class OffsetDateTimeConverter implements Converter<String, OffsetDateTime> {
@Override
public OffsetDateTime convert(String source) {
if (!NumberUtils.isNumber(source)) {
return null;
}
Long milli = NumberUtils.createLong(source);
return OffsetDateTime.ofInstant(Instant.ofEpochMilli(milli), systemDefault());
}
}
2. 選擇一個(gè)標(biāo)注@Configuration注解的配置類，繼承org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter，然后覆蓋addFormatters方法，注冊(cè)自定義Converter。
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addConverter(new OffsetDateTimeConverter());
}
}
2.2 如何注冊(cè)自定義Jackson Deserializer和Serializer？
以Spring Boot為例，
1. 繼承com.fasterxml.jackson.databind.JsonDeserializer和com.fasterxml.jackson.databind.JsonSerializer生成自定義Jackson Deserializer和Serializer。
2. 繼承com.fasterxml.jackson.databind.module.SimpleModule生成一個(gè)自定義Jackson Module，在其中添加自定義的Jackson Deserializer和Serializer。
3. 選擇一個(gè)標(biāo)注@Configuration注解的配置類，通過(guò)@Bean注解將自定義的Jackson Module注冊(cè)為Bean，Spring Boot會(huì)自動(dòng)發(fā)現(xiàn)和注冊(cè)這個(gè)Module到默認(rèn)的ObjectMapper中。
示例代碼參見下一小節(jié)。
3 更多示例
3.1 演示Controller
演示3種常見的GET, POST請(qǐng)求參數(shù)的數(shù)據(jù)類型轉(zhuǎn)換。
@org.springframework.web.bind.annotation.RestController
@Validated
public class RestController implements IController {
private static final List<DayOfWeek> WEEKENDS = Lists.newArrayList(DayOfWeek.SATURDAY, DayOfWeek.SUNDAY);
/**
* 轉(zhuǎn)換GET請(qǐng)求參數(shù)
*/
@RequestMapping(value = "/isWeekend", method = RequestMethod.GET)
public JsonResult<Boolean> isWeekend(@Valid VacationRequest request) {
return JsonResult.ok(WEEKENDS.contains(request.getStart().getDayOfWeek()));
}
/**
* 轉(zhuǎn)換POST請(qǐng)求體
*/
@RequestMapping(value = "/approve", method = RequestMethod.POST)
public VacationApproval vacate(@RequestBody @Valid VacationRequest request) {
return VacationApproval.approve(request);
}
/**
* 轉(zhuǎn)換POST請(qǐng)求參數(shù)
*/
@RequestMapping(value = "/deny", method = RequestMethod.POST)
public VacationApproval deny(@Valid VacationRequest request) {
return VacationApproval.deny(request);
}
}
3.2 自定義Enum Converter（用于非raw格式的請(qǐng)求）
基于特定屬性的枚舉數(shù)據(jù)類型轉(zhuǎn)換器，如果無(wú)法找到，再嘗試用枚舉名進(jìn)行轉(zhuǎn)換。
public static class CustomEnumConverter<T extends Enum<T>> implements Converter<String, T> {
private Class<T> enumCls;
private String prop;
/**
* @param enumCls 枚舉類型
* @param prop 屬性名
*/
public CustomEnumConverter(Class<T> enumCls, String prop) {
this.enumCls = enumCls;
this.prop = prop;
}
@Override
public T convert(String source) {
if (StringUtils.isEmpty(source)) {
return null;
}
return Enums.getEnum(enumCls, prop, source).orElseGet(() ->
Stream.of(enumCls.getEnumConstants())
.filter(e -> e.name().equals(source))
.findFirst().orElse(null)
);
}
}
3.3 自定義Module（用于raw格式的請(qǐng)求）
用于注冊(cè)自定義Enum Serializer和Enum Deserializer。
public class CustomEnumModule extends SimpleModule {
/**
* @param prop 屬性名
*/
public CustomEnumModule(@NotNull String prop){
Asserts.notBlank(prop);
addDeserializer(Enum.class, new CustomEnumDeserializer(prop));
addSerializer(Enum.class, new CustomEnumSerializer(prop));
}
}
3.3.1 自定義Enum Serializer
自定義枚舉序列化器，查找特定屬性并進(jìn)行序列化，如果無(wú)法找到，則序列化為枚舉名。
@Slf4j
public class CustomEnumSerializer extends JsonSerializer<Enum> {
private String prop;
/**
* @param prop 屬性名
*/
public CustomEnumSerializer(@NotNull String prop) {
Asserts.notBlank(prop);
this.prop = prop;
}
@Override
public void serialize(Enum value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
if (value == null) {
gen.writeNull();
return;
}
try {
PropertyDescriptor pd = getPropertyDescriptor(value, prop);
if (pd == null || pd.getReadMethod() == null) {
gen.writeString(value.name());
return;
}
Method m = pd.getReadMethod();
m.setAccessible(true);
gen.writeObject(m.invoke(value));
} catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
throw new CommonException(e);
}
}
}
3.3.2 自定義Enum Deserializer
自定義枚舉反序列化器，根據(jù)特定屬性進(jìn)行反序列化，如果無(wú)法找到，再嘗試用枚舉名進(jìn)行反序列化。
public class CustomEnumDeserializer extends JsonDeserializer<Enum> implements ContextualDeserializer {
@Setter
private Class<Enum> enumCls;
private String prop;
/**
* @param prop 屬性名
*/
public CustomEnumDeserializer(@NotNull String prop) {
Asserts.notBlank(prop);
this.prop = prop;
}
@Override
public Enum deserialize(JsonParser parser, DeserializationContext ctx) throws IOException {
String text = parser.getText();
return Enums.getEnum(enumCls, prop, text).orElseGet(() ->
Stream.of(enumCls.getEnumConstants())
.filter(e -> e.name().equals(text))
.findFirst().orElse(null)
);
}
@Override
public JsonDeserializer createContextual(DeserializationContext ctx, BeanProperty property) throws JsonMappingException {
Class rawCls = ctx.getContextualType().getRawClass();
Asserts.isTrue(rawCls.isEnum());
Class<Enum> enumCls = (Class<Enum>) rawCls;
CustomEnumDeserializer clone = new CustomEnumDeserializer(prop);
clone.setEnumCls(enumCls);
return clone;
}
}
完整代碼可以參見我在GitHub上的示例工程。
