Spring Boot请求处理之常用参数注解使用教程

目录

• 请求处理-SpringBoot常用参数注解使用
• 1、@PathVariable注解
• 2、@RequestHeader注解
• 3、@RequestParam注解
• 4、@CookieValue注解
• 5、@RequestAttribute注解
• 6、@RequestBody注解
• 7、@MatrixVariable与UrlPathHelper
• 7.1、基本简介
• 7.2、MatrixVariable注解
• 7.3、使用细节
• 7.3.1、WebMvcAutoConfiguration自动装配
• 7.3.2、UrlPathHelper类
• 7.3.3、手动配置矩阵变量
• 7.4、测试使用
• 7.4.1、测试一
• 7.4.2、测试二
• 7.4.3、测试三
• 8、补充：SpringBoot实现前后端数据交互、json数据交互、Controller接收参数的几种常用方式
• 总结

请求处理-SpringBoot常用参数注解使用

注解：

• @PathVariable 路径变量
• @RequestHeader 获取请求头
• @RequestParam 获取请求参数（指问号后的参数，url?a=1&b=2）
• @CookieValue 获取Cookie值
• @RequestAttribute 获取request域属性
• @RequestBody 获取请求体[POST]
• @MatrixVariable 矩阵变量
• @ModelAttribute

1、@PathVariable注解

该注解主要是用于rest风格的搭配使用，在请求路径中不再以k : v的形式给出请求参数与值；而是直接给定一个值。如果方法参数是一个Map<String, String>将会包含路径中所有的变量与值。

访问：浏览器输入路径变量即可，以下是rest风格的get请求的展示，直接在地址栏发起请求就是一个get请求

获取所有访问路径上的请求参数：localhost:8080/ car/{id}/owner/{username}?age=19&inters=

2、@RequestHeader注解

该注解主要用于获取请求头header中的数据，客户端请求之后可以拿到一些头部携带的参数。支持传统的SpringMVC，也支持WebFlux响应式。如果方法参数是一个Map<String, String>将会包含所有的请求头与值

@GetMapping("user/RequestHeader")
public Map<String,Object> getUser3(@RequestHeader("Accept") String Accept,
                                   @RequestHeader Map<String,String> header){
    Map<String,Object> map=new HashMap<>();
    map.put("Accept",Accept);
    map.put("header",header);
    return map;
}

测试：

3、@RequestParam注解

主要用于获取请求参数名称，设置参数是否可有可无以及默认值。

@RequestParam注解详解地址：blog.csdn.net/weixin_4380…

4、@CookieValue注解

主要用于获取Cookie值

5、@RequestAttribute注解

主要用在请求转发时，如果页面无法直接跳转（如WEB-INF下的success页面）可以使用转发的手段。当进行转发时可以在请求中携带上请求的参数，转发会携带上一次请求的参数（一次完整的请求包括转发）

由于是同一次请求，因此也可以直接拿到原生的HttpServletRequest，然后从这里面拿参数和属性也都是可以的【获取request域属性】。

下面就体现了一种转发的思想

结果

6、@RequestBody注解

主要获取表单或者ajax提交的内容，将表单中提交的参数与值获取全部获取出来。即获取请求体【所以请求必须是post请求--@PostMapping】，一般情况下都会使用@RequestBody注解将参数映射到pojo类的能力，但是要保证前后传入的参数名是一样的

7、@MatrixVariable与UrlPathHelper

7.1、基本简介

上述是最常见的三种请求方式；而矩阵变量请求是今天的主角一种新的请求风格，严格来说矩阵变量的请求需要用到rest风格但是又不同于rest.

面试官：页面开发当中把cookie禁用了，session里面的内容怎么使用(找到)？？？

• 正常使用cookie的情况：session.set(a,b)→jsessionid→cookie→每次发请求携带该值
• 每一个用户都有一个不同的sessionid，我们称之为jsessionid，jsessionid会被保存在cookie里面，我们用户在发送请求的时候都会携带cookie。因此禁用了cookie就不能获取里面保存的对象。
• 解决禁用cookie的情况：假设访问路径/abc。我们可以用矩阵变量的形式携带jsessionid值：/abc;jsessionid=xxx。上面的过程就是url重写的过程，相当于把cookie的值使用矩阵变量的方式进行传递。

7.2、MatrixVariable注解

由上面源码知道首先可以知道这个注解是一个修饰在参数上的注解，并且可以在运行时被JVM虚拟机加载到。

