Spring参数解析器

已于 2022-06-02 15:18:53 修改
阅读量4.9k 收藏 4
点赞数 1
分类专栏： Spring 文章标签： java
于 2021-09-21 11:52:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/JokerLJG/article/details/120357499
版权

文章目录

请求映射处理适配器：RequestMappingHandlerAdapter

在这里插入图片描述

参数解析器：HandlerMethodArgumentResolver

HandlerMethodArgumentResolver和AbstractNamedValueMethodArgumentResolver是解析策略的上层定义和抽象。

关于这两个类可以参考https://securitit.blog.csdn.net/article/details/110110872的解析。

HandlerMethodArgumentResolver是个接口，只有俩个方法

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter var1);

    @Nullable
    Object resolveArgument(MethodParameter var1, @Nullable ModelAndViewContainer var2, NativeWebRequest var3, @Nullable WebDataBinderFactory var4) throws Exception;
}
  • supportsParameter：用于判定是否需要处理该参数分解，返回true为需要，并会去调用下面的方法resolveArgument。
  • resolveArgument：真正用于处理参数分解的方法，返回的Object就是controller方法上的形参对象。

获取默认参数解析器
RequestMappingHandlerAdapter.getDefaultArgumentResolvers()

	private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
		List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>();

		// 基于注解的参数解析
		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());

		// 基于类型的参数解析
		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());

		// 自定义参数解析
		if (getCustomArgumentResolvers() != null) {
			resolvers.addAll(getCustomArgumentResolvers());
		}

		// Catch-all
		resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
		resolvers.add(new ServletModelAttributeMethodProcessor(true));

		return resolvers;
	}

参数处理相关注解

参数绑定常用注解：

  1. 处理request uri 部分（这里指uri template中variable，不含queryString部分）的注解： @PathVariable;

  2. 处理request header部分的注解： @RequestHeader, @CookieValue;

  3. 处理request body部分的注解：@RequestParam, @RequestBody;

  4. 处理attribute类型的注解： @SessionAttributes, @ModelAttribute;

1.@PathVariable

当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

@Controller  
@RequestMapping(“/owners/{ownerId}”)  
public class RelativePathUriTemplateController {  

  @RequestMapping(“/pets/{petId}”)  
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
  }  
}

若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable(“name”)指定uri template中的名称。

使用的参数解析器：

  1. PathVariableMapMethodArgumentResolver
    在某些条件成立的情况下才会使用此类进行解析：

    • 方法参数由@PathVariable注解注释。
    • 方法参数类型必须是Map类型。
    • 注释方法参数的@PathVariable的value属性不能有值。

  2. PathVariableMethodArgumentResolver
    在某些条件成立的情况下才会使用此类进行解析：

    • 方法参数由@PathVariable注解注释。
    • 当方法参数类型是Map时，要求其必须由@PathVariable注解注释，同时@PathVariable的value属性必须有值。

2.@RequestHeader

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

Host                    localhost:8080  
Accept                  text/html,application/xhtml+xml,application/xml;q=0.9  
Accept-Language         fr,en-gb;q=0.7,en;q=0.3  
Accept-Encoding         gzip,deflate  
Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7  
Keep-Alive              300

@RequestMapping(“/displayHeaderInfo.do”)  
public void displayHeaderInfo(@RequestHeader(“Accept-Encoding”) String encoding,  
                              @RequestHeader(“Keep-Alive”) long keepAlive)  {
                              
}

request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。

使用的参数解析器：

  1. RequestHeaderMapMethodArgumentResolver
    在某些条件成立的情况下才会使用此类进行解析：

    • 方法参数由@RequestHeader注解注释。
    • 方法参数类型必须是Map类型。

  2. RequestHeaderMethodArgumentResolver
    在某些条件成立的情况下才会使用此类进行解析：

    • 方法参数由@RequestHeader注解注释。
    • 方法参数类型不能为Map类型。

@RequestHeader是用来处理Web请求头中的信息，随着网站的多样和多元化，@RequestHeader使用频率会越来越广泛。

3.@CookieValue

@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

例如有如下Cookie值：

JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84 

@RequestMapping(“/displayHeaderInfo.do”)  
public void displayHeaderInfo(@CookieValue(“JSESSIONID”) String cookie)  {  

}

即把JSESSIONID的值绑定到参数cookie上。

