HandlerMethodArgumentResolver(一):Controller方法入参自动封装器(将参数parameter解析为值)【享学Spring MVC】(上)

简介: HandlerMethodArgumentResolver(一):Controller方法入参自动封装器(将参数parameter解析为值)【享学Spring MVC】(上)

前言


在享受Spring MVC带给你便捷的时候,你是否曾经这样疑问过:Controller的handler方法参数能够自动完成参数封装(有时即使没有@PathVariable、@RequestParam、@RequestBody等注解都可),甚至在方法参数任意位置写HttpServletRequest、HttpSession、Writer…等类型的参数,它自动就有值了便可直接使用。

对此你是否想问一句:Spring MVC它是怎么办到的?那么本文就揭开它的神秘面纱,还你一片"清白"。


Spring MVC作为一个最为流行的web框架,早早已经成为了实际意义上的标准化(框架),特别是随着Struts2的突然崩塌,Spring MVC几乎一骑绝尘,因此深入了解它有着深远的意义


Spring MVC它只需要区区几个注解就能够让一个普通的java方法成为一个Handler处理器,并且还能有自动参数封装、返回值视图处理/渲染等一系列强大功能,让coder的精力更加的聚焦在自己的业务。


像JSF、Google Web Toolkit、Grails Framework等web框架至少我是没有用过的。

这里有个轻量级的web框架:Play Framework设计上我个人觉得还挺有意思,有兴趣的可以玩玩


HandlerMethodArgumentResolver


策略接口:用于在给定请求的上下文中将方法参数解析为参数值。简单的理解为:它负责处理你Handler方法里的所有入参:包括自动封装、自动赋值、校验等等。有了它才能会让Spring MVC处理入参显得那么高级、那么自动化。

Spring MVC内置了非常非常多的实现,当然若还不能满足你的需求,你依旧可以自定义和自己注册,后面我会给出自定义的示例。


有个形象的公式:HandlerMethodArgumentResolver = HandlerMethod + Argument(参数) + Resolver(解析器)。

解释为:它是HandlerMethod方法的解析器,将HttpServletRequest(header + body 中的内容)解析为HandlerMethod方法的参数(method parameters)


// @since 3.1   HandlerMethod 方法中 参数解析器
public interface HandlerMethodArgumentResolver {
  // 判断 HandlerMethodArgumentResolver 是否支持 MethodParameter
  // (PS: 一般都是通过 参数上面的注解|参数的类型)
  boolean supportsParameter(MethodParameter parameter);
  // 从NativeWebRequest中获取数据,ModelAndViewContainer用来提供访问Model
  // MethodParameter parameter:请求参数
  // WebDataBinderFactory用于创建一个WebDataBinder用于数据绑定、校验
  @Nullable
  Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;
}


基于这个接口的处理器实现类不可谓不丰富,非常之多。我截图如下:


image.png

因为子类众多,所以我分类进行说明。我把它分为四类进行描述:


  1. 基于Name
  2. 数据类型是Map的
  3. 固定参数类型
  4. 基于ContentType的消息转换器


第一类:基于Name

从URI(路径变量)、HttpServletRequest、HttpSession、Header、Cookie…等中根据名称key来获取值


这类处理器所有的都是基于抽象类AbstractNamedValueMethodArgumentResolver来实现,它是最为重要的分支(分类)。


