HandlerMethodArgumentResolver(二):Map参数类型和固定参数类型【享学Spring MVC】(上)

简介: HandlerMethodArgumentResolver(二):Map参数类型和固定参数类型【享学Spring MVC】(上)

前言


上文 介绍了Spring MVC用于处理入参的处理器:HandlerMethodReturnValueHandler它的作用,以及介绍了最为常用的两个参数处理器子类:PathVariableMethodArgumentResolver和RequestParamMethodArgumentResolver。由于该体系的重要以及庞大,本文将接着继续讲解~


第一类:基于Name(续)


RequestHeaderMethodArgumentResolver

@RequestHeader注解,可以把Request请求header部分的值绑定到方法的参数上。


public class RequestHeaderMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
  // 必须标注@RequestHeader注解,并且不能,不能,不能是Map类型
  // 有的小伙伴会说:`@RequestHeader Map headers`这样可以接收到所有的请求头啊
  // 其实不是本类的功劳,是`RequestHeaderMapMethodArgumentResolver`的作用
  @Override
  public boolean supportsParameter(MethodParameter parameter) {
    return (parameter.hasParameterAnnotation(RequestHeader.class) &&
        !Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType()));
  }
  // 理解起来很简单:可以单值,也可以List/数组
  @Override
  @Nullable
  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;
    }
  }
}


此处理器能处理的是我们这么来使用:


    @ResponseBody
    @GetMapping("/test")
    public Object test(@RequestHeader("Accept-Encoding") String encoding,
                       @RequestHeader("Accept-Encoding") List<String> encodingList) {
        System.out.println(encoding);
        System.out.println(encodingList);
        return encoding;
    }


请求头截图:


image.png


结果打印(集合封装成功了,证明逗号分隔是可以被封装成集合/数组的):

gzip, deflate, br
[gzip, deflate, br]


Tip:注解指定的value值(key值)是区分大小写的


RequestAttributeMethodArgumentResolver


处理必须标注有@RequestAttribute注解的参数,原理说这一句话就够了。


return request.getAttribute(name, RequestAttributes.SCOPE_REQUEST);


SessionAttributeMethodArgumentResolver


同上(注解不一样,scope不一样而已)


AbstractCookieValueMethodArgumentResolver(抽象类)


对解析标注有@CookieValue的做了一层抽象,子类负责从request里拿值(该抽象类不合请求域绑定)。

public abstract class AbstractCookieValueMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
  ...
  @Override
  public boolean supportsParameter(MethodParameter parameter) {
    return parameter.hasParameterAnnotation(CookieValue.class);
  } 
  @Override
  protected void handleMissingValue(String name, MethodParameter parameter) throws ServletRequestBindingException {
    throw new MissingRequestCookieException(name, parameter);
  }
  ... // 并木有实现核心resolveName方法
}


ServletCookieValueMethodArgumentResolver


指定了从HttpServletRequest去拿cookie值。

public class ServletCookieValueMethodArgumentResolver extends AbstractCookieValueMethodArgumentResolver {
  private UrlPathHelper urlPathHelper = new UrlPathHelper();
  ...
  public void setUrlPathHelper(UrlPathHelper urlPathHelper) {
    this.urlPathHelper = urlPathHelper;
  }
  @Override
  @Nullable
  protected Object resolveName(String cookieName, MethodParameter parameter, NativeWebRequest webRequest) throws Exception {
    HttpServletRequest servletRequest = webRequest.getNativeRequest(HttpServletRequest.class);
    Assert.state(servletRequest != null, "No HttpServletRequest");
    // 工具方法,底层是:request.getCookies()
    Cookie cookieValue = WebUtils.getCookie(servletRequest, cookieName);
    // 如果用javax.servlet.http.Cookie接受值,就直接返回了
    if (Cookie.class.isAssignableFrom(parameter.getNestedParameterType())) {
      return cookieValue;
    } else if (cookieValue != null) { // 否则返回cookieValue
      return this.urlPathHelper.decodeRequestString(servletRequest, cookieValue.getValue());
    } else {
      return null;
    }
  }
}


一般我们这么来用:

    @ResponseBody
    @GetMapping("/test")
    public Object test(@CookieValue("JSESSIONID") Cookie cookie,
                       @CookieValue("JSESSIONID") String cookieValue) {
        System.out.println(cookie);
        System.out.println(cookieValue);
        return cookieValue;
    }


手动设置一个cookie值,然后请求

image.png


控制台打印如下:

javax.servlet.http.Cookie@401ef395
123456



Tips:在现在restful风格下,cookie使用得是很少的了。一般用于提升用户体验方面~


MatrixVariableMethodArgumentResolver


标注有@MatrixVariable注解的参数的处理器。Matrix:矩阵,这个注解是Spring3.2新提出来的,增强Restful的处理能力(配合@PathVariable使用),比如这类URL的解析就得靠它:/owners/42;q=11/pets/21;s=23;q=22。


关于@MatrixVariable它的使用案例,我找了两篇靠谱文章给你参考:

参考一

参考二


// @since 3.2
public class MatrixVariableMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
  // @MatrixVariable注解是必须的。然后技能处理普通类型,也能处理Map
  @Override
  public boolean supportsParameter(MethodParameter parameter) {
    if (!parameter.hasParameterAnnotation(MatrixVariable.class)) {
      return false;
    }
    if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
      MatrixVariable matrixVariable = parameter.getParameterAnnotation(MatrixVariable.class);
      return (matrixVariable != null && StringUtils.hasText(matrixVariable.name()));
    }
    return true;
  }
  ...
}