使用的参数解析器：

  1. ServletCookieValueMethodArgumentResolver
    ServletCookieValueMethodArgumentResolver实现了最主要的resolveName(…)方法，用于进行参数解析。
    • Cookie使用WebUtils.getCookie(…)从NativeWebRequest中解析。
    • 若方法参数是Cookie类型，那么直接返回Cookie类型。
    • 若方法参数非Cookie类型，那么urlPathHelper.decodeRequestString(…)解析得到String类型的值。

@CookieValue注解在实际应用中，作用还是很大的，传统Web开发中，Cookie是不可绕过的一环，掌握如何快速的通过Spring框架取值，可以帮助我们更快更好的完成任务。

4.@RequestParam

  • 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String–> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；

  • 用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；

  • 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；

使用的参数解析器：

  1. RequestParamMapMethodArgumentResolver

  2. RequestParamMethodArgumentResolve

1）RequestParamMapMethodArgumentResolver

实现了HandlerMethodArgumentResolver的supportsParameter(…)和resolveArgument(…)方法。
使用条件：

  1. 方法参数由@RequestParam注解注释
  2. 方法参数类型必须是Map类型
    • 参数类型为MultiValueMap时，返回LinkedMultiValueMap实例，包含所有请求参数
    • 参数类型为Map时，返回LinkedHashMap实例，包含所有请求参数
  3. @RequestParam注解的name不能有值

2）RequestParamMethodArgumentResolver

RequestParamMethodArgumentResolver继承自抽象AbstractNamedValueMethodArgumentResolver

除了能处理@RequestParam注解外，还可以处理@RequestPart注解。

处理@RequestParam注解的条件：

  1. 方法参数由@RequestParam注解注释。
  2. 方法参数若是Map类型时，@RequestParam的name属性不能为空。
  3. 方法参数若不是Map类型时，都可以处理。

处理@RequestPart注解的条件

  1. 方法参数不可由@RequestPart注解注释。
  2. 方法参数类型为org.springframework.web.multipart.MultipartFile、org.springframework.web.multipart.MultipartFile集合、org.springframework.web.multipart.MultipartFile数组、javax.servlet.http.Part、javax.servlet.http.Part集合或javax.servlet.http.Part数组。
  3. 一个简单类型的方法参数，包括：boolean、byte、char、short、int、long、float、double、Enum.class、CharSequence.class、Number.class、Date.class、URI.class、URL.class、Locale.class或Class.class。

@RequestParam是用来处理Web请求头中的信息，随着网站的多样和多元化，@RequestParam使用频率会越来越广泛。

5.@RequestPart

@RequestPart用于将multipart/form-data类型数据映射到控制器处理方法的参数中。除了@RequestPart注解外，@RequestParam同样可以用于此类操作。

@Controller
@RequestMapping("/test")
public class RequestPartController {
    /**
     * 跳转页面.
     */
    @GetMapping("test1")
    public ModelAndView requestPartHtml(HttpServletRequest req, HttpServletResponse res, ModelMap modelMap)
            throws Exception {
            
    }
    
    /**
     * RequestPart-MultipartFile接收参数.
     */
    @ResponseBody
    @PostMapping("test2")
    public String requestPartMultipartFile(@RequestPart("file") MultipartFile multipartFile) throws Exception {

    }

    /**
     * RequestPart-Part接收参数.
     */
    @ResponseBody
    @PostMapping("test3")
    public String requestPartPart(@RequestPart("file") Part part) throws Exception {
       
    }
    
    /**
     * RequestParam-MultipartFile接收参数.
     */
    @ResponseBody
    @PostMapping("test4")
    public String requestParamMultipartFile(@RequestParam("file") MultipartFile multipartFile) throws Exception {

    }

    /**
     * RequestParam-Part接收参数.
     */
    @ResponseBody
    @PostMapping("test5")
    public String requestParamPart(@RequestParam("file") Part part) throws Exception {

    }

    /**
     * Part接收参数.
     */
    @ResponseBody
    @PostMapping("test6")
    public String part(HttpServletRequest req) throws Exception {
        Part part = req.getPart("file");

    }

}

使用的参数解析器：

  1. RequestPartMethodArgumentResolver

  2. RequestHeaderMapMethodArgumentResolver
    在某些条件成立的情况下才会使用此类进行解析：

    • 方法参数由@RequestPart注解注释。
    • 方法参数不可由@RequestParam注解注释。
    • 方法参数类型为org.springframework.web.multipart.MultipartFile、org.springframework.web.multipart.MultipartFile集合、org.springframework.web.multipart.MultipartFile数组、javax.servlet.http.Part、javax.servlet.http.Part集合或javax.servlet.http.Part数组。

  3. RequestParamMethodArgumentResolver
    参考@RequestParam中的RequestParamMethodArgumentResolver用法

