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(成字符串拼接了)。




相关文章
|
1月前
|
JSON 前端开发 Java
SSM:SpringMVC
本文介绍了SpringMVC的依赖配置、请求参数处理、注解开发、JSON处理、拦截器、文件上传下载以及相关注意事项。首先,需要在`pom.xml`中添加必要的依赖,包括Servlet、JSTL、Spring Web MVC等。接着,在`web.xml`中配置DispatcherServlet,并设置Spring MVC的相关配置,如组件扫描、默认Servlet处理器等。然后,通过`@RequestMapping`等注解处理请求参数,使用`@ResponseBody`返回JSON数据。此外,还介绍了如何创建和配置拦截器、文件上传下载的功能,并强调了JSP文件的放置位置,避免404错误。
|
1月前
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
57 2
|
2月前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
|
1月前
|
XML 前端开发 Java
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
本文阐述了Spring、Spring Boot和Spring MVC的关系与区别,指出Spring是一个轻量级、一站式、模块化的应用程序开发框架,Spring MVC是Spring的一个子框架,专注于Web应用和网络接口开发,而Spring Boot则是对Spring的封装,用于简化Spring应用的开发。
123 0
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
|
2月前
|
XML 缓存 前端开发
springMVC02,restful风格,请求转发和重定向
文章介绍了RESTful风格的基本概念和特点,并展示了如何使用SpringMVC实现RESTful风格的请求处理。同时,文章还讨论了SpringMVC中的请求转发和重定向的实现方式,并通过具体代码示例进行了说明。
springMVC02,restful风格,请求转发和重定向
|
3月前
|
Java 数据库连接 Spring
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
文章是关于Spring、SpringMVC、Mybatis三个后端框架的超详细入门教程,包括基础知识讲解、代码案例及SSM框架整合的实战应用,旨在帮助读者全面理解并掌握这些框架的使用。
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
|
3月前
|
XML JSON 数据库
SpringMVC入门到实战------七、RESTful的详细介绍和使用 具体代码案例分析(一)
这篇文章详细介绍了RESTful的概念、实现方式,以及如何在SpringMVC中使用HiddenHttpMethodFilter来处理PUT和DELETE请求,并通过具体代码案例分析了RESTful的使用。
SpringMVC入门到实战------七、RESTful的详细介绍和使用 具体代码案例分析(一)
|
3月前
|
前端开发 应用服务中间件 数据库
SpringMVC入门到实战------八、RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查
这篇文章通过一个具体的项目案例,详细讲解了如何使用SpringMVC、Thymeleaf、Bootstrap以及RESTful风格接口来实现员工信息的增删改查功能。文章提供了项目结构、配置文件、控制器、数据访问对象、实体类和前端页面的完整源码,并展示了实现效果的截图。项目的目的是锻炼使用RESTful风格的接口开发,虽然数据是假数据并未连接数据库,但提供了一个很好的实践机会。文章最后强调了这一章节主要是为了练习RESTful,其他方面暂不考虑。
SpringMVC入门到实战------八、RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查
|
3月前
|
JavaScript 前端开发
Vue中传递自定义参数到后端、后端获取数据(使用Map接收参数)
这篇文章讲述了如何在Vue中通过Axios二次封装传递自定义参数到后端,并展示了后端如何使用Map接收这些参数,以及如何避免参数转换错误和统一接口设计的方法。
|
3月前
|
JSON 前端开发 Java
Spring MVC返回JSON数据
综上所述,Spring MVC提供了灵活、强大的方式来支持返回JSON数据,从直接使用 `@ResponseBody`及 `@RestController`注解,到通过配置消息转换器和异常处理器,开发人员可以根据具体需求选择合适的实现方式。
167 4
下一篇
无影云桌面