ExpressionValueMethodArgumentResolver

它用于处理标注有@Value注解的参数。对于这个注解我们太熟悉不过了,没想到在web层依旧能发挥作用。本文就重点来会会它~


通过@Value让我们在配置文件里给参数赋值,在某些特殊场合(比如前端不用传,但你想给个默认值,这个时候用它也是一种方案)


说明:这就相当于在Controller层使用了@Value注解,其实我是不太建议的。因为@Value建议还是只使用在业务层~


// @since 3.1
public class ExpressionValueMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
  // 唯一构造函数  支持占位符、SpEL
  public ExpressionValueMethodArgumentResolver(@Nullable ConfigurableBeanFactory beanFactory) {
    super(beanFactory);
  }
  //必须标注有@Value注解
  @Override
  public boolean supportsParameter(MethodParameter parameter) {
    return parameter.hasParameterAnnotation(Value.class);
  }
  @Override
  protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
    Value ann = parameter.getParameterAnnotation(Value.class);
    return new ExpressionValueNamedValueInfo(ann);
  }
  private static final class ExpressionValueNamedValueInfo extends NamedValueInfo {
    // 这里name传值为固定值  因为只要你的key不是这个就木有问题
    // required传固定值false
    // defaultValue:取值为annotation.value() --> 它天然支持占位符和SpEL嘛
    private ExpressionValueNamedValueInfo(Value annotation) {
      super("@Value", false, annotation.value());
    }
  }
  // 这里恒返回null,因此即使你的key是@Value,也是不会采纳你的传值的哟~
  @Override
  @Nullable
  protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest webRequest) throws Exception {
    // No name to resolve
    return null;
  }
}


根本原理其实只是利用了defaultValue支持占位符和SpEL的特性而已。给个使用示例:


// 在MVC子容器中导入外部化配置
@Configuration
@PropertySource("classpath:my.properties") // 此处有键值对:test.myage = 18
@EnableWebMvc
public class WebMvcConfig extends WebMvcConfigurerAdapter { ... }
    @ResponseBody
    @GetMapping("/test")
    public Object test(@Value("#{T(Integer).parseInt('${test.myage:10}') + 10}") Integer myAge) {
        System.out.println(myAge);
        return myAge;
    }


请求:/test,打印:28。

注意:若你写成@Value("#{'${test.myage:10}' + 10},那你得到的答案是:1810(成字符串拼接了)。




相关文章
|
29天前
|
SQL JavaScript Java
springboot+springm vc+mybatis实现增删改查案例!
springboot+springm vc+mybatis实现增删改查案例!
23 0
|
7天前
|
数据采集 前端开发 Java
数据塑造:Spring MVC中@ModelAttribute的高级数据预处理技巧
数据塑造:Spring MVC中@ModelAttribute的高级数据预处理技巧
21 3
|
7天前
|
存储 前端开发 Java
会话锦囊:揭示Spring MVC如何巧妙使用@SessionAttributes
会话锦囊:揭示Spring MVC如何巧妙使用@SessionAttributes
13 1
|
7天前
|
前端开发 Java Spring
数据之桥:深入Spring MVC中传递数据给视图的实用指南
数据之桥:深入Spring MVC中传递数据给视图的实用指南
24 3
|
16天前
|
前端开发 安全 Java
使用Java Web框架:Spring MVC的全面指南
【4月更文挑战第3天】Spring MVC是Spring框架的一部分,用于构建高效、模块化的Web应用。它基于MVC模式,支持多种视图技术。核心概念包括DispatcherServlet(前端控制器)、HandlerMapping(请求映射)、Controller(处理请求)、ViewResolver(视图解析)和ModelAndView(模型和视图容器)。开发流程涉及配置DispatcherServlet、定义Controller、创建View、处理数据、绑定模型和异常处理。
使用Java Web框架:Spring MVC的全面指南
|
23天前
|
敏捷开发 监控 前端开发
Spring+SpringMVC+Mybatis的分布式敏捷开发系统架构
Spring+SpringMVC+Mybatis的分布式敏捷开发系统架构
55 0
|
3月前
|
开发框架 前端开发 .NET
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
38 0
|
8月前
|
存储 开发框架 前端开发
[回馈]ASP.NET Core MVC开发实战之商城系统(五)
经过一段时间的准备,新的一期【ASP.NET Core MVC开发实战之商城系统】已经开始,在之前的文章中,讲解了商城系统的整体功能设计,页面布局设计,环境搭建,系统配置,及首页【商品类型,banner条,友情链接,降价促销,新品爆款】,商品列表页面,商品详情等功能的开发,今天继续讲解购物车功能开发,仅供学习分享使用,如有不足之处,还请指正。
114 0
|
9月前
|
开发框架 前端开发 .NET
[回馈]ASP.NET Core MVC开发实战之商城系统(三)
[回馈]ASP.NET Core MVC开发实战之商城系统(三)
67 0
|
9月前
|
开发框架 前端开发 .NET
[回馈]ASP.NET Core MVC开发实战之商城系统(一)
[回馈]ASP.NET Core MVC开发实战之商城系统(一)
113 0