@RequestPart和@RequestParam都可以处理multipart/form-data类型数据，本质上并没有区别，使用任何一个都能达到期望的效果。文件上传在实际应用中也是必不可少的。

6.@RequestBody

  • 该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；

  • 它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。

  • 因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用

Spring MVC中使用HandlerMethodArgumentResolver策略接口来定义处理器方法参数解析器，

使用的参数解析器：

  1. RequestResponseBodyMethodProcessor

    RequestResponseBodyMethodProcessor实现相对比较负责，其功能涉及范围较广，参数绑定仅是其功能之一。RequestResponseBodyMethodProcessor实现了HandlerMethodArgumentResolver的supportsParameter(…)和resolveArgument(…)方法。

    使用此类进行解析的条件：

    1. 方法参数由@RequestBody注解注释。

    具体使用流程：
    通过resolveArgument(…)方法中readWithMessageConverters(…)用来进行请求正文的读取，方法具体内容：

    • 获取请求的Content-Type，用于后续消息转换。
    • 获取参数类型，用于参数实例化及初始化。
    • 遍历消息转换器，通过参数类型匹配可用的消息转换。
    • 调用参数转换器进行请求正文的转换。
    • 处理请求增强器：RequestBodyAdvice方法beforeBodyRead(…)、afterBodyRead(…)和handleEmptyBody(…)。

7.@SessionAttributes

该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。

该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

@Controller  
@RequestMapping(“/editPet.do”)  
@SessionAttributes(“pet”)  
public class EditPetForm {  

}

使用的参数解析器：

  1. SessionAttributeMethodArgumentResolver

8.@ModelAttribute

该注解有两个用法，一个是用于方法上，一个是用于参数上；

  • 用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；

  • 用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：

    • @SessionAttributes 启用的attribute 对象上；
    • @ModelAttribute 用于方法上时指定的model对象；
    • 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

用到方法上:

@ModelAttribute  

public Account addAccount(@RequestParam String number) {  

    return accountManager.findAccount(number);  

}

这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）。

用在参数上:

@RequestMapping(value=“/owners/{ownerId}/pets/{petId}/edit”, method = RequestMethod.POST)  
public String processSubmit(@ModelAttribute Pet pet) {  

}

首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

其它注解

@AliasFor

参考文章：
Spring 全面解析——Spring 注解面面通

