【Spring MVC】这一篇，带你从入门到进阶

男娘i 2023-09-24 19:40 51阅读 0赞

**目录**

1、什么是MVC？

2、什么是 Spring MVC

3、如何学好 Spring MVC？

3.1、如何创建 Spring MVC 项目

3.1.1、使用Spring Initializr创建（推荐）

3.2、将 Spring 程序与用户（浏览器）联通

3.3、基础注解

3.3.1、@RequestMapping

3.3.2、GET/POST方法、

3.4、获取参数注解

3.4.1、传递单个/多个参数

3.4.2、传递对象

3.4.3、参数重命名 @RequestParam

3.4.4、接收 JSON 对象 @RequestBody

3.4.5、获取URL中参数 @PathVariable

3.4.6、上传文件 @RequestPart

3.5.7、获取Cookie数据 @CookieValue

更简单的读取Cookie数据如下方式：

3.4.8、存储Session数据

3.4.9、读取Session数据 @SessionAttribute

更简单的读取Session数据如下方式：

3.5、返回其他格式的数据

3.5.1、返回静态页面

3.5.2、返回单个JSON对象

3.5.3、返回多个JSON对象

--------------------

# 1、什么是MVC？ #

--------------------

MVC是 Model View Controller 的缩写，是一种软件设计模式，将软件分为模型、视图和控制器三部分，大体工作流程：**客户端向服务器发起请 HTTP 请求，被 Controller 接收，从 Model 中请求信息（通常模型对象负责在数据库中存取数据），并将响应信息返回给 Controller，接着交由给 View 显示数据，最后将 HTTP 响应传递给用户。**

![4d89e3a54ae04323a94535fe02967739.png][]

# 2、什么是 Spring MVC #

--------------------

简单来说，**是一个构建在 Servlet(API)之上，来自于 Spring Web 模块的的 Web框架（HTTP）**；

通常我们所说的 SSM 就等于 Spring + Spring MVC + MyBatis，后来又有了一种更新的说法：**SSM = Spring Boot + Spring Web(Spring MVC) + MyBatis**。

# 3、如何学好 Spring MVC？ #

--------------------

想要学好 Spring MVC 需要掌握以下3个功能：

1.连接功能：将用户（浏览器）和 Java 程序连接起来，也就是访问一个能够调用 Spring 程序的地址；

2.获取参数功能：用户访问时会带一些参数（例如 query string），在程序中想办法获取参数。

3.输出数据功能：根据请求计算响应，将响应结果返回给用户。

## 3.1、如何创建 Spring MVC 项目 ##

### 3.1.1、使用Spring Initializr创建（推荐） ###

a）如果你是使用的IDEA社区版，需要安装以下插件（不是社区版可以跳过此步骤）

所需插件：Spring Boot Helper（如下图）

![35bbd4b2f24541c6940e2949d2b660c6.png][]

**注意：此插件在IDEA社区版2022.1.x之前都免费，IDEA社区版2022.2.x之后开始收费，所以IDEA社区版版本的选择，大家自行选择。**

这个插件就是用来构建 Spring Boot 框架的，之后，你在创建一个项目的时候可以看到这样一个选项（就是通过来创建Spring Boot框架），如下图：

![b7301181b5874c12a4586b28dcb5b5b0.png][]

b）接下来就是创建Spring-MVC项目的步骤：

![8fd6b460be4c45ffa3d53265681239b6.png][]

![da0bf8efc5e5485a852e15669be63ab4.png][]

![cff050ebf431488696049a0abf587fda.png][]

**关键是要选择Spring Web选项，这里就包含了MVC，如下：**

![48b1b87d3f34444885c5301a0857bcb0.png][]

最后一路Next即可，最终目录结构如下：

![077b9b66cf4046f09bdeb3737d56c9cf.png][]

如果你得到了上图这个目录结构，**说明你的项目已经创建好了，但是还没有初始化，**因此还需要以下步骤：

![616f0ff3f7df45989a7d993ee46daf29.png][]

![414435f7fcf946bf9486260f1ff30b32.png][]

然后点击OK，接着就是一个，漫长的等待过程，当你的项目出现了下图变化，才说明你的Spring-Boot项目已经创建并初始化完成：

![9b7bb21bc6ba49b4a591babdd3af7088.png][]

## 3.2、将 Spring 程序与用户（浏览器）联通 ##

具体代码如下：

import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller //让 Spring 项目启动时，将这个注解下的类加载到容器中
    @ResponseBody //使其返回的响应是数据，而非页面
    @RequestMapping("/user") //注册路由
    public class UserController {
    
        @RequestMapping("/hi") //路由注册
        public String sayHi() {
            return "hi! Spring MVC!";
        }
    
    }

输入URl即可访问到sayHi方法，如下结果：

![28aebe026fa648ea9a6a29ae97be7d19.png][]

## 3.3、基础注解 ##

### 3.3.1、@RequestMapping ###

@RequestMapping 是⽤来注册接⼝的路由映射的，**当用户输入一个url，就可以通过url访问程序某个类的某个方法（@RequestMapping 即可修饰类，也可以修饰⽅法**，当修饰类和⽅法时，访问的地址是类 + 方法。），如下图：

![c6b7d8fa32c14d0890553ca08233674d.png][]

### 3.3.2、GET/POST方法、 ###

可以通过 @RequestMapping 或 @GetMapping/@PostMapping 获取请求的数据。

get请求的写法有如下三种：

// 写法1
    @RequestMapping("/index")
    
    // 写法2
    @RequestMapping(value = "/index",method = RequestMethod.GET)
    
    // 写法3
    @GetMapping("/index")

post请求的写法有如下两种：

// 写法1
    @RequestMapping(value = "/index",method = RequestMethod.POST)
    
    // 写法2
    @PostMapping("/index")

## 3.4、获取参数注解 ##

Spring MVC中可以直接通过方法中的参数来传参，要注意的有以下几点：

> Ps：
> 
> 1、当有多个参数进行参数匹配时，是按照参数的名称进行匹配的，因此参数的位置不影响参数的获取；
> 
> 2、Spring MVC 中通过前端传参时，方法的参数一定要是包装类类型，而非基础类型（因为如果方法的参数是基础类型，但又忘记传递时，程序就会报500错误，而保证类型为包装类类型忘记传参时，只会值为null）；

### 3.4.1、传递单个/多个参数 ###

由于传递单个和多个参数的写法方式一样，所以这里就以多参数为例~

代码如下：

