SpringBoot源码解析-controller层参数的封装

在进入DispatcherServlet的时候,spring容器会得到一个HttpServletRequest对象,但是我们在使用controller层方法时,经常会使用RequestBody,RequestHeader等注解将该对象封装成更便于操作的对象类型。那么在我们使用RequestBody等注解的时候,中间经历了怎样的转换逻辑。今天就来解析一下。

参数解析逻辑

首先找到代码封装的位置,进入InvocableHandlerMethod的invokeForRequest方法(调用链可以自行找一下,idea的debug功能很方便)。

public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,Object... providedArgs) throws Exception {                

//这行就是获取参数的逻辑Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);

if(logger.isTraceEnabled()) {logger.trace("Arguments: "+ Arrays.toString(args));}

//执行controller方法returndoInvoke(args);}protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,Object... providedArgs) throws Exception {MethodParameter[] parameters = getMethodParameters();

Object[] args = new Object[parameters.length];

...if(this.argumentResolvers.supportsParameter(parameter)) {try {

//逐个解析方法参数args[i] = this.argumentResolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);continue;

}...returnargs;}public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

//获取对应的参数解析器HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);

if(resolver == null) {throw new IllegalArgumentException("Unknown parameter type ["+ parameter.getParameterType().getName() +"]");}

//执行解析逻辑returnresolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);

}private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parameter) {HandlerMethodArgumentResolver result = this.argumentResolverCache.get(parameter);

if(result == null) {for(HandlerMethodArgumentResolver methodArgumentResolver : this.argumentResolvers) {

//遍历解析器,supportsParameter方法返回true就可以if(methodArgumentResolver.supportsParameter(parameter)) {result = methodArgumentResolver;

this.argumentResolverCache.put(parameter, result);break;}}}returnresult;}

整个解析的逻辑还比较清晰:

获取方法需要的参数类型,逐个解析

调用解析器的supportsParameter方法,判断是否支持参数类型

调用解析器的resolveArgument方法,解析参数

参数解析示范

在这个就以最常用的RequestHeader,和RequestBody来分析一下解析的流程。

首先是RequestHeader

RequestHeader 对应的解析器为RequestHeaderMethodArgumentResolver。

先查看supportsParameter方法:

public boolean supportsParameter(MethodParameter parameter) {   

 //判断参数是否为RequestHeader注解标记,并且类型不为mapreturn(parameter.hasParameterAnnotation(RequestHeader.class) &&!Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType()));}

接下来查看resolveArgument方法,这个方法在他的父类中:

public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {            

//获取注解信息NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);

MethodParameter nestedParameter = parameter.nestedIfOptional();

//获取header的nameObject resolvedName = resolveStringValue(namedValueInfo.name);

if(resolvedName == null) {...}

//通过name查找Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest);

if(arg == null) {...}if(binderFactory != null) {WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);

try {

//处理类型转换之类的问题arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);

}...}handleResolvedValue(arg, namedValueInfo.name, parameter, mavContainer, webRequest);returnarg;}

逻辑很清晰,关键代码就在resolveName方法里了,进入该方法:

protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest request) throws Exception {String[] headerValues = request.getHeaderValues(name);

if(headerValues != null) {return(headerValues.length == 1 ? headerValues[0] : headerValues);}else{returnnull;}}

这边就可以清晰的看到获取的过程了。

接下来看看RequestBody

RequestBody注解对应的解析器为RequestResponseBodyMethodProcessor

首先还是查看supportsParameter方法:

public boolean supportsParameter(MethodParameter parameter) {

//判断是否有RequestBody注解returnparameter.hasParameterAnnotation(RequestBody.class);}

接下来查看resolveArgument方法:

public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {parameter = parameter.nestedIfOptional();

//解析传入请求的请求体Object arg =readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());

String name = Conventions.getVariableNameForParameter(parameter);

if(binderFactory != null) {WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);

if(arg != null) {

//如果有需要的话校验相关参数validateIfApplicable(binder, parameter);...}...}returnadaptArgumentIfNecessary(arg, parameter);}

讲到这儿可以发现参数解析的逻辑大同小异,那么springboot到底内置了多少解析器呢?

在DispatcherServlet中,根据mapping获取到了相应的方法后,还需要找到相应的HandlerAdapter去执行。当我们使用RequestMapping注解时,使用的就是RequestMappingHandlerAdapter这个类。查看该类的afterPropertiesSet方法()。

public voidafterPropertiesSet() {

// Do this first, it may add ResponseBody advice beansinitControllerAdviceCache();

if(this.argumentResolvers == null) {

//获取解析器的方法就在这里List resolvers = getDefaultArgumentResolvers();

this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);

}...}private ListgetDefaultArgumentResolvers() {List resolvers = new ArrayList<>();

// Annotation-based argument resolutionresolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(),false));

resolvers.add(new RequestParamMapMethodArgumentResolver());

resolvers.add(new PathVariableMethodArgumentResolver());

resolvers.add(new PathVariableMapMethodArgumentResolver());

resolvers.add(new MatrixVariableMethodArgumentResolver());

resolvers.add(new MatrixVariableMapMethodArgumentResolver());

resolvers.add(new ServletModelAttributeMethodProcessor(false));

resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(), 

this.requestResponseBodyAdvice));

resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters(),

 this.requestResponseBodyAdvice));

resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));

resolvers.add(new RequestHeaderMapMethodArgumentResolver());

resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));

resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));

resolvers.add(new SessionAttributeMethodArgumentResolver());

resolvers.add(new RequestAttributeMethodArgumentResolver());

// Type-based argument resolutionresolvers.add(new ServletRequestMethodArgumentResolver());

resolvers.add(new ServletResponseMethodArgumentResolver());

resolvers.add(new HttpEntityMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));

resolvers.add(new RedirectAttributesMethodArgumentResolver());

resolvers.add(new ModelMethodProcessor());

resolvers.add(new MapMethodProcessor());

resolvers.add(new ErrorsMethodArgumentResolver());

resolvers.add(new SessionStatusMethodArgumentResolver());

resolvers.add(new UriComponentsBuilderMethodArgumentResolver());

// Custom argumentsif(getCustomArgumentResolvers() != null) {resolvers.addAll(getCustomArgumentResolvers());}

// Catch-allresolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(),true));

resolvers.add(new ServletModelAttributeMethodProcessor(true));

returnresolvers;}

在getDefaultArgumentResolvers方法中,我们可以看到springboot内置了很多的参数解析器。我们上面说到的RequestResponseBodyMethodProcessor,RequestHeaderMethodArgumentResolver就是在这边注入进容器的。

在此我向大家推荐一个架构学习交流群。交流学习群号:938837867 暗号:555 里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化、分布式架构等这些成为架构师必备

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

推荐阅读更多精彩内容