这个问题非常有趣,不是SpringMVC 的问题,是实际开发中混合使用了两种请求方式暴露出来的。
问题场景
功能模块中,提供两个 Http 服务。一个是列表查询(application/json 请求),一个是列表导出(表单请求)。运行环境发现个问题:MVC model 新添加的属性,类似的 Http 请求,一个有值,一个没有
代码如下:
/**
* application/json 请求。 这种情况 param.field2 有值 ✔
* @param param RequestResponseBodyMethodProcessr 处理 HttpServletRequest 参数
*/
@PostMapping(value = "query")
public ResponseResult<Page<SomeData>> queryByCondition(@RequestBody SomeParam param){
// 业务逻辑...
}
/**
* application/x-www-form-urlencoded 请求 这种情况 param.field2 没有有赋值 ❌
* @param param ServletModelAttributeMethodProcessor 处理 HttpServletRequest 参数
*/
@PostMapping(value = "export")
public void exportExcel(SomeParam param) {
// 业务逻辑...
}
public class SomeParam {
// 这个是原有的,有 get set 方法
private String field1;
// 这个是新增的,没有get set 方法 (这是一个巧合、意外)。 问题就出在这里。
private String field2;
}
❓ 根据代码分析,那应该是 SpringMVC 针对这两种参数处理的机制不同。
针对上述的参数处理,可以参考:
RequestResponseBodyMethodProcessor、 ServletModelAttributeMethodProcessor
Insight RequestResponseBodyMethodProcessor
处理 Http Body 的数据。解析注解 RequestBody 的参数。
针对 MimeType 为 application/json 的请求,按照json 格式进行反序列化。
默认参数处理器
MappingJackson2HttpMessageConverter
string 反序列化为对象,使用的是
com.fasterxml.jackson.databind.ObjectMapper。
上述工程中,对 ObjectMapper 开启 private 属性检测。新增的属性可以正常反序列化。
ObjectMapper mapper = new ObjectMapper();
// 这又是一个巧合、意外 咋还有这个用法
mapper.setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
Visibility 具体的用法示例参考: Jackson - Decide What Fields Get (De)Serialized | Baeldung
原理: 如果没有 setter 方法,jackson 会操作 field 来完成赋值。
/**
* This concrete sub-class implements property that is set directly assigning to a Field.
*/
public final static class FieldProperty extends SettableBeanProperty {
@Override
public final void set(Object instance, Object value) throws IOException {
try {
_field.set(instance, value);
} catch (Exception e) {
_throwAsIOE(e, value);
}
}
}
Insight ServletModelAttributeMethodProcessor
自定义 Class 参数解析
通过解析 request parameters, 用来构造和初始化对应的方法入参。
主要通过
ServletRequestDataBinder.bind(request) 来完成。
/**
* Apply given property values to the target object.
* By default, unknown fields will be ignored.
*
* @see org.springframework.validation.DataBinder#applyPropertyValues
*/
protected void applyPropertyValues(MutablePropertyValues mpvs) {
try {
// Bind request parameters onto target object.
// 默认使用 BeanWrapperImpl.setPropertyValue()
getPropertyAccessor().setPropertyValues(mpvs, isIgnoreUnknownFields(), isIgnoreInvalidFields());
}
catch (PropertyBatchUpdateException ex) {
// Use bind error processor to create FieldErrors.
}
}
public void setPropertyValues(PropertyValues pvs, boolean ignoreUnknown, boolean ignoreInvalid) throws BeansException {
// 通过遍历 request parameters 来尝试对 target 进行赋值
List<PropertyValue> propertyValues = (pvs instanceof MutablePropertyValues ? ((MutablePropertyValues) pvs).getPropertyValueList() : Arrays.asList(pvs.getPropertyValues()));
for (PropertyValue pv : propertyValues) {
try {
// etPropertyValue 使用 JDK 的 Introspector 来进行序列化操作。
// 没有setter 方法,自然没法赋值。
setPropertyValue(pv);
}
}
}
总结
- 一件事情出错,不是一处问题造成的。
- 工程开发要规范,用最常规、最稳定的办法来实现。遇到稀奇古怪的问题就是冷门用法带来的。
- 对于常用的框架和工具库熟悉其底层原理,遇到问题可以很快定位。
作者:京东物流 杨攀
来源:京东云开发者社区