• value 和 name属性是两个相同的属性，用于绑定获取到请求的参数。
• pathvar是一个比较重要的属性，当多级路径中出现了相同的参数可以用pathvar指定绑定哪一级路径，然后在获取该级下的参数。
• required属性主要是修饰当前这个矩阵变量是否是必须的；true表示必须，false表示非必须。
• defaultValue属性当required属性值为false时，提交请求的矩阵变量中没有给定该参数的值可以使用默认值替代。

7.3、使用细节

由于SpringBoot中默认并没有开启矩阵变量的支持，直接关闭了矩阵变量。因此在使用的时候我们需要对SpringBoot自动装配的Bean对象进行手动的配置更改。

7.3.1、WebMvcAutoConfiguration自动装配

• WebMvcAutoConfiguration自动装配类由SpringBoot启动时自动装配；
• 内部类WebMvcAutoConfigurationAdapter适配器实现了WebMvcConfigurer接口中的所有方法。
• WebMvcConfigurer接口中的所有方法都是有默认实现的，JDK8的新特性。

7.3.2、UrlPathHelper类

真正使得无法使用矩阵变量的原因是UrlPathHelper类中的removeSemicolonContent默认为true，即移除分号内容。

• 由于ＭatrixVariable矩阵变量是根据分号进行区分的，而底层默认是移除的也就是说不生效。
• 因此手动开启原理：对于路径的处理，SpringBoot用UrlPathHelper进行解析，其里面的属性removeSemicolonContent设置为false，才能让其支持矩阵变量。

7.3.3、手动配置矩阵变量

方法：参照第一章说的SpringBoot三个自配置规则，利@configuration+WebMvcConfigurer自定义规则即可，因此为了开启矩阵变量的使用必须实现WebMvcConfigurer接口，完成对configurePathMatch方法的手动实现。而WebMvcConfigurer接口中所有的方法都是default的默认方法，因此可以使用适配器模式单独对该方法进行重写。所以可以在配置类中手动向IOC容器中配置一个Bean对象，该对象只对这一个方法进行重写实现即可。

重写如下

7.4、测试使用

首先必须手动配置对矩阵变量的支持，其次矩阵变量是绑定在rest路径变量中的

7.4.1、测试一

上述两种路径都会使用同一个Controller进行处理，path拿到的就是 / 到第一个 ; 号之间的路径。

7.4.2、测试二

Gage绑定{gege}中的age参数，Dage绑定{didi}中的age；这样就能准确的区分出到底获取哪个age。

7.4.3、测试三

8、补充：SpringBoot实现前后端数据交互、json数据交互、Controller接收参数的几种常用方式

摘自：https://www.jb51.net/article/240671.htm

现在大多数互联网项目都是采用前后端分离的方式开发，前端人员负责页面展示和数据获取，后端负责业务逻辑处理和接口封装。当与前端交互的过程当中，常用json数据与前端进行交互，这样想取出前端传送过来的json数据的时候，就需要用到@RequestBody这个注解。@RequestBody注解用于读取http请求的内容(字符串)，通过springmvc提供的HttpMessageConverter接口将读到的内容转换为json、xml等格式的数据并绑定到controller方法的参数上。

提交方式为 POST 时，

• JQuery Ajax 以 application/x-www-form-urlencoded 上传 JSON对象 ，后端用 @RequestParam 或者Servlet 获取参数。
• JQuery Ajax 以 application/json 上传 JSON字符串，后端用 @RquestBody 获取参数。

获取参数的几种常用注解

• @PathVariable：一般我们使用URI template样式映射使用，即url/{param}这种形式，也就是一般我们使用的GET，DELETE，PUT方法会使用到的，我们可以获取URL后所跟的参数。
• @RequestParam：一般我们使用该注解来获取多个参数，在（）内写入需要获取参数的参数名即可，一般在PUT，POST中比较常用。
• @RequestBody：该注解和@RequestParam殊途同归，我们使用该注解将所有参数转换，在代码部分在一个个取出来，也是目前我使用到最多的注解来获取参数
• 还有@RequestHeader来获取头信息里的值，@CookieValue来获取Cookie值等等。在这，我也仅仅说明一些较常用的取值方法而已。

总结

到此这篇关于Spring Boot请求处理之常用参数注解使用的文章就介绍到这了,更多相关Spring Boot请求参数注解内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！