当前位置:   article > 正文

请求参数获取:@RequestParam、@PathVariable、@RequestHeader、@CookieValue、@RequestBody、@RequestAttribute注解详细分析

请求参数获取:@RequestParam、@PathVariable、@RequestHeader、@CookieValue、@RequestBody、@RequestAttribute注解详细分析

一、@RequestParam注解

        用于将指定的请求参数赋值给方法中的形参。

有三个属性:
(1)value:请求参数名(必须配置)

(2)required:是否必需,默认为 true,即 请求中必须包含该参数,如果没有包含,将会抛出异常(可选配置)

(3)defaultValue:设置默认值,如果设置了该值,required 将自动设为 false,无论你是否配置了required,配置了什么值,都是 false(可选配置)

用法:

  1. @ResponseBody
  2. @GetMapping("/RequestParam")
  3. public Map test(@RequestParam("username") String username,@RequestParam("password") List<String > password){
  4. Map map=new HashMap();
  5. map.put("username",username);
  6. map.put("password",password);
  7. return map;
  8. }

 也可以通过一个@RequestParam注解与Map集合类型参数同时获取多个参数:

  1. @ResponseBody
  2. @GetMapping("/RequestParam")
  3. public Map test(@RequestParam Map<String,String> map1){
  4. Map map=new HashMap();
  5. map.put("test",map1);
  6. return map;
  7. }

 二、@PathVariable注解

        @PathVariable是Rest风格衍生出的占位符,只支持一个属性value,类型是为String,代表绑定的属性名称。默认不传递时,绑定为同名的形参。 用来便捷地提取URL中的动态参数。

        应用时,在@RequestMapping请求路径中,将需要传递的参数用花括号{}括起来,然后,通过@PathVariable("参数名称")获取URL中对应的参数值。如果@PathVariable标明参数名称,则参数名称必须和URL中参数名称一致。

用法:

  1. @ResponseBody
  2. @GetMapping("/PathVariable/{name}/{age}")
  3. public Map test(@PathVariable("name") String name,@PathVariable("age") Integer age){
  4. Map map=new HashMap();
  5. map.put("name",name);
  6. map.put("age",age);
  7. return map;
  8. }

 也可以使用一次注解获取多个参数:

  1. @ResponseBody
  2. @GetMapping("/PathVariable/{name}/{age}")
  3. public Map test(@PathVariable Map<String,String> map3){
  4. Map map=new HashMap();
  5. map.put("params",map3);
  6. return map;
  7. }


 三、@RequestHeader注解

        @RequestHeader 是获取请求头中的数据,通过指定参数 value 的值来获取请求头中指定的参数值。其他参数用法和 @RequestParam 完全一样。

用法:

  1. @ResponseBody
  2. @GetMapping("/RequestHeader")
  3. public Map test(@RequestHeader("host") String host){
  4. Map map=new HashMap();
  5. map.put("header",host);
  6. return map;
  7. }

获取所有请求头信息:
 

  1. @ResponseBody
  2. @GetMapping("/RequestHeader")
  3. public Map test(@RequestHeader Map<String, String> map4){
  4. Map map=new HashMap();
  5. map.put("headers",map4);
  6. return map;
  7. }

 四、@CookieValue注解

        @CookieValue可以获取请求中的Cookie值,@CookieValue 中的参数有三个,其中一个 value 用来指定 Cookie 中的参数名,其他参数用法和 @RequestParam 完全一样。

用法:

  1. @ResponseBody
  2. @GetMapping("/CookieValue")
  3. public Map test(@CookieValue(required = false) Cookie cookie){
  4. Map map=new HashMap();
  5. map.put("cookies",cookie);
  6. return map;
  7. }

五、@RequestBody注解:

        主要用来接收前端传递给后端的json字符串中的数据,也就是请求体中的数据,GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。

        在后端的同一个接收方法里,@RequestBody与@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。

用法:

  1. @ResponseBody
  2. @PostMapping("/save")
  3. //获取请求体参数
  4. public String getRequestBody(@RequestBody String body){
  5. return body;
  6. }
  1. <form th:action="@{/save}" method="post">
  2. 测试@RequestBody获取[post]数据<br>
  3. 用户名:<input name="userName"/><br>
  4. 邮箱:<input name="email"/><br>
  5. <input type="submit" th:value="提交">
  6. </form><br>

 六、@RequestAttribute注解:

        获取请求域中所保存的属性的值。

用法:首先向浏览器发起goto请求并添加自定义值到请求域中,再转发到success请求去获取这些请求域中的值。

  1. @GetMapping("/goto")
  2. public String toSuccess(HttpServletRequest request){
  3. request.setAttribute("msg","成功了!");
  4. request.setAttribute("code",200);
  5. return "forward:/success";
  6. }
  7. //使用@RequestAttribute注解获取请求域中的值与//不使用注解获取请求域中的值
  8. @GetMapping("/success")
  9. public String success(@RequestAttribute("msg")String msg,
  10. @RequestAttribute("code") Integer code,
  11. HttpServletRequest request){
  12. Object msg1 = request.getAttribute("msg");
  13. Map map=new HashMap();
  14. map.put("msg",msg);
  15. map.put("code",code);
  16. System.out.println(map);
  17. System.out.println(msg1);
  18. return "success";
  19. }

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/繁依Fanyi0/article/detail/310187
推荐阅读
相关标签
  

闽ICP备14008679号