骑个小蜗牛
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring自定义参数解析器代码实例
08-25
Spring自定义参数解析器代码实例 本文将详细介绍Spring自定义参数解析器代码实例，通过示例代码对大家的学习或者工作具有一定的参考学习价值。 知识点1: 自定义参数解析器 在Spring框架中，参数解析器...
SpringMVC源码分析(八)--参数解析器
最新发布
zmbw2015的博客
03-29 907
本文介绍了SpringMVC中参数解析器的使用及其原理
SpringMVC系列-4 参数解析器
Sheng_Q的博客
10-06 822
本文作为SpringMVC系列的第四篇，介绍参数解析器。本文讨论的参数解析表示从HTTP消息中解析出JAVA对象或流对象并传参给Controller接口的过程。 本文内容包括介绍参数解析器工作原理、常见的参数解析器、自定义参数解析器等三部分。其中，原理部分会结合源码进行说明。
Spring核心接口：HandlerMethodArgumentResolver参数解析器
five-five
03-25 1132
在Spring中，参数解析器是一个接口，它负责将HTTP请求中的参数解析为控制器方法的参数。Spring提供了许多内置的参数解析器，用于处理不同类型的请求参数，例如查询参数、路径变量、请求头、请求体等。开发人员还可以自定义参数解析器，以处理特定的请求参数。除了Spring提供的内置参数解析器外，开发人员还可以自定义参数解析器，以处理特定的请求参数。自定义参数解析器需要实现HandlerMethodArgumentResolver接口，并在配置类中将其添加到WebMvcConfigurer中。
认识Spring参数解析器
BASK2312的博客
12-10 368
子菜单用children存放。
Spring自定义参数解析器的使用
m0_46344146的博客
08-24 209
Spring 自定义参数解析器。Spring 处理Json参数。Spring使用自定义参数解析器处理Json参数
Spring之参数解析器
kenewstar的博客
02-21 1437
Spring中的参数解析，可以让我们自定义的对处理器的一些参数请求做处理，自定义参数解析主要是通过实现 HandlerMethodArgumentResolver 接口，重写supportsParameter()方法和resolveArgument()方法，并注册解析器，即可启用。 一、自定义参数解析器 重写 HandlerMethodArgumentResolver 接口方法 public class DemoArgResolver implements HandlerMethodArgumentReso
spring参数解析器介绍和自定义参数解析器
生而为人我很抱歉
07-18 662
参数解析器属于spring-web包中提供的组件，springmvc框架中对应提供了很多参数解析器。@PostMapping("/save")//此处request对象就是通过Springmvc提供的参数解析器帮我们注入的publicStringsaveUser(HttpServletRequestrequest){}}在上面的saveUser方法中，我们声明了一个类型为的参数，这个对象就是通过springmvc提供的这个参数解析器帮我们注入的。}和。当方法返回true时，才会调用。...
Spring boot 自定义参数解析器
05-19
有备注，有实例，下载就会用
Spring boot中自定义Json参数解析器的方法
10-17
主要介绍了Spring boot中自定义Json参数解析器的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
spring MVC中接口参数解析的过程详解
08-27
主要给大家介绍了关于spring MVC中接口参数解析的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用spring mvc具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
springmvc自定义属性编辑器和参数解析器
08-03
springmvc自定义属性编辑器和参数解析器
Spring MVC的参数解析器【一】
weixin_44117861的博客
11-13 133
form表单参数传入后，SpringMVC解析
spring获取数组参数（一）
u011139317的专栏
11-17 1400
之前在网上找发现了两种方式，一种是封装在一个对象中，设置其中一个属性为数组。第二种则是直接获取，但是只能获取简单数组（比如int ，string） 这里先讲简单的。 前台MyTest.jsp httpUrl
Spring 参数解析器
大魔王的博客
09-12 1135
一、背景 在实际开发中，某些场景下要求开发者对前台传入的参数进行个性化解析、校验、或者获取header中信息等等，这时候我们就需要利用自定义参数解析器来满足这些需求 二、DispatcherServlet运行流程 DispatcherServlet 的结构如下，可以看出这个本质上还是个servlet 在实际的调用逻辑中，前端请求过来之后执行 servlet 的 service() 方法，方法核心调用 DispatcherServlet 的 doservice() 方法，其中最核心的是 dodis
SpringMVC获取QueryString格式参数
Leon_Jinhai_Sun的博客
06-18 3010
SpringMVC获取QueryString格式参数
Spring中常见的参数解析器
欢迎一起学习交流
06-23 270
Spring中常见的参数解析器
自定义 Spring 参数解析器
weixin_49137820的博客
12-31 415
因为业务需求, 有时候在handler中多次处理同一个逻辑并将结束后的对象传递给业务层, 此时我们也想像 Spring 自动解析handler上的参数一样简单, 于是就可以实现 Spring 提供的 HandlerMethodArgumentResolver 拓展接口, 然后交给 Spring MVC 进行管理.
spring 参数解析器和参数转换器
09-15
Spring参数解析器和参数转换器是用于处理Controller方法中传入参数的工具。 参数解析器用于将请求中的参数值解析为方法所需的具体类型。Spring MVC提供了多种参数解析器，例如： - @RequestParam：用于获取请求参数的值 - @PathVariable：用于获取URL中的路径变量 - @RequestBody：用于获取请求体中的数据 参数转换器用于将参数值从一种类型转换为另一种类型。Spring MVC提供了多种参数转换器，例如： - 自动类型转换：Spring会根据方法参数的类型自动进行类型转换，例如String转换为int - 自定义转换器：可以自定义类型转换器，实现Converter接口进行类型转换 通过参数解析器和参数转换器，我们可以方便地将请求中的数据转换为方法所需的具体类型，简化了参数处理的操作。同时，Spring也支持多种参数解析器和参数转换器的组合使用，以满足不同的业务需求。 总而言之，Spring参数解析器和参数转换器是Spring MVC框架中用于处理Controller方法中传入参数的工具，通过它们可以将请求中的参数值解析为方法所需的具体类型，并进行相应的类型转换。这样可以简化参数的处理操作，提高开发效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值