При входе в DispatcherServlet контейнер spring получит объект HttpServletRequest, но когда мы используем метод уровня контроллера, мы часто используем RequestBody, RequestHeader и другие аннотации для инкапсуляции объекта в более удобный тип объекта. Итак, когда мы используем такие аннотации, как RequestBody, какая логика преобразования возникает в середине. Давайте проанализируем это сегодня.
логика разбора параметров
Сначала найдите расположение пакета с кодом и введите метод invokeForRequest InvocableHandlerMethod (вы можете сами найти цепочку вызовов, а функция отладки idea очень удобна).
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方法
return doInvoke(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;
}
...
return args;
}
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() + "]");
}
//执行解析逻辑
return resolver.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;
}
}
}
return result;
}
Логика всего анализа относительно ясна:
- Получите типы параметров, требуемые методом, и проанализируйте их один за другим.
- Вызовите метод supportsParameter парсера, чтобы определить, поддерживается ли тип параметра.
- Вызовите метод resolveArgument синтаксического анализатора для разрешения аргументов.
Демонстрация разбора параметров
В этом давайте проанализируем процесс синтаксического анализа с наиболее часто используемыми RequestHeader и RequestBody.
Во-первых, это RequestHeader
Преобразователем, соответствующим RequestHeader, является RequestHeaderMethodArgumentResolver.
Сначала взгляните на метод supportsParameter:
public boolean supportsParameter(MethodParameter parameter) {
//判断参数是否为RequestHeader注解标记，并且类型不为map
return (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的name
Object 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);
return arg;
}
Логика очень понятная, код ключа находится в методе 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 {
return null;
}
}
Здесь хорошо виден процесс приобретения.
Следующий взгляд на RequestBody
Анализатор, соответствующий аннотации RequestBody, — RequestResponseBodyMethodProcessor.
Сначала взгляните на метод supportsParameter:
public boolean supportsParameter(MethodParameter parameter) {
//判断是否有RequestBody注解
return parameter.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);
...
}
...
}
return adaptArgumentIfNecessary(arg, parameter);
}
Сначала парсится тело запроса, а потом проверяется результат — это и есть объект RequestBody, который мы получили. Логика, связанная с парсингом и проверкой в этом месте, мы можем сделать несколько статей и посмотреть:SpringBoot Stepping Diary — ошибка, вызванная непустой проверкой
Говоря об этом, вы можете обнаружить, что логика разбора параметров аналогична, так сколько парсеров построено в springboot?
В DispatcherServlet после получения соответствующего метода по отображению необходимо найти соответствующий HandlerAdapter для выполнения. Когда мы используем аннотацию RequestMapping, мы используем класс RequestMappingHandlerAdapter. Ознакомьтесь с методом afterPropertiesSet() этого класса.
public void afterPropertiesSet() {
// Do this first, it may add ResponseBody advice beans
initControllerAdviceCache();
if (this.argumentResolvers == null) {
//获取解析器的方法就在这里
List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
}
...
}
private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>();
// Annotation-based argument resolution
resolvers.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 resolution
resolvers.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 arguments
if (getCustomArgumentResolvers() != null) {
resolvers.addAll(getCustomArgumentResolvers());
}
// Catch-all
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
resolvers.add(new ServletModelAttributeMethodProcessor(true));
return resolvers;
}
В методе getDefaultArgumentResolvers мы видим, что Springboot имеет встроенные преобразователи параметров. Упомянутые выше RequestResponseBodyMethodProcessor и RequestHeaderMethodArgumentResolver вводятся в контейнер здесь.