Spring MVC 之获取参数（对象、JSON格式数据、URL地址参数、文件、Cookie）

一时失言乱红尘 2023-09-25 15:01 25阅读 0赞

#### 文章目录 ####

*  1. 获取单个参数
 *  2. 获取多个参数
 *  3. 获取对象
 *  4. 后端参数重命名 @RequestParam
 *  5. 接收 JSON 格式的数据 @RequestBody
 *  6. 从 URL 地址中获取参数 @PathVariable
 *  7. 上传文件 @RequestPart
 *  8. 获取Cookie (@CookieValue)/Session/header
 *   *  8.1 获取 Request 和 Response 对象
     *  8.2 获取 Cookie
     *  8.3 获取 Header（请求头）里面的信息
     *  8.4 存储和获取 Session

**服务器端要得到用户的请求参数**

@Data
    public class UserInfo {
        
        private int id;
        private String username;
        private String password;
        private int age;
    }

## 1. 获取单个参数 ##

注意这里的参数类型要用 包装类，否则传一个空的值就会出错， 并且这里的参数一定要和前端传递的参数名保持一致，否则就获取不到参数的值了

@Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/getuserbyid")
        public UserInfo getUserById(Integer id) {
           //两种命名方式 getUserById | findUserById
            // 不查数据库，伪代码，返回用户对象
            UserInfo userInfo = new UserInfo();
            userInfo.setId(id);
            userInfo.setUsername("张三");
            userInfo.setAge(18);
            return userInfo;
        }
    }

![在这里插入图片描述][d4b5c53cc9234d158f2420696b7a31c9.png]

## 2. 获取多个参数 ##

@Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/login")
        public String login(String username, String password) {
        
            return "用户名: " + username + " | 密码: " + password;
        }
    }

![在这里插入图片描述][08af98e257fc47e1b946d797059d1f8b.png]

## 3. 获取对象 ##

如果要获取的参数很多的话，也可以按照第二种方法来写，但是从代码的美观和维护角度来看，就不太建议这样来写了  
**Spring MVC 可以自动实现参数对象的赋值**

@Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/reg")
        public String reg(UserInfo userInfo) {
        
            return "用户信息：" + userInfo;
        }
    }

![在这里插入图片描述][f0c1d8e83d104708af56213e757100d1.png]

## 4. 后端参数重命名 @RequestParam ##

有些特殊情况下，前端传递的参数 key 和我们后端接收的 key 可以不一致，比如前端传递了一个 time 给后端，而后端又是用 createtime 字段来接收的，这样就会出现参数接收不到的情况，如果出现这种情况，**我们就可以使用 @RequestParam 来重命名前后端的参数值**

@Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/login")
        public String login(@RequestParam(value = "name", required = false) String username, String password) {
        
            return "用户名: " + username + " | 密码: " + password;
        }
    }

![在这里插入图片描述][3d7bfea6b26e460e9e0959bead6db033.png]

![在这里插入图片描述][73c04ce12ad044ccaedb8082c4c4b882.png]

## 5. 接收 JSON 格式的数据 @RequestBody ##

服务器端实现 JSON 数据的接收需要使用 @RequestBody 注解

@Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/reg")
        public String reg(@RequestBody UserInfo userInfo) {
        
            return "用户信息：" + userInfo;
        }
    }

![在这里插入图片描述][24c5d2e2b4004ba395fe697f178bfa9f.png]

## 6. 从 URL 地址中获取参数 @PathVariable ##

@Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/hero/{id}/{name}")
        public String getHeroInfo(@PathVariable String id, @PathVariable String name) {
        
            return "ID:" + id + " | Name: " + name;
        }
    }

![在这里插入图片描述][1adc09906cf14b79afa96666f02bd94d.png]

## 7. 上传文件 @RequestPart ##

@Slf4j
    @Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/upimg")
        public boolean upImg(Integer uid, @RequestPart("img") MultipartFile file) {
        
            boolean result = false;
            // 保存图片到本地目录
            try {
        
                file.transferTo(new File("D:/IDEA/img.png"));
                result = true;
            } catch (IOException e) {
        
                log.error("上传图片失败: " + e.getMessage());
            }
            return result;
        }
    }

![在这里插入图片描述][73e5e4fcb58541398270175241eda983.png]

文件上传，这样还有一个问题，这里上传文件到的目录是写为固定了的，那么比如说张三上传图片到这个位置，李四上传另一个图片也是到这个位置，**李四的图片就会把张三的图片覆盖了**，所以说就会有这样的一个问题

针对这个问题可以对上面的代码进行改进，主要就是这三个方面  
![在这里插入图片描述][cc887bccef024a6aa2de5b497dfd44ea.png]

**（1）解决目录问题：不同平台的配置文件设置**  
  比如说在开发环境，需要将上传的文件保存到这个目录，但在生产环境中又需要将文件保存到 Linux 中的某个目录上，如果在开发时写了很多个需要上传文件的目录，那么到项目上线时，需要修改到 Linux 目录，是极为麻烦的，所以这就需要进行**不同平台的配置文件设置**  
![在这里插入图片描述][827c2ecef4a44b48bffedb91bfb6ebb0.png]  
**application-dev.yml**

# 开发环境的配置文件
    
    # 图片保存的路径
    img:
      path: D:/IDEA/

**application-prod.yml**

# 生产环境的配置
    
    # 图片保存的路径
    img:
      path: /root/img/

**application.yml**

# 设置配置文件的运行平台
    spring:
      profiles:
        active: dev

**UserController.java**

如果 application.yml 中设置的配置文件运行平台是开发环境，也就是 application-dev.yml，运行程序可以看到  
![在这里插入图片描述][a3ec839ad4e24d769ddd4b6132c3b03a.png]  
反之如果在 application.yml 中设置为生产环境，运行程序  
![在这里插入图片描述][feac3eb4462d4daa84ef5bb1556d5b6b.png]  
  
  
**（2）生成图片名称：UUID**  
![在这里插入图片描述][848b020ad3674f3c8f01e779ddc146ab.png]

**（3）获取原图片的上传格式：获取原文件名称，并根据原文件名称的后缀，来截取 “.” 后面的字符**

@Slf4j
    @Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        // 从配置文件中读取图片的保存路径
        @Value("${img.path}")
        private String imgPath;
    
        @RequestMapping("/upimg")
        public boolean upImg(Integer uid, @RequestPart("img") MultipartFile file) {
        
            boolean result = false;
            // 1.目录=imgPath
            // 2.图片名称（图片名称不能重复，如果重复就会把重名的图片覆盖）【UUID】
            // 3.获取原上传图片的格式(获取原文件名称，并根据原文件名称的后缀，来截取 “.” 后面的字符)
            String fileName = file.getOriginalFilename(); // 得到原图片的名称（xxx.png）
            fileName = fileName.substring(fileName.lastIndexOf(".")); // 得到图片后缀 (png)
            fileName = UUID.randomUUID().toString() + fileName; //UUID + 后缀格式
    
            // 保存图片到本地目录
            try {
        
    //            file.transferTo(new File("D:/IDEA/img.png"));
                file.transferTo(new File(imgPath+fileName));
                result = true;
            } catch (IOException e) {
        
                log.error("上传图片失败: " + e.getMessage());
            }
            return result;
        }
    }

可以看到这里使用 Postman，多点几次 Send，每次上传图片的名字是不同的  
![在这里插入图片描述][8edd3a917eeb4628b21578aa59a33d86.png]

## 8. 获取Cookie (@CookieValue)/Session/header ##

### 8.1 获取 Request 和 Response 对象 ###

因为 Spring MVC是基于 Servlet 的，所以这里可以直接写

@Slf4j
    @Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/sayhi")
        public String sayHi(HttpServletRequest request) {
        
            return "66666" + request.getParameter(("name"));
        }
    }

![在这里插入图片描述][4e39e9d2df644e2f9a10e9e98cc4eb7d.png]

### 8.2 获取 Cookie ###

**（1）Servlet 获取 Cookie 的方法**

