day07-SpringBoot接收参数相关注解

SpringBoot接收参数相关注解

1.基本介绍

• SpringBoot接收客户端提交数据/参数会使用到相关注解
  
• 详解@PathVariable、@RequestHeader、@ModelAttribute、@RequestParam、@CookieValue、@RequestBody
  

2.接参数相关注解应用实例

演示各种方式提交数据/参数给服务器，服务器如何使用注解接收
2.1@PathVariable

通过@RequestMapping和@PathVariable，获取映射路径的占位符匹配的参数，并赋给方法形参。
index.html

1. <a target="_blank" href="https://www.cnblogs.com/monster/100/king">@PathVariable-路径变量 monster/100/king</a>

复制代码

ParameterController.java

1. ...
2. @RestController
3. public class ParameterController {
4.     @GetMapping("/monster/{id}/{name}")
5.     public String pathVariable(@PathVariable("id") Integer id,//单个接收
6.                                @PathVariable("name") String name,
7.                                //使用map可以一次接收多个路径占位符
8.                                @PathVariable Map<String, String> map) {
9.         System.out.println("id=" + id);
10.         System.out.println("name=" + name);
11.         System.out.println("map=" + map);
12.         return "success";
13.     }
14. }

复制代码

访问超链接，结果后台输出：

1. id=100
2. name=king
3. map={id=100, name=king}

复制代码

2.2@RequestHeader

@RequestHeader用于将请求的头信息区数据映射到功能处理方法的参数上，@RequestHeader("xxx") 代表获取请求头的xxx属性，xxx不区分大小写。
index.html

1. <a target="_blank" href="https://www.cnblogs.com/requestHeader">@RequestHeader-获取HTTP请求头</a>

复制代码

ParameterController.java

1. //@RequestHeader("xxx") 代表获取请求头的xxx属性,xxx不区分大小写
2. //@RequestHeader Map<String,String> header 表示将获取请求头的所有属性，并放入map中
3. @GetMapping("/requestHeader")
4. public String requestHeader(@RequestHeader("Host") String host,
5.                             @RequestHeader Map<String, String> header) {
6.     System.out.println("host=" + host);
7.     System.out.println("header=" + header);
8.     return "success";
9. }

复制代码

访问超链接，后台输出：