// @since 3.1  负责从路径变量、请求、头等中拿到值。(都可以指定name、required、默认值等属性)
// 子类需要做如下事:获取方法参数的命名值信息、将名称解析为参数值
// 当需要参数值时处理缺少的参数值、可选地处理解析值
//特别注意的是:默认值可以使用${}占位符,或者SpEL语句#{}是木有问题的
public abstract class AbstractNamedValueMethodArgumentResolver implements HandlerMethodArgumentResolver {
  @Nullable
  private final ConfigurableBeanFactory configurableBeanFactory;
  @Nullable
  private final BeanExpressionContext expressionContext;
  private final Map<MethodParameter, NamedValueInfo> namedValueInfoCache = new ConcurrentHashMap<>(256);
  public AbstractNamedValueMethodArgumentResolver() {
    this.configurableBeanFactory = null;
    this.expressionContext = null;
  }
  public AbstractNamedValueMethodArgumentResolver(@Nullable ConfigurableBeanFactory beanFactory) {
    this.configurableBeanFactory = beanFactory;
    // 默认是RequestScope
    this.expressionContext = (beanFactory != null ? new BeanExpressionContext(beanFactory, new RequestScope()) : null);
  }
  // protected的内部类  所以所有子类(注解)都是用友这三个属性值的
  protected static class NamedValueInfo {
    private final String name;
    private final boolean required;
    @Nullable
    private final String defaultValue;
    public NamedValueInfo(String name, boolean required, @Nullable String defaultValue) {
      this.name = name;
      this.required = required;
      this.defaultValue = defaultValue;
    }
  }
  // 核心方法  注意此方法是final的,并不希望子类覆盖掉他~
  @Override
  @Nullable
  public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
    // 创建 MethodParameter 对应的 NamedValueInfo
    NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);
    // 支持到了Java 8 中支持的 java.util.Optional
    MethodParameter nestedParameter = parameter.nestedIfOptional();
    // name属性(也就是注解标注的value/name属性)这里既会解析占位符,还会解析SpEL表达式,非常强大
    // 因为此时的 name 可能还是被 ${} 符号包裹, 则通过 BeanExpressionResolver 来进行解析
    Object resolvedName = resolveStringValue(namedValueInfo.name);
    if (resolvedName == null) {
      throw new IllegalArgumentException("Specified name must not resolve to null: [" + namedValueInfo.name + "]");
    }
    // 模版抽象方法:将给定的参数类型和值名称解析为参数值。  由子类去实现
    // @PathVariable     --> 通过对uri解析后得到的decodedUriVariables值(常用)
    // @RequestParam     --> 通过 HttpServletRequest.getParameterValues(name) 获取(常用)
    // @RequestAttribute --> 通过 HttpServletRequest.getAttribute(name) 获取   <-- 这里的 scope 是 request
    // @SessionAttribute --> 略
    // @RequestHeader    --> 通过 HttpServletRequest.getHeaderValues(name) 获取
    // @CookieValue      --> 通过 HttpServletRequest.getCookies() 获取
    Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest);
    // 若解析出来值仍旧为null,那就走defaultValue (若指定了的话)
    if (arg == null) {
      // 可以发现:defaultValue也是支持占位符和SpEL的~~~
      if (namedValueInfo.defaultValue != null) {
        arg = resolveStringValue(namedValueInfo.defaultValue);
      // 若 arg == null && defaultValue == null && 非 optional 类型的参数 则通过 handleMissingValue 来进行处理, 一般是报异常
      } else if (namedValueInfo.required && !nestedParameter.isOptional()) {
        // 它是个protected方法,默认抛出ServletRequestBindingException异常
        // 各子类都复写了此方法,转而抛出自己的异常(但都是ServletRequestBindingException的异常子类)
        handleMissingValue(namedValueInfo.name, nestedParameter, webRequest);
      }
      // handleNullValue是private方法,来处理null值
      // 针对Bool类型有这个判断:Boolean.TYPE.equals(paramType) 就return Boolean.FALSE;
      // 此处注意:Boolean.TYPE = Class.getPrimitiveClass("boolean") 它指的基本类型的boolean,而不是Boolean类型哦~~~
      // 如果到了这一步(value是null),但你还是基本类型,那就抛出异常了(只有boolean类型不会抛异常哦~)
      // 这里多嘴一句,即使请求传值为&bool=1,效果同bool=true的(1:true 0:false) 并且不区分大小写哦(TrUe效果同true)
      arg = handleNullValue(namedValueInfo.name, arg, nestedParameter.getNestedParameterType());
    }
    // 兼容空串,若传入的是空串,依旧还是使用默认值(默认值支持占位符和SpEL)
    else if ("".equals(arg) && namedValueInfo.defaultValue != null) {
      arg = resolveStringValue(namedValueInfo.defaultValue);
    }
    // 完成自动化的数据绑定~~~
    if (binderFactory != null) {
      WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
      try {
        // 通过数据绑定器里的Converter转换器把arg转换为指定类型的数值
        arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
      } catch (ConversionNotSupportedException ex) { // 注意这个异常:MethodArgumentConversionNotSupportedException  类型不匹配的异常
        throw new MethodArgumentConversionNotSupportedException(arg, ex.getRequiredType(),
            namedValueInfo.name, parameter, ex.getCause());
      } catch (TypeMismatchException ex) { //MethodArgumentTypeMismatchException是TypeMismatchException 的子类
        throw new MethodArgumentTypeMismatchException(arg, ex.getRequiredType(),
            namedValueInfo.name, parameter, ex.getCause());
      }
    }
    // protected的方法,本类为空实现,交给子类去复写(并不是必须的)
    // 唯独只有PathVariableMethodArgumentResolver把解析处理啊的值存储一下数据到 
    // HttpServletRequest.setAttribute中(若key已经存在也不会存储了)
    handleResolvedValue(arg, namedValueInfo.name, parameter, mavContainer, webRequest);
    return arg;
  }
  // 此处有缓存,记录下每一个MethodParameter对象   value是NamedValueInfo值
  private NamedValueInfo getNamedValueInfo(MethodParameter parameter) {
    NamedValueInfo namedValueInfo = this.namedValueInfoCache.get(parameter);
    if (namedValueInfo == null) {
      // createNamedValueInfo是抽象方法,子类必须实现
      namedValueInfo = createNamedValueInfo(parameter);
      // updateNamedValueInfo:这一步就是我们之前说过的为何Spring MVC可以根据参数名封装的方法
      // 如果info.name.isEmpty()的话(注解里没指定名称),就通过`parameter.getParameterName()`去获取参数名~
      // 它还会处理注解指定的defaultValue:`\n\t\.....`等等都会被当作null处理
      // 都处理好后:new NamedValueInfo(name, info.required, defaultValue);(相当于吧注解解析成了此对象嘛~~)
      namedValueInfo = updateNamedValueInfo(parameter, namedValueInfo);
      this.namedValueInfoCache.put(parameter, namedValueInfo);
    }
    return namedValueInfo;
  }
  // 抽象方法 
  protected abstract NamedValueInfo createNamedValueInfo(MethodParameter parameter);
  // 由子类根据名称,去把值拿出来
  protected abstract Object resolveName(String name, MethodParameter parameter, NativeWebRequest request) throws Exception;
}


