拾贝

【Spring】详解Spring MVC中不同格式的POST请求参数的数据类型转换过程

    backend     原创·Spring

你也许写过很多Controller,那你可曾和我一样好奇最初字符串格式的HTTP请求参数如何转化成类型各异的Controller方法参数?

引子:假设现在有一个Long型的请求参数,需要转化为OffsetDateTime类型的方法参数,请问如何实现?

1 常见的POST请求格式

首先,让我们看一下3种常见的POST请求格式:

  • application/x-www-form-urlencoded: 默认的表单提交格式,不支持文件
  • multipart/form-data: 用于上传文件,同时也支持普通类型的参数
  • application/json: 提交JSON格式的raw数据,适用于AJAX请求和REST风格的接口

对于不同类型的请求格式,Spring有着不同的转换过程(从请求参数到方法参数),请看下图。

2 Spring MVC中的数据类型转换过程

从上图可以看到,Spring在解析请求参数时,会根据请求格式进入到不同的转换流程:

  • 如果是非raw请求(即包含参数数组),则交由ModelAttributeMethodProcessor处理,ModelAttributeMethodProcessor再调用Spring Converter SPI对请求参数逐个进行转换。
  • 如果是raw请求,则交由RequestResponseBodyMethodProcessor处理,对于JSON格式的请求体,会再调用MappingJackson2HttpMessageConverter,最终通过ObjectMapper完成转换。

*关于Spring Converter SPI的进一步解读,可参考这篇文章

回到开头的那个问题,答案就很简单了。如果是非raw请求,则需要实现一个自定义的Long->OffsetDatetime的Converter;如果是raw请求,则确保ObjectMapper中包含一个Long->OffsetDatetime的反序列化器,注册Jackon自带的JavaTimeModule即可。

2.1 如何注册自定义Converter?

以Spring Boot为例,

1. 实现org.springframework.core.convert.converter.Converter接口生成一个自定义Converter。

1
2
3
4
5
6
7
8
9
10
11
12
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. 选择一个标注@Configuration注解的配置类,继承org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter,然后覆盖addFormatters方法,注册自定义Converter。

1
2
3
4
5
6
7
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addConverter(new OffsetDateTimeConverter());
}
}

2.2 如何注册自定义Jackson Deserializer和Serializer?

以Spring Boot为例,

1. 继承com.fasterxml.jackson.databind.JsonDeserializercom.fasterxml.jackson.databind.JsonSerializer生成自定义Jackson Deserializer和Serializer。

2. 继承com.fasterxml.jackson.databind.module.SimpleModule生成一个自定义Jackson Module,在其中添加自定义的Jackson Deserializer和Serializer。

3. 选择一个标注@Configuration注解的配置类,通过@Bean注解将自定义的Jackson Module注册为Bean,Spring Boot会自动发现和注册这个Module到默认的ObjectMapper中。

示例代码参见下一小节。

3 更多示例

3.1 演示Controller

演示3种常见的GET, POST请求参数的数据类型转换。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@RestController
@Validated
public class VacationController implements IController {

private static final List<DayOfWeek> WEEKENDS = Lists.newArrayList(DayOfWeek.SATURDAY, DayOfWeek.SUNDAY);

/**
* 转换GET请求参数
*/
@RequestMapping(value = "/isWeekend", method = RequestMethod.GET)
public JsonResult<Boolean> isWeekend(@Valid VacationRequest request) {
return JsonResult.ok(WEEKENDS.contains(request.getStart().getDayOfWeek()));
}

/**
* 转换POST请求体
*/
@RequestMapping(value = "/approve", method = RequestMethod.POST)
public JsonResult<VacationApproval> vacate(@RequestBody @Valid VacationRequest request) {
return JsonResult.ok(VacationApproval.approve(request));
}

/**
* 转换POST请求参数
*/
@RequestMapping(value = "/deny", method = RequestMethod.POST)
public JsonResult<VacationApproval> deny(@Valid VacationRequest request) {
return JsonResult.ok(VacationApproval.deny(request));
}
}

3.2 自定义Enum Converter(用于非raw格式的请求)

基于特定属性的枚举数据类型转换器,如果无法找到,再尝试用枚举名进行转换。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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格式的请求)

用于注册自定义Enum Serializer和Enum Deserializer。

1
2
3
4
5
6
7
8
9
10
11
12
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

自定义枚举序列化器,查找特定属性并进行序列化,如果无法找到,则序列化为枚举名。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@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

自定义枚举反序列化器,根据特定属性进行反序列化,如果无法找到,再尝试用枚举名进行反序列化。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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上的示例工程

4 参考

页阅读量:  ・  站访问量:  ・  站访客数: