文章目录

1. 什么是Spring MVC？
2. 如何创建Spring MVC项目？
3. 简单示例演示
4. 路由接口映射
- 4.1 @RequestMapping
- 4.2 @GetMapping和@PostMapping
5. 获取参数
- 5.1 获取单个参数
- 5.2 获取多个参数
- 5.3 获取对象
- 5.4 @RequestParam参数重命名
- 5.5 @ResquestBody接收JSON对象
- 5.6 @PathVariable获取URL中参数
- 5.7 @RequestPart上传文件
- 5.8 获取Request和Response对象
- 5.9 @RequestHeader获取Header
- 5.10 @CookieValue获取Cookie
- 5.11 Session的获取与存储
6. 返回数据
- 6.1 @ResponseBody返回数据
- 6.2 请求转发与请求重定向

1. 什么是Spring MVC？

Spring MVC是Spring框架的一个Web模块，是一种基于MVC模型的Web应用开发框架

那MVC是啥呢？

MVC是一种软件架构思想，它将软件系统分为模型，视图，控制器三个基本部分：

模型Model：处理程序数据逻辑的部分，通常负责在数据库中存取数据
视图View：程序中处理数据显示部分
控制器Controller：程序中处理用户交互的部分

在这里插入图片描述

MVC是思想，Spring MVC是对MVC思想的具体实现，且继承了Servlet API的Web框架，故在浏览器中输入url后，Spring MVC可以感知到用户的请求

2. 如何创建Spring MVC项目？

在之前创建Spring Boot项目的基础上，添加Spring Web依赖后，项目就变为Spring MVC项目了

在这里插入图片描述

学习Spring MVC的的以下三个功能：

连接的功能：将用户浏览器和Java程序绑定起来
获取参数的功能：获取用户访问时携带的参数
输出数据的功能：执行逻辑后，将程序执行结果返回给用户

3. 简单示例演示

//@Controller
//@ResponseBody //表示返回的是数据，不是页面
@RestController //@Controller + @ResponseBody
public class UserController {
    @RequestMapping("/hello") //注册接口映射
    public String printHello(){
        return "hello Spring MVC";
    }
}

在这里插入图片描述

类必须随着spring框架的启动而加载，所以加上@Controller注解交给容器管理

4. 路由接口映射

4.1 @RequestMapping

@RequestMapping 注解是用来注册路由接口映射的，也就是当用户输入url后，该请求能对应到程序中某个类的某个方法上

@RequestMapping可以修饰类也可以修饰方法，当修饰类+方法时，路由地址为类+方法的组合地址，直接修饰方法时，路由地址就是方法上的地址，上述的示例就是直接修饰方法的

上述例子是浏览器输入url发送请求的，该请求是get请求，那使用@RequestMapping注解可以接收到post请求吗?

我们使用postman模拟发送post请求

在这里插入图片描述

发现@RequestMapping也可以接收到post请求，所以@RequestMapping既可以接收到get请求，又可以接收到post请求

那如何才能让方法只接收到特定的请求（只接收post或者只接收get）呢？

我们只需要在@RequestMapping上添加另一个参数，请求类型

    @RequestMapping(value = "/hello",method = RequestMethod.POST) //注册接口映射

此时启动程序，再通过浏览器url访问

在这里插入图片描述

发现此时访问不了，那再通过postman模拟post请求
在这里插入图片描述

发现post请求依旧可以访问成功

4.2 @GetMapping和@PostMapping

方法上使用@GetMapping来进行路由映射，只能接收到get请求
方法上使用@PostMapping来进行路由映射，只能接收到post请求

@GetMapping("/hello")
public String printHello(){
    return "hello Spring MVC";
}

    @PostMapping("/hello")
    public String printHello(){
        return "hello Spring MVC";
    }

@GetMapping和@PostMapping只能加在方法上，不能加在类上

在这里插入图片描述

5. 获取参数

5.1 获取单个参数

    @RequestMapping("/test")
    public String print(String name){
        return "hello "+name;
    }

在这里插入图片描述

注意：传递参数的名称必须和方法里形参的名称对应起来

那不对应呢？发现获取不到参数
在这里插入图片描述

注意： 方法的形参类型尽量不要使用基础数据类型（int...），因为基础类型作为局部变量，当接收不到参数时，没有默认值，此时程序就会报错，使用包装类和引用类型，就算接收不到参数，它们都有对应的默认值，程序也不会报错

5.2 获取多个参数

    @RequestMapping("/login")
    //参数的顺序无关紧要，只要名称对的上即可
    public String login(String username,String password){
        return "login success "+username+" "+password;
    }

在这里插入图片描述

5.3 获取对象

@Data
public class User {
    private String username;
    private String password;
}

    @RequestMapping("/reg")
    public Object reg(User user){
        return user;
    }

在这里插入图片描述
注意：对象的属性名称也要和参数中的名称对应

在这里插入图片描述
说明：

如果返回的是一个对象，那框架自动将对象转为json返回
如果返回的字符串中有html元素，那框架自动将字符串解析为html返回

5.4 @RequestParam参数重命名

当用户传递的参数名称与后端方法的形参名称不对应时，我们可以对后端参数重命名

使用@RequestParam注解进行重命名：

    @RequestMapping("/login")
    public String login(@RequestParam("username") String name,@RequestParam("password") String word){
        return name+word;
    }

在这里插入图片描述

发现名称对应不上也可以获取到，设置了@RequestParam("username") name后，就说明从前端拿到参数username然后赋值到name上，此时前端如果参数名称为name，那此时也是获取不到的

在这里插入图片描述
但是此时加上@RequestParam后，就代表此参数是必须传递的，如果有参数没有传递的话，会报错

在这里插入图片描述

此时呢，为了避免少传参数报错，可以设置@RequestParam的的一个属性required，将其设置为false来代表可以不必须传递此参数

    @RequestMapping("/login")
    public String login(@RequestParam("username") String name,@RequestParam(value = "password",required = false) String word){
        return name+word;
    }

在这里插入图片描述

5.5 @ResquestBody接收JSON对象

先看使用普通方式能否接收到json格式的数据

    @RequestMapping("/login")
    public Object login(User user){
        return user;
    }

发现没有获取到json格式的数据
在这里插入图片描述

在参数前加上@RequestBody

    @RequestMapping("/login")
    public Object login(@RequestBody User user){
        return user;
    }

发现获取到json格式的数据了
在这里插入图片描述

5.6 @PathVariable获取URL中参数

此时获取到URL中的参数是获取到带层次的资源路径，而不是查询字符串，前面获取的参数都属查询字符串

在这里插入图片描述
此时@RequestMapping的映射地址有所改变

    //获取带层次的资源路径
    @RequestMapping("/login/{username}/{password}")
    public String login(@PathVariable String username,@PathVariable String password){
        return username+" "+password;
    }

在这里插入图片描述
注意：加上@PathVariable后，参数也是必传的，同样也可设置required参数为false来保证非必传

    @RequestMapping("/login/{username}/{password}")
    public String login(@PathVariable String username,@PathVariable(required = false) String password){
        return username+" "+password;
    }

5.7 @RequestPart上传文件

接收文件类型，必须使用MultipartFile类型，该类提供了tranferTo方法（传输），可直接将文件保存在本地路径

    //上传文件
    @RequestMapping("/getFile")
    public void getFile(@RequestPart("file") MultipartFile file) throws IOException {
        file.transferTo(new File("D:\\photo\\file.jpg"));
    }

在这里插入图片描述
可以在配置文件中设置上传文件的最大大小，防止文件过大上传失败

# 设置最大文件的大小，默认为1MB
spring.servlet.multipart.max-file-size=50MB
# 设置最大请求大小，默认为10MB
spring.servlet.multipart.max-request-size=50MB