import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller //让 Spring 项目启动时，将这个注解下的类加载到容器中
    @ResponseBody //使其返回的响应是数据，而非页面
    @RequestMapping("/user") //注册路由
    public class UserController {
    
        @RequestMapping("/message")
        public void getUserMessage(String name, String age) {
            System.out.println("name:" + name);
            System.out.println("age:" + age);
        }

方法参数对应 url 中 query string 的 key 值，如下使用 Postman 访问方法：

![7e6680df9d7e40b1abcc855f25824228.png][]

执行结果如下：

![2de11048e1d24311827391a715bee3c8.png][]

> 值得一提的是，以上这种后端的参数写法也支持另一种数据格式的传输，如下：
> 
> ![50a198578bdc4a4480e0d90c0ce4853b.png][]
> 
> Fiddler抓包请求：
> 
> ![1303501e6f094d71b6dfd86433942ff4.png][]

### 3.4.2、传递对象 ###

在 Spring MVC 中可以创建一个实体类对象（含getter和setter方法），最后通过方法的参数对象的getter方法获取属性。

如下实体类对象：

@Controller //让 Spring 项目启动时，将这个注解下的类加载到容器中
    @ResponseBody //使其返回的响应是数据，而非页面
    @RequestMapping("/user") //注册路由
    public class UserController {
    
        @RequestMapping("/message")
        public void getMessage(User user) {
            
            System.out.println("id:" + user.getId());
            System.out.println("name:" + user.getName());
            System.out.println("age:" + user.getAge());
            
        }
        
    }

前端访问：

![24ee62a9eeec4f8e8e862225fe0c0d91.png][]

执行结果：

![0b9654373032444fbe9c1ea910b190ab.png][]

### 3.4.3、参数重命名 @RequestParam ###

**情况一：必传参数设置**

有些情况下，前端传递的参数 key 的字段和后端接收的 key 的字段可以不一致，例如前端传输一个 time ，**后端就可以使用 @RequestParam 来重命名后端的参数为 startTime** 字段来接收。

例如前端两个参数key字段分别为t1,t2，后端使用 startTime 和 endTime 字段来接收如下代码：

import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller //让 Spring 项目启动时，将这个注解下的类加载到容器中
    @ResponseBody //使其返回的响应是数据，而非页面
    @RequestMapping("/user") //注册路由
    public class UserController {
    
        @RequestMapping("/time")
        public void getTime(@RequestParam("t1") String startTime,
                            @RequestParam("t2") String endTime) {
            System.out.println("起始时间:" + startTime);
            System.out.println("结束时间" + endTime);
        }
    
    }

前端访问地址如下：

![9b00e35010084ee0ab93f11226d102ad.png][]

执行结果：

![9fdff72818b74b798c656d916c768b76.png][]

**情况二：非必传参数设置**

情况一中，若前端传递了一个非time的参数，程序就会出现报错的情况，我们可以通过设置 @RequestParam 中的 required=false 来避免不传递时报错，具体实现如下：

@RequestMapping("/time")
        public void getTime(@RequestParam(value = "t1", required = false) String startTime,
                            @RequestParam(value = "t2", required = false) String endTime) {
            System.out.println("起始时间:" + startTime);
            System.out.println("结束时间" + endTime);
        }

### 3.4.4、接收 JSON 对象 @RequestBody ###

代码如下：

import com.example.demo.model.User;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller //让 Spring 项目启动时，将这个注解下的类加载到容器中
    @ResponseBody //使其返回的响应是数据，而非页面
    @RequestMapping("/user") //注册路由
    public class UserController {
    
        @PostMapping("/message")
        public String getMessage(@RequestBody User user) {
            return user.toString();
        }
    
    }

前端发送请求，结果如下：

![e3dd2949d86c4283aef24351aa93af51.png][]

> Ps：注意这里传递的是JSON对象，向后端提交数据，需要搭配着POST请求。

### 3.4.5、获取URL中参数 @PathVariable ###

前端地址：

![bba11b3e7837430797ba2b3f5eba3cc7.png][]

后端接收：

@PostMapping("/urlValue/{name}/{age}")
        public String getUrlValue(@PathVariable("name") String name,
                                  @PathVariable("age") String age) {
            return "name:" + name + ", age:" + age;
        }

执行结果：

![e7d0696829b04247b83c5a3c7fb75f21.png][]

注意：以上写法@PostMapue/\{name\}/\{ageping("/urlVal\}")中\{name\}和\{age\}是必须要传的参数，若只传age，不传name，则可以使用如下写法：

@PostMapping("/urlValue/{name}/{age}")
        public String getUrlValue(@PathVariable(value = "name", required = false) String name,
                                  @PathVariable("age") String age) {
            return "name:" + name + ", age:" + age;
        }

> Ps：
> 
> 1.需要获取的参数要在 @PostMapping 注解中用大括号\{\}括起来。
> 
> 2.这种写法的URl对比之前的 query string 在SEO上效果更好（浏览器搜索以后会排在更前面）！

### 3.4.6、上传文件 @RequestPart ###

前端通过from表单请求的请求文件数据：

![59833ba6ced345fabd906f26e4e6ff7d.png][]

后端接收：

@PostMapping("/upfile")
        public String upfile(@RequestPart("myfile") MultipartFile file) throws IOException {
            String path = "D:\\其他\\滑稽2.webp";
            file.transferTo(new File(path));
            return path;
        }

### 3.5.7、获取Cookie数据 @CookieValue ###

由于 Spring MVC（Spring Web）是基于 Servlet 实现的，所以获取 Cooike 数据也是通过 HttpServletResponse 的 getCookie 方法获取到的，如下后端代码（这里为了方便观察结果，使用 @Slf4j 来打印日志信息）：

@GetMapping("/getCookie")
        public String getCookie(HttpServletRequest request) {
            Cookie[] cookies = request.getCookies();
            for(Cookie ans : cookies) {
                log.error("key:" + ans.getName() + ",value:" + ans.getValue());
            }
            return "get Cookie Success!";
        }

前端可以通过F12检测里的Application中的Cookie自定义数据，如下：

![c0bfd1b58300495da83d0657e0e8b2be.png][]

前端请求如下：

![debf95cdb8344f099204a3898c956cc5.png][]

访问结果：

![5900ba96c43e4bb3a3f42e433bf52d7b.png][]

### 更简单的读取Cookie数据如下方式： ###

@RequestMapping("/cookie")
    @ResponseBody
    
    public String cookie(@CookieValue("zhangsan") String name) {
         return "cookie：" + name;
    }

> Ps：如果 zhangsan 这个参数是一个非必要的参数，那么也可以再在@CookieValue注解后面加上一个false参数；

### 3.4.8、存储Session数据 ###

由于 Spring MVC（Spring Web）是基于 Servlet 实现的，所以获取 Session 数据也是通过 HttpServletResponse 的 getSesion 方法获取到的，如下后端代码：

@RequestMapping("setSession")
        public String setSession(HttpServletRequest request) {
            HttpSession session = request.getSession(true);
            session.setAttribute("jay chou", "nb");
            return "set Session Success!";
        }

前端请求：

![9f5c4676e3c84c72b577aacdfb2ba5bd.png][]

### 3.4.9、读取Session数据 @SessionAttribute ###

由于 Spring MVC（Spring Web）是基于 Servlet 实现的，所以获取 Session 数据也是通过 HttpServletResponse 的 getSesion 方法获取到的，如下后端代码：

@RequestMapping("getSession")
        public String getSession(HttpServletRequest request) {
            HttpSession session = request.getSession(false);
            if(session == null || session.getAttribute("jay chou") == null) {
                return "当前会话参数错误";
            }
            return "get Session Success!";
        }

前端先通过2.5.7中的后端代码存储Session数据，就可以观察到生成如下SessionId：

![6143497d96064c46af6a8d4ded492d7b.png][]

再进行前端访问就可以得到如下结果：

![5fd8b9d8eb2f4ee7be469bec9c1e1bca.png][]

### 更简单的读取Session数据如下方式： ###

@RequestMapping("getSessionEasy")
        public String getSession(@SessionAttribute(value = "jay chou", required = false) String name) {
            return name;
        }

> Ps：这里表示 jay chou 这个字符串是一个非必要参数，去掉false参数他就是一个必要参数。

## 3.5、返回其他格式的数据 ##

### 3.5.1、返回静态页面 ###

Spring MVC 和 Spring Boot 默认情况下都是返回View视图（xxx.html），通过@ResponseBody注解就可以让后端返回的是数据，而非页面。那么如果现在需要返回一个页面，我们应该怎么做？

a）创建一个前端页面 index.html

![5bc7f299fc904b8fa95fa59c776d2ab1.png][]

前端代码如下：

<!doctype html>
    
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport"
    
              content="width=device-width, user-scalable=no, initial-scale=1.
    0, maximum-scale=1.0, minimum-scale=1.0">
        <meta http-equiv="X-UA-Compatible" content="ie=edge">
        <title>hello,spring mvc</title>
        <script src="index.js"></script>
    </head>
    <body>
        <h1>Hello,Spring MVC.</h1>
    </body>
    </html>

后端代码如下：

@Controller
    @RequestMapping("/html")
    public class IndexController {
    
        @RequestMapping("/index")
        public String retIndex() {
            //执行业务逻辑...
            return "/index.html";
        }
    
    }

客户发送请求后的结果：

![20ab749cca334028a1e82793f0e7589e.png][]

### 3.5.2、返回单个JSON对象 ###

在 Spring MVC 中返回 HashMap 对象，实际上就是在返回JSON对象，如下后端代码：

@RequestMapping("getJson")
        public HashMap<String, Integer> resJson() {
            HashMap<String, Integer> map = new HashMap<>();
            map.put("zhangsan", 1);
            map.put("lisi", 2);
            map.put("wangwu", 3);
            return map;
        }

客户端输入url得到如下结果：

![bc0d24459fa142848ab0fa98deeaa030.png][]

### 3.5.3、返回多个JSON对象 ###

通过使用泛型为实体类的 List 作为返回值（**注意要在类上加 @RestController 或 @ResponseBody 注解，或者在对应方法上使用 @ResponseBody 注解**），就可以实现多个 JSON 对象返回给前端，如下后端代码示例：

@ResponseBody
        public List<Blog> getBlogList() throws JsonProcessingException {
            List<Blog> list = blogService.getBlogListById();
            return list;
        }

![2a85fc99d26f465ca5642d578e44eb85.gif][]

[4d89e3a54ae04323a94535fe02967739.png]: https://img-blog.csdnimg.cn/4d89e3a54ae04323a94535fe02967739.png
[35bbd4b2f24541c6940e2949d2b660c6.png]: https://img-blog.csdnimg.cn/35bbd4b2f24541c6940e2949d2b660c6.png
[b7301181b5874c12a4586b28dcb5b5b0.png]: https://img-blog.csdnimg.cn/b7301181b5874c12a4586b28dcb5b5b0.png
[8fd6b460be4c45ffa3d53265681239b6.png]: https://img-blog.csdnimg.cn/8fd6b460be4c45ffa3d53265681239b6.png
[da0bf8efc5e5485a852e15669be63ab4.png]: https://img-blog.csdnimg.cn/da0bf8efc5e5485a852e15669be63ab4.png
[cff050ebf431488696049a0abf587fda.png]: https://img-blog.csdnimg.cn/cff050ebf431488696049a0abf587fda.png
[48b1b87d3f34444885c5301a0857bcb0.png]: https://img-blog.csdnimg.cn/48b1b87d3f34444885c5301a0857bcb0.png
[077b9b66cf4046f09bdeb3737d56c9cf.png]: https://img-blog.csdnimg.cn/077b9b66cf4046f09bdeb3737d56c9cf.png
[616f0ff3f7df45989a7d993ee46daf29.png]: https://img-blog.csdnimg.cn/616f0ff3f7df45989a7d993ee46daf29.png
[414435f7fcf946bf9486260f1ff30b32.png]: https://img-blog.csdnimg.cn/414435f7fcf946bf9486260f1ff30b32.png
[9b7bb21bc6ba49b4a591babdd3af7088.png]: https://img-blog.csdnimg.cn/9b7bb21bc6ba49b4a591babdd3af7088.png
[28aebe026fa648ea9a6a29ae97be7d19.png]: https://img-blog.csdnimg.cn/28aebe026fa648ea9a6a29ae97be7d19.png
[c6b7d8fa32c14d0890553ca08233674d.png]: https://img-blog.csdnimg.cn/c6b7d8fa32c14d0890553ca08233674d.png
[7e6680df9d7e40b1abcc855f25824228.png]: https://img-blog.csdnimg.cn/7e6680df9d7e40b1abcc855f25824228.png
[2de11048e1d24311827391a715bee3c8.png]: https://img-blog.csdnimg.cn/2de11048e1d24311827391a715bee3c8.png
[50a198578bdc4a4480e0d90c0ce4853b.png]: https://img-blog.csdnimg.cn/50a198578bdc4a4480e0d90c0ce4853b.png
[1303501e6f094d71b6dfd86433942ff4.png]: https://img-blog.csdnimg.cn/1303501e6f094d71b6dfd86433942ff4.png
[24ee62a9eeec4f8e8e862225fe0c0d91.png]: https://img-blog.csdnimg.cn/24ee62a9eeec4f8e8e862225fe0c0d91.png
[0b9654373032444fbe9c1ea910b190ab.png]: https://img-blog.csdnimg.cn/0b9654373032444fbe9c1ea910b190ab.png
[9b00e35010084ee0ab93f11226d102ad.png]: https://img-blog.csdnimg.cn/9b00e35010084ee0ab93f11226d102ad.png
[9fdff72818b74b798c656d916c768b76.png]: https://img-blog.csdnimg.cn/9fdff72818b74b798c656d916c768b76.png
[e3dd2949d86c4283aef24351aa93af51.png]: https://img-blog.csdnimg.cn/e3dd2949d86c4283aef24351aa93af51.png
[bba11b3e7837430797ba2b3f5eba3cc7.png]: https://img-blog.csdnimg.cn/bba11b3e7837430797ba2b3f5eba3cc7.png
[e7d0696829b04247b83c5a3c7fb75f21.png]: https://img-blog.csdnimg.cn/e7d0696829b04247b83c5a3c7fb75f21.png
[59833ba6ced345fabd906f26e4e6ff7d.png]: https://img-blog.csdnimg.cn/59833ba6ced345fabd906f26e4e6ff7d.png
[c0bfd1b58300495da83d0657e0e8b2be.png]: https://img-blog.csdnimg.cn/c0bfd1b58300495da83d0657e0e8b2be.png
[debf95cdb8344f099204a3898c956cc5.png]: https://img-blog.csdnimg.cn/debf95cdb8344f099204a3898c956cc5.png
[5900ba96c43e4bb3a3f42e433bf52d7b.png]: https://img-blog.csdnimg.cn/5900ba96c43e4bb3a3f42e433bf52d7b.png
[9f5c4676e3c84c72b577aacdfb2ba5bd.png]: https://img-blog.csdnimg.cn/9f5c4676e3c84c72b577aacdfb2ba5bd.png
[6143497d96064c46af6a8d4ded492d7b.png]: https://img-blog.csdnimg.cn/6143497d96064c46af6a8d4ded492d7b.png
[5fd8b9d8eb2f4ee7be469bec9c1e1bca.png]: https://img-blog.csdnimg.cn/5fd8b9d8eb2f4ee7be469bec9c1e1bca.png
[5bc7f299fc904b8fa95fa59c776d2ab1.png]: https://img-blog.csdnimg.cn/5bc7f299fc904b8fa95fa59c776d2ab1.png
[20ab749cca334028a1e82793f0e7589e.png]: https://img-blog.csdnimg.cn/20ab749cca334028a1e82793f0e7589e.png
[bc0d24459fa142848ab0fa98deeaa030.png]: https://img-blog.csdnimg.cn/bc0d24459fa142848ab0fa98deeaa030.png
[2a85fc99d26f465ca5642d578e44eb85.gif]: https://img-blog.csdnimg.cn/2a85fc99d26f465ca5642d578e44eb85.gif