问题分析:
- SpringMVC的@RequestParam在Conreoller方法(对于post请求)对应的入参数上注解,会判断对应的参数是否被正确解析,如果不能被正确解析就会抛异常。
- 请求头中的contentType类型为multipart/json或者为raw类型时,tomcat不会对请求参数进行解析,SpringMvc获取不到tomcat解析的参数,就会有Required String parameter 'phoneNum' is not present报错出
SpringMvc参数绑定源码解析:
参数绑定原理时序图:
核心流程1分析:
- 分析核心流程1步骤8 对应的getMethodArgumentValues()方法,可以看到在对绑定参数进行解析时,如果有异常将会被捕获
private Object[] getMethodArgumentValues(NativeWebRequest request, ModelAndViewContainer mavContainer,
Object... providedArgs) throws Exception {
/**
* 省略
*/
for (int i = 0; i < parameters.length; i++) {
/**
* 省略
*/
if (this.argumentResolvers.supportsParameter(parameter)) {
try {
//对参数进行解析 如果其中有异常将抛出异常
args[i] = this.argumentResolvers.resolveArgument(
parameter, mavContainer, request, this.dataBinderFactory);
continue;
}
catch (Exception ex) {
//异常捕获
。。。
throw ex;
}
}
。。。
}
return args;
}
- 进行分析分析核心流程1步骤8.2对应resolveArgument()方法, 其中NamedValueInfo 是内部类。这部分代码就是Required String parameter ** is not present的语句---MissingServletRequestParameterException异常抛出的地方
public final Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
//NamedValueInfo 为内部类
NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);
//解析对应参数 如果为空则有可能抛出Required String parameter ** is not present的语句---MissingServletRequestParameterException异常
Object arg = resolveName(namedValueInfo.name, parameter, webRequest);
if (arg == null) {
if (namedValueInfo.defaultValue != null) {
arg = resolveDefaultValue(namedValueInfo.defaultValue);
}
// 如果有对应的注解并且参数类型不是java.util.Optional的话 会抛MissingServletRequestParameterException异常 也就是本文要分析的报错语句
else if (namedValueInfo.required && !parameter.getParameterType().getName().equals("java.util.Optional")) {
handleMissingValue(namedValueInfo.name, parameter);
}
arg = handleNullValue(namedValueInfo.name, arg, paramType);
}
/**
* 省略
*/
return arg;
}
//NamedValueInfo内部类
protected static class NamedValueInfo {
//参数名称
private final String name;
//是否有对应注解
private final boolean required;
//默认值
private final String defaultValue;
....
}
- 继续分析异常抛出的核心方法resolveName(),当这个方法返回null并且Controller方法对应的形参有对应的@RequestParam注解时就会抛出文中的异常
protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest webRequest) throws Exception {
/**
* 省略
*/
else {
/**
* 省略
*/
if (arg == null) {
String[] paramValues = webRequest.getParameterValues(name);
if (paramValues != null) {
arg = paramValues.length == 1 ? paramValues[0] : paramValues;
}
}
}
return arg;
}
- 接下来会调用ServletWebRequest的getParameterValues()方法,当这个方法返回null并且Controller方法对应的形参有对应的@RequestParam注解时就会抛出文中的异常
public String[] getParameterValues(String paramName) {
// 从request中的getParameterValues()方法获取结果
return getRequest().getParameterValues(paramName);
}
Tomcat的Request请求源码解析:
- ServletWebRequest的getParameterValues()方法会调用tomcat的请求处理器代码,所以接下来进入核心流程2分析
tomcat请求处理源码时序图:
核心流程2分析:
- 步骤1调用RequestFacade的getParameterValues()获取请求参数,RequestFacade为外观模式,主要起到封装交互,简化调用的作用。
public String[] getParameterValues(String name) {
//省略
else {
//调用Request的getParameterValues
ret = request.getParameterValues(name);
}
return ret;
}
- 步骤2调用Request的getParameterValues()方法
public String[] getParameterValues(String name) {
if (!parametersParsed) {
//在步骤1之前就调用,为了方便描述最后分析
parseParameters();
}
//步骤3
return coyoteRequest.getParameters().getParameterValues(name);
}
- 步骤3调用Parameters的getParameterValues()方法
public String[] getParameterValues(String name) {
.....
//paramHashValues是在Request.parseParameters()方法设置
ArrayList<String> values = paramHashValues.get(name);
if (values == null) {
return null;
}
return values.toArray(new String[values.size()]);
}
- 当请求的方法为post方法时HiddenHttpMethodFilter会调用Request.parseParameters方法
- 解析Request.parseParameters()方法,这个方法解决了核心流程2是否返回null,以至于核心流程1报本文分析的错误Required String parameter '***' is not present
protected void parseParameters() {
。。。。
try {
。。。。。
//这一步获取到contentType
String contentType = getContentType();
if (contentType == null) {
contentType = "";
}
int semicolon = contentType.indexOf(';');
if (semicolon >= 0) {
contentType = contentType.substring(0, semicolon).trim();
} else {
contentType = contentType.trim();
}
//不同contentType类型不同结果 multipart/form-data类型的能够读取请求参数
if ("multipart/form-data".equals(contentType)) {
parseParts(false);
success = true;
return;
}
//不同contentType类型不同结果 不是application/x-www-form-urlencoded类型的读取不到请求参数
if (!("application/x-www-form-urlencoded".equals(contentType))) {
success = true;
return;
}
。。。。。
}
success = true;
} finally {
。。。。。
}
}
- 其中Request.parseParts方法会设置paramHashValues,从而导致springmvc能够读取请求参数。
结论:
从核心流程2的最后分析中能得出, 不同的请求头的contentType类型会导致SpringMvc能不能读取到参数
multipart/form-data类型的SpringMvc能正常读取到参数,multipart/json类型的SpringMvc不能正常读取到参数
contentType类型为multipart/json时,经核心流程2分析会返回null, 再经核心流程1分析,结果controller方法加上@RequestParam注解,就会有Required String parameter '***' is not present报错出现
参考文献
- [springmvc流程图](https://www.cnblogs.com/xiaoxi/p/6164383.html)