该抽象类中定义了解析参数的主逻辑(模版逻辑),子类只需要实现对应的抽象模版方法即可。

对此部分的处理步骤,我把它简述如下:


  1. 基于MethodParameter构建NameValueInfo <-- 主要有name, defaultValue, required(其实主要是解析方法参数上标注的注解~)
  2. 通过BeanExpressionResolver(${}占位符以及SpEL) 解析name
  3. 通过模版方法resolveName从 HttpServletRequest, Http Headers, URI template variables 等等中获取对应的属性值(具体由子类去实现)
  4. 对 arg==null这种情况的处理, 要么使用默认值, 若 required = true && arg == null, 则一般报出异常(boolean类型除外~)
  5. 通过WebDataBinder将arg转换成Methodparameter.getParameterType()类型(注意:这里仅仅只是用了数据转换而已,并没有用bind()方法)


该抽象类继承树如下:


image.png


从上源码可以看出,抽象类已经定死了处理模版(方法为final的),留给子类需要做的事就不多了,大体还有如下三件事:


  1. 根据MethodParameter创建NameValueInfo(子类的实现可继承自NameValueInfo,就是对应注解的属性们)
  2. 根据方法参数名称name从HttpServletRequest, Http Headers, URI template variables等等中获取属性值
  3. 对arg == null这种情况的处理(非必须)