@Slf4j
    @Controller
    @ResponseBody   // 作用: 表示的是返回一个非静态页面的数据
    @RequestMapping("/user")  // 类上的 RequestMapping 可以省略
    public class UserController {
        
    
        @RequestMapping("/cookie")
        public void getCookie(HttpServletRequest request) {
        
            // 得到全部 Cookie
            Cookie[] cookies = request.getCookies();
            for (Cookie item : cookies) {
        
                log.info("Cookie Name:" + item.getName() + " | Cookie Value: " + item.getValue());
            }
        }

**（2）使用 @CookieValue 注解实现 Cookie 的读取**

@RequestMapping("/cookie2")
        public String getCookie2(@CookieValue("666")String cookie) {
        
            return "Cookie Value: " + cookie;
        }

### 8.3 获取 Header（请求头）里面的信息 ###

**（1）Servlet 获取 Header 的方法**

@RequestMapping("getua")
        public String getHead(HttpServletRequest request) {
        
            return "header: " + request.getHeader("User-Agent");
        }

![在这里插入图片描述][bcd6b4913d2d4c898990e852b719805d.png]  
**（2）使用 @RequestHeader 注解实现 Header 的获取**

@RequestMapping("getua2")
        public String getHead(@RequestHeader("User-Agent")String userAgent) {
        
            return "header: " + userAgent;
        }

![在这里插入图片描述][ab1dd06cd3274ef4b6661edf43fa341d.png]

### 8.4 存储和获取 Session ###

**（1）Session 存储和 Servlet 类似，是使⽤ HttpServletRequest 中获取的**

@RequestMapping("/setsess")
        public boolean setSession(HttpServletRequest request) {
        
            boolean result = false;
            // 1.得到 HttpSession
            // true =》 如果没有会话，那就创建
            HttpSession session = request.getSession(true);
            // 2.使用 setAtt 设置值
            session.setAttribute("userinfo","userinfo");
            result = true;
            return result;
        }

![在这里插入图片描述][6ecf36deb467438ebd0307b40c71d322.png]

**（2）获取 Session 方法1（Servlet 模式）**

@RequestMapping("/getsess")
        public String getSession(HttpServletRequest request) {
        
            String result = null;
            // 1. 先得到HttpSession 对象
            HttpSession session = request.getSession(false);
            // 2. getAttribute 得到 Session 信息
            if(session != null && session.getAttribute("userinfo") != null) {
        
                result = (String) session.getAttribute("userinfo");
            }
            return result;
        }

![在这里插入图片描述][b8baa89398af4805a669beb52e02aa79.png]

**（3）获取 Seesion 方法2：@SessionAttribute**  
通常情况下需要添加 required = false ，如果不添加，那么当 session 中不存在此属性的时候程序运行就会报错

@RequestMapping("/getsess2")
        public String getSession2(@SessionAttribute(value = "userinfo",
        required = false)String userinfo) {
        
            return "会话：" + userinfo;
        }

[d4b5c53cc9234d158f2420696b7a31c9.png]: https://img-blog.csdnimg.cn/d4b5c53cc9234d158f2420696b7a31c9.png
[08af98e257fc47e1b946d797059d1f8b.png]: https://img-blog.csdnimg.cn/08af98e257fc47e1b946d797059d1f8b.png
[f0c1d8e83d104708af56213e757100d1.png]: https://img-blog.csdnimg.cn/f0c1d8e83d104708af56213e757100d1.png
[3d7bfea6b26e460e9e0959bead6db033.png]: https://img-blog.csdnimg.cn/3d7bfea6b26e460e9e0959bead6db033.png
[73c04ce12ad044ccaedb8082c4c4b882.png]: https://img-blog.csdnimg.cn/73c04ce12ad044ccaedb8082c4c4b882.png
[24c5d2e2b4004ba395fe697f178bfa9f.png]: https://img-blog.csdnimg.cn/24c5d2e2b4004ba395fe697f178bfa9f.png
[1adc09906cf14b79afa96666f02bd94d.png]: https://img-blog.csdnimg.cn/1adc09906cf14b79afa96666f02bd94d.png
[73e5e4fcb58541398270175241eda983.png]: https://img-blog.csdnimg.cn/73e5e4fcb58541398270175241eda983.png
[cc887bccef024a6aa2de5b497dfd44ea.png]: https://img-blog.csdnimg.cn/cc887bccef024a6aa2de5b497dfd44ea.png
[827c2ecef4a44b48bffedb91bfb6ebb0.png]: https://img-blog.csdnimg.cn/827c2ecef4a44b48bffedb91bfb6ebb0.png
[a3ec839ad4e24d769ddd4b6132c3b03a.png]: https://img-blog.csdnimg.cn/a3ec839ad4e24d769ddd4b6132c3b03a.png
[feac3eb4462d4daa84ef5bb1556d5b6b.png]: https://img-blog.csdnimg.cn/feac3eb4462d4daa84ef5bb1556d5b6b.png
[848b020ad3674f3c8f01e779ddc146ab.png]: https://img-blog.csdnimg.cn/848b020ad3674f3c8f01e779ddc146ab.png
[8edd3a917eeb4628b21578aa59a33d86.png]: https://img-blog.csdnimg.cn/8edd3a917eeb4628b21578aa59a33d86.png
[4e39e9d2df644e2f9a10e9e98cc4eb7d.png]: https://img-blog.csdnimg.cn/4e39e9d2df644e2f9a10e9e98cc4eb7d.png
[bcd6b4913d2d4c898990e852b719805d.png]: https://img-blog.csdnimg.cn/bcd6b4913d2d4c898990e852b719805d.png
[ab1dd06cd3274ef4b6661edf43fa341d.png]: https://img-blog.csdnimg.cn/ab1dd06cd3274ef4b6661edf43fa341d.png
[6ecf36deb467438ebd0307b40c71d322.png]: https://img-blog.csdnimg.cn/6ecf36deb467438ebd0307b40c71d322.png
[b8baa89398af4805a669beb52e02aa79.png]: https://img-blog.csdnimg.cn/b8baa89398af4805a669beb52e02aa79.png