springMvc源码之@RequestParam参数绑定解析(2)

问题分析:

  • SpringMVC的@RequestParam在Conreoller方法(对于post请求)对应的入参数上注解,会判断对应的参数是否被正确解析,如果不能被正确解析就会抛异常。
  • 请求头中的contentType类型为multipart/json或者为raw类型时,tomcat不会对请求参数进行解析,SpringMvc获取不到tomcat解析的参数,就会有Required String parameter 'phoneNum' is not present报错出

SpringMvc参数绑定源码解析:

参数绑定原理时序图:

springMvc请求参数解析流程.png

核心流程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请求处理源码时序图:

omcat请求处理时序图.png

核心流程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报错出现

参考文献

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,219评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,363评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,933评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,020评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,400评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,640评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,896评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,597评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,327评论 1 244
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,581评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,072评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,399评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,054评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,849评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,672评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,585评论 2 270

推荐阅读更多精彩内容