1. host=localhost:8080
2. header={host=localhost:8080, user-agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/110.0, accept=text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8, accept-language=zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2, accept-encoding=gzip, deflate, br, connection=keep-alive, referer=http://localhost:8080/index.html, cookie=Idea-f24e85b1=ae595c67-c988-4ef0-856d-44549b2b2eb7, upgrade-insecure-requests=1, sec-fetch-dest=document, sec-fetch-mode=navigate, sec-fetch-site=same-origin, sec-fetch-user=?1}

复制代码

2.3@RequestParam

该注解的作用是：把请求中的指定名称的参数传递给控制器中的形参赋值

• value / name：请求参数中的名称 （必写参数）
  
• required：请求参数中是否必须提供此参数，默认值是true，true为必须提供
  
• defaultValue：默认值
  

index.html

1. <a target="_blank" href="https://www.cnblogs.com/hi?name=杰克&hobby=羽毛球&hobby=篮球">@RequestParam-获取请求参数</a>

复制代码

ParameterController.java

也可以使用map接收所有参数值，但是如果有多个相同名称的参数值，只能接收第一个，因为map的key冲突了

1. @GetMapping("/hi")
2. public String hi(@RequestParam("name") String username,
3.                  @RequestParam("hobby") List<String> hobbies) {
4.     System.out.println("username=" + username);
5.     System.out.println("hobby=" + hobbies);
6.     return "success";
7. }

复制代码

访问超链接，后台输出：

1. username=杰克
2. hobby=[羽毛球, 篮球]

复制代码

2.4@CookieValue

通过@CookieValue注解可以拿到cookie的值，它的属性有：

• value：参数名称
  
• required：是否必须
  
• defaultValue：默认值
  

ParameterController.java

1. /**
2. * 1.value="xxx"表示接收名字为xx的cookie
3. * 如果浏览器带有对应的cookie，若后面的参数类型为String，则接收到的是对应的value
4. * 若后面的参数类型为Cookie，则接收到的是对应的cookie
5. * 2.required = false 表示该值为非必须的，默认是true
6. */
7. @GetMapping("/cookie")
8. public String cookie(@CookieValue(value = "cookie_key", required = false) String val,
9.                      @CookieValue(value = "username", required = false) Cookie cookie) {
10.     System.out.println("cookie_value=" + val);
11.     if (cookie != null) {
12.         System.out.println("username=" + cookie.getName() + "-" + cookie.getValue());
13.     }
14.     return "success";
15. }

复制代码

浏览器访问方法路径，如果没有对应的cookie，就会输出null，如果有则输出对应的cookie值：

1. cookie_value=hello
2. username=username-king

复制代码

2.5@RequestBody

@RequestBody接收的参数来自requestBody中，即请求体。一般用于处理非Content-Type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据。
就application/json类型的数据而言，使用注解@RequestBody可以将body里面所有的json数据传到后端，后端再进行解析。
index.html：一般来说，@RequestBody注解一般使用在post请求中，因为前端将json数据放在了请求体中。

1. <h1>测试@RequestBody获取数据，获取post请求体</h1>
2. <form action="/save" method="post">
3.     姓名：<input name="name"/><br/>
4.     年龄：<input name="age"/><br/>
5.     <input type="submit" value="提交"/>
6. </form>

复制代码

ParameterController.java

1. @PostMapping("/save")
2. public String postMethod(@RequestBody String content) {
3.     System.out.println("content=" + content);
4.     return "success";
5. }

复制代码

浏览器填写表单，提交：
后端输出：content=name=jack&age=25
2.6@RequestAttribute

@RequestAttribute 可以获取request请求域中的数据
index.html

1. <a target="_blank" href="https://www.cnblogs.com/login">@RequestAttribute-获取request域属性</a>

复制代码

RequestController.java

1. package com.li.controller;
3. import org.springframework.stereotype.Controller;
4. import org.springframework.web.bind.annotation.GetMapping;
5. import org.springframework.web.bind.annotation.RequestAttribute;
6. import org.springframework.web.bind.annotation.ResponseBody;
8. import javax.servlet.http.HttpServletRequest;
10. /**
11. * @author 李
12. * @version 1.0
13. */
14. @Controller
15. public class RequestController {
16.     @GetMapping("/login")
17.     public String login(HttpServletRequest request) {
18.         request.setAttribute("user", "Smith");//向request域中添加数据
19.         return "forward:/ok";//转发到/ok（需要在配置中启用视图解析器）
20.     }
22.     @GetMapping("/ok")
23.     @ResponseBody
24.     public String ok(@RequestAttribute(value = "user", required = false) String username) {
25.         //获取到request域中的数据
26.         System.out.println("username=" + username);
27.         return "success";
28.     }
29. }

复制代码

浏览器访问超链接 /login，后台输出：

1. username=Smith

复制代码

2.7@SessionAttribute

@SessionAttribute用来标注在接口的参数上，参数的值来源于session作用域。
RequestController.java

1. package com.li.controller;
3. import org.springframework.stereotype.Controller;
4. import org.springframework.web.bind.annotation.GetMapping;
5. import org.springframework.web.bind.annotation.RequestAttribute;
6. import org.springframework.web.bind.annotation.ResponseBody;
7. import org.springframework.web.bind.annotation.SessionAttribute;
9. import javax.servlet.http.HttpServletRequest;
11. /**
12. * @author 李
13. * @version 1.0
14. */
15. @Controller
16. public class RequestController {
17.     @GetMapping("/login")
18.     public String login(HttpServletRequest request) {
19.         //向session中添加数据
20.         request.getSession().setAttribute("website", "https://www.baidu.com");
21.         return "forward:/ok";//转发到/ok（需要在配置中启用视图解析器）
22.     }
24.     @GetMapping("/ok")
25.     @ResponseBody
26.     public String ok(@SessionAttribute(value = "website", required = false) String site) {
27.         //获取session域的数据
28.         System.out.println("site=" + site);
29.         return "success";
30.     }
31. }

复制代码

浏览器访问/login，后台输出：

1. site=https://www.baidu.com

复制代码

3.复杂参数的使用

3.1基本介绍

• 在开发中，SpringBoot在响应客户端请求时也支持复杂参数
  
• Map、Model、Errors/BindingResult、RedirectAttributes、ServletResponse、SessionStatus、UriComponentsBuilder、ServletUriComponentsBuilder、HttpSession
  
• Map、Model数据会被放在request域中
  
• RedirectAttributes重定向携带数据
  

3.2复杂参数应用实例

说明：演示复杂参数的使用，重点演示Map、Model、ServletResponse
控制器中添加两个方法

1. //模拟响应一个注册的请求
2. @GetMapping("/register")
3. public String register(Map<String, Object> map,
4.                        Model model,
5.                        HttpServletResponse response) {
6.     //如果有一个注册请求，会将注册数据封装到map或者model中（这里没有写表单，手动添加一下）
7.     map.put("user", "jack");
8.     map.put("job", "java后端");
9.     model.addAttribute("salary", 10000);
10.     //map和model中的数据会被自动放入到request域中
11.    
12.     //演示创建cookie，通过response添加到客户端
13.     Cookie cookie = new Cookie("email","marry@qq.com");
14.     response.addCookie(cookie);
15.    
16.     return "forward:/registerOk";//请求转发
17. }
19. @GetMapping("/registerOk")
20. @ResponseBody
21. public String regOk(HttpServletRequest request) {
22.     System.out.println("user=" + request.getAttribute("user"));
23.     System.out.println("job=" + request.getAttribute("job"));
24.     System.out.println("salary=" + request.getAttribute("salary"));
25.     return "success";
26. }

复制代码

浏览器访问register方法，后台输出：

1. user=jack
2. job=java后端
3. salary=10000

复制代码

为什么map和model中的数据会被自动放入到request域中?

register()方法通过response参数将cookie返回给浏览器：
4.自定义对象参数-自动封装

4.1基本介绍

• 在开发中，SpringBoot在响应客户端请求时，也支持自定义对象参数
  
• 完成自动类型转换与格式化
  
• 支持级联封装
  

4.2应用实例

演示自定义对象参数的使用，完成自动封装，类型转换
save.html

1. <!DOCTYPE html>
2. <html lang="en">
3. <head>
4.     <meta charset="UTF-8">
5.     <title>save</title>
6. </head>
7. <body>
8. <h1>根据表单数据-自动封装POJO(级联封装)</h1>
9. <form action="/saveMonster" method="post">
10.   编号：<input name="id" value=""/><br/>
11.   姓名：<input name="name" value=""/><br/>
12.   年龄：<input name="age" value=""/><br/>
13.   婚否：<input name="isMarried" value=""/><br/>
14.   生日：<input name="birth" value=""/><br/>
15.   坐骑名称：<input name="car.name" value=""/><br/>
16.   坐骑价格：<input name="car.price" value=""/><br/>
17.   <input type="submit" value="保存"/>
18. </form>
19. </body>
20. </html>

复制代码

bean/Car.java

1. package com.li.bean;
3. import lombok.Data;
5. /**
6. * @author 李
7. * @version 1.0
8. */
9. @Data
10. public class Car {
11.     private String name;
12.     private Double price;
13. }

复制代码

bean/Monster.java

1. package com.li.bean;
3. import lombok.Data;
5. import java.util.Date;
7. /**
8. * @author 李
9. * @version 1.0
10. */
11. @Data
12. public class Monster {
13.     private Integer id;
14.     private String name;
15.     private Integer age;
16.     private Boolean isMarried;
17.     private Date birth;
18.     private Car car;
19. }

复制代码

控制器ParameterController.java添加处理请求

1. //处理添加Monster的方法
2. @PostMapping("/saveMonster")
3. @ResponseBody
4. public String saveMonster(Monster monster) {
5.     System.out.println("monster=" + monster);
6.     return "success";
7. }

复制代码

浏览器访问save.html，输入数据点击提交：
后端接收到表单信息，自动封装到对象中（支持级联封装）：

1. monster=Monster(id=10086, name=白骨精, age=567, isMarried=false, birth=Thu Dec 23 00:00:00 CST 1456, car=Car(name=宝马, price=200000.0))

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！