PathVariableMethodArgumentResolver


它帮助Spring MVC实现restful风格的URL。它用于处理标注有@PathVariable注解的方法参数,用于从URL中获取值(并不是?后面的参数哦)。

并且,并且,并且它还可以解析@PathVariable注解的value值不为空的Map(使用较少,个人不太建议使用)~


UriComponentsContributor接口:通过查看方法参数和参数值并决定应更新目标URL的哪个部分,为构建UriComponents的策略接口。


// @since 4.0 出现得还是比较晚的
public interface UriComponentsContributor {
  // 此方法完全同HandlerMethodArgumentResolver的这个方法~~~
  boolean supportsParameter(MethodParameter parameter);
  // 处理给定的方法参数,然后更新UriComponentsbuilder,或者使用uri变量添加到映射中,以便在处理完所有参数后用于扩展uri~~~
  void contributeMethodArgument(MethodParameter parameter, Object value, UriComponentsBuilder builder,
      Map<String, Object> uriVariables, ConversionService conversionService);
}


它的三个实现类:


image.png


关于此接口的使用,后面再重点介绍,此处建议自动选择性忽略。


相关文章
|
12月前
|
JSON 自然语言处理 Java
OpenAI API深度解析:参数、Token、计费与多种调用方式
随着人工智能技术的飞速发展,OpenAI API已成为许多开发者和企业的得力助手。本文将深入探讨OpenAI API的参数、Token、计费方式,以及如何通过Rest API(以Postman为例)、Java API调用、工具调用等方式实现与OpenAI的交互,并特别关注调用具有视觉功能的GPT-4o使用本地图片的功能。此外,本文还将介绍JSON模式、可重现输出的seed机制、使用代码统计Token数量、开发控制台循环聊天,以及基于最大Token数量的消息列表限制和会话长度管理的控制台循环聊天。
3861 7
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
1272 2
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
357 2
|
前端开发 Java 开发者
Spring MVC中的控制器:@Controller注解全解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序控制层的核心。它不仅简化了控制器的定义,还提供了灵活的请求映射和处理机制。本文将深入探讨`@Controller`注解的用法、特点以及在实际开发中的应用。
912 0
|
JSON API 数据格式
requests库中json参数与data参数使用方法的深入解析
选择 `data`或 `json`取决于你的具体需求,以及服务器端期望接收的数据格式。
934 2
|
存储 缓存 并行计算
yolov5的train.py的参数信息解析
这篇文章解析了YOLOv5的`train.py`脚本中的参数信息,详细介绍了每个参数的功能和默认值,包括权重路径、模型配置、数据源、超参数、训练轮数、批量大小、图像尺寸、训练选项、设备选择、优化器设置等,以便用户可以根据需要自定义训练过程。
565 0
|
C# 开发者 Windows
震撼发布:全面解析WPF中的打印功能——从基础设置到高级定制,带你一步步实现直接打印文档的完整流程,让你的WPF应用程序瞬间升级,掌握这一技能,轻松应对各种打印需求,彻底告别打印难题!
【8月更文挑战第31天】打印功能在许多WPF应用中不可或缺,尤其在需要生成纸质文档时。WPF提供了强大的打印支持,通过`PrintDialog`等类简化了打印集成。本文将详细介绍如何在WPF应用中实现直接打印文档的功能,并通过具体示例代码展示其实现过程。
1327 0
|
存储 Go UED
精通Go语言的命令行参数解析
【8月更文挑战第31天】
387 0
|
安全 数据安全/隐私保护
|
开发框架 前端开发 .NET
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
451 0

推荐镜像

更多
  • DNS