如何创建唯一的文件保存路径？

    @RequestMapping("/getFile")
    public void getFile(@RequestPart("file") MultipartFile file) throws IOException {
        //获取上传的文件名称
        String fileName = file.getOriginalFilename();
        //获取文件后缀名 .xxx
        String suffix = fileName.substring(fileName.lastIndexOf("."));
        //创建唯一标识
        UUID uuid = UUID.randomUUID();
        fileName = uuid+suffix;
        file.transferTo(new File("D:\\photo\\"+fileName));
    }

在这里插入图片描述

5.8 获取Request和Response对象

Request和Response已经内置在框架中，我们可以直接在方法的参数中用，我们可以使用这两个对象像在Servlet中一样，可以干许多事

    //获取Request和Response
    @RequestMapping("/getReqResp")
    public void getReqResp(HttpServletRequest req,HttpServletResponse resp){
        Cookie[] cookies = req.getCookies();
        String userAgent = req.getHeader("User-Agent");
    }

5.9 @RequestHeader获取Header

    @RequestMapping("/header")
    public String getHeader(@RequestHeader(value = "User-Agent",required = false) String userAgent){
        return userAgent;
    }

此时也可以设置required属性为false为非必传，否则必须传递，如果没有找到名为User-Agent的header，那程序会报错

5.10 @CookieValue获取Cookie

使用@CookieValue获取指定的Cookie

    @RequestMapping("/getCookie")
    public Object getCookie(@CookieValue(value = "user",required = false) String cookie){
        return cookie;
    }

此时也可以设置required属性为false为非必传，否则必须传递，如果没有找到名为user的cookie，那程序会报错

5.11 Session的获取与存储

Session的存储

Session的存储只能使用Request对象来存储

    //存储Session
    @RequestMapping("/setSession")
    public String setSession(HttpServletRequest req){
        HttpSession session = req.getSession(true);//没有就创建session
        session.setAttribute("user","张三");
        return "set success!";
    }

Session的获取

使用Request对象获取

    //获取Session
    @RequestMapping("/getSession")
    public String getSession(HttpServletRequest req){
        HttpSession session = req.getSession(false);
        String username = (String)session.getAttribute("user");
        return username;
    }

使用@SessionAttribute来获取Session

    //获取Session
    @RequestMapping("/getSession")
    public String getSession(@SessionAttribute(value = "user",required = false) String username){
       return username;
    }

此时也可以设置required属性为false为非必传，否则必须传递，如果没有找到名为user的session，那程序会报错

6. 返回数据

6.1 @ResponseBody返回数据

Spring MVC默认返回的是视图，也就是静态页面（xxx.html），但是现在都是前后端分离的项目，只需返回前端数据即可，故加上 @ResponseBody 表示返回的是数据

加上@ResponseBody后，如果返回的是一个对象，如Map，User，Student…，此时框架会自动将对象转换为JSON返回（相当于返回类型为application/json）
加上@ResponseBody后，如果返回的字符中带有html元素，如 “<h1>哈哈</h1>”，此时框架会自动将该字符串转换为html返回（相当于返回类型为text/html）

返回JSON对象：

    @RequestMapping("/test")
    @ResponseBody
    public Object test(){
        Map<String,Object> m = new HashMap<>();
        m.put("username","张三");
        m.put("age",18);
        return m;
    }

在这里插入图片描述

返回text/html：

    @RequestMapping("/test")
    @ResponseBody
    public String test(){
        return "<h1>哈哈</h1>";
    }

在这里插入图片描述

6.2 请求转发与请求重定向

forward：请求转发
redirect：请求重定向

请求转发：

    @RequestMapping("/forward")
    public String forward(){
        return "forward:/index.html";
    }

在这里插入图片描述

请求重定向：

    @RequestMapping("/redirect")
    public String redirect(){
        return "redirect:/index.html";
    }

在这里插入图片描述

请求转发与请求重定向的区别

请求转发是服务端行为，服务端收到请求后，会将请求转发到目标地址，再将目标地址返回的结果返回给客户端，请求转发一次请求，浏览器地址栏不改变
请求重定向是客户端行为，服务端收到请求后，会返回给客户端一个临时的响应头，响应头中包含了目标地址，此时客户端会重新向目标地址发请求，请求重定向两次请求，浏览器地址栏发生改变