Spring Web MVC基础理论和使用

目录

什么是MVC

什么是SpringMVC

SpringMVC基础使用

建立连接

@RequestMapping介绍

请求

传递参数

传递对象

参数重命名

传递数组

传递JSON数据

获取URL中参数

上传文件

获取Cookie/Session

获取Header

响应

返回静态页面

 @RestController和@Controller的区别

返回数据@ResponseBody

设置状态码

---

什么是MVC

MVC是一种架构模式，全称是Model(模型) View(视图) Controller(控制) 

• Model(模型)：是应用程序的主体，用来存储数据和处理用户请求的业务逻辑。
• View(视图)：用来和浏览器交互的部分，展示模型中的数据，比如jsp和html
• Controller(控制) 用来接收视图发来的请求，将数据交给Model处理，并且将处理后的结果返回给视图

相当于用户通过浏览器输入数据，由View发送给Controller，在有Controller分发给对应Model板块对数据进行处理，之后，Model再把处理完的数据交给Controller，Controller可能对数据进行进一步封装，最后交给View，由View最后返回给用户展示。

什么是SpringMVC

SpringMVC和MVC并不是一个东西，MVC是一种架构思想，而SpringMVC则是实现这种思想的web框架，所以SpringMVC就是一个实现了MVC的Web框架

就好像是食物和饺子的关系，食物是能被人类使用的东西的统称，而饺子则是食物的具体实现，食物不光有饺子，还有其他实现，比如包子，汤圆，西湖醋鱼等

关于官方的定义是这样的

SpringWebMVC是基于ServletAPI构建的原始Web框架，从⼀开始就包含在Spring框架中。它的
正式名称“SpringWebMVC”来⾃其源模块的名称(Spring-webmvc)，但它通常被称为"Spring
MVC".

从这句话可以知道SpringMVC是Spring Framework的一部分，底层则是servlet

SpringMVC基础使用

我们在之前创建SpringBoot项目时，勾选的SpringWeb依赖其实就是SpringMVC

这时就有了一个问题SpringWeb和SpringMVC到底是什么关系

SpringBoot是一个自动化配置的工具，SpringMVC是一个Web框架

SpringBoot为SpringMVC提供了便捷的开发和部署方式，SpringMVC相当于是Spring框架的一部分，用于开发Web程序，而SpringBoot是基于Spring的框架，为了快速搭建Spring应用，SpringBoot只是实现SpringMVC的其中⼀种⽅式⽽已.所以这三个的关系可以理解为SpringBoot > Spring > SpringMVC.

Spring在实现MVC架构时做了一些调整，用户通过浏览器直接把数据发给Controller，之后由Model处理再返回给Controller，最后再返回通过View显示给用户。

建立连接

我们首先现在浏览器上输出一个hello world，在输出前我们要先建立和浏览器的连接，让浏览器可以找到我们运行的SpringMVC项目。

在SpringMVC里使用@RequestMapping来实现浏览器的URL路由映射，具体代码如下

@RestController
@RequestMapping("/test")
public class UserController {@RequestMapping("hello")public String test(){return "hello world";}
}

结果

@RequestMapping介绍

@RequestMapping里传的字符串就是浏览器搜索的url路径，@RequestMapping既可以用来修饰类也可以用来修饰方法，当当前类里即用@RequestMapping修饰了类又修饰了类里的方法，那么我们想要让浏览器访问该类里的方法时所使用的url路径就是(类修饰名+方法修饰名)。就和刚刚的例子一样，而且是类修饰在前，方法修饰在后。

@RequestMapping的URL路径最前⾯加不加/ (斜杠)都可以,Spring程序启动时,会进行判段，如果前面没有加/，Spring也会帮你拼接一个，不过一般也不加/

@RequestMapping的url路径也可以是多层的，但是最终访问路径依然是类路径+方法路径

@RestController
@RequestMapping("/test/test2")
public class UserController {@RequestMapping("hello1/hello2")public String test(){return "hello world";}
}

也可以只写方法路径，浏览器也可以访问到(但是不建议这样写)

@RestController
//@RequestMapping("/test/test2")
public class UserController {@RequestMapping("hello1/hello2")public String test(){return "hello world";}
}

@RequestMapping既可以接收所以类型的请求包括get/post，如果想要只接收某一种类型的请求可以使用对应的@GetMapping或者@PostMappping，使用方法和@RequestMapping一样，但是只能接收对应类型的请求，或者指定mothod方法

@RequestMapping(value = "/test/test2",method = RequestMethod.GET)

我们也可以点进这个注解看看

 

可以看到mothod返回的是一个枚举类型，而枚举的就是使用请求类型，同时如果我们想要设置两种方法就可以传入两个枚举类型

@RequestMapping(value = "/test/test2",method = {RequestMethod.GET,RequestMethod.POST})

请求

刚刚我们的例子里是直接把数据发送给浏览器，并没有从浏览器接收数据然后加工返回，在项目中发送来的请求很可能带有数据，那么我们就需要用对应的参数来接收。

在Servlet中我们通过request.getParameter(name)获取请求参数，当参数过多时代码会变得十分的臃肿，而SpringMVC则是通过参数注入的方式用于获取请求数据，即将请求参数直接封装到方法的参数当中。如果有了解过Servlet就会觉得这种方式对于开发者的开发来说十分的友好。

传递参数

@RestController
@RequestMapping(value = "test")
public class UserController {@RequestMapping("hello")public String test(String str){return str;}
}

成功返回

我们的路径127.0.0.1:8080/test/hello?str=hello，看以看到这里的参数名和我们方法的参数名是一样的，如果不一致则无法收到。

使⽤基本类型来接收参数时,参数必须传(除boolean类型),否则会报500错误类型不匹配时,会报400错误，反之包装类则不用。

@RestController
@RequestMapping("test")
public class UserController {@RequestMapping("hello")public String test(int num){return "num: " + num;}
}

 

当有多个参数时至于要在后面加上对应类型，切记名字一定要一样。

传递对象

处理传递基本数据类型外，SpringMVC还可以传递对象。SpringMVC可以实现自动给对象里的属性赋值，比如一个user对象里有一个name属性，浏览器只传了一个name=张三，那么SpringMVC就会从对象参数里的字段找和请求数据同名的字段，找到了就会直接赋值。

public class User {private String name;private String gender;private int age;
}
@RestController
@RequestMapping("test")
public class UserController {@RequestMapping("user")public String test(User user){return user.toString();}
}

看以看到我们只有name属性被赋值，而password因为没有找到有对应名字的字段所以无法赋值。

Spring会根据参数名称自动绑定到对象的各个属性上,如果某个属性未传递,则赋值为null(基本类型则赋值为默认初识值,比如int类型的属性,会被赋值为0)。

还可以接收关联对象

就是方法参数是一个对象，而这个对象里有一个属性也是一个对象

public class User {private String name;private String gender;private int age;private Phone phone;
}
public class Phone {private String type;private String color;private String phoneNum;
}
@RestController
@RequestMapping("test")
public class UserController {@RequestMapping("user")public String test(User user){return user.toString();}
}

 看以看到依然成功接收，规则也和之前一样，只不过有一个参数变成了对象

参数重命名

在之前传递参数的过程中都要求前端传递参数的参数名和我们的方法的参数名一致，但是如果不一致呢，或者说有没有不一致但是依然可以完成参数传递的方法呢？有的兄弟有的，只需要使用@RequestParam给参数重命名就行.

@RestController
@RequestMapping("test")
public class UserController {@RequestMapping("gender")public String test1(@RequestParam("sex") String gender){return "gender: " + gender;}
}

只需要@RequestParam里的参数的前端传来的参数一致就行，这样方法的参数就可以随意命名了。不过如果加了@RequestParam注解重命名，那么前端里的参数名就必须和@RequestParam里的一样，和方法里的参数名就没有关系了，换言之如果请求参数名只是和方法参数名和一样而和@RequestParam里的参数名不同，那么依然无法正确赋值。

传递数组

SpringMVC依然可以自动绑定 

@RestController
@RequestMapping("test")
public class UserController {@RequestMapping("array")public String array(String[] array){return Arrays.toString(array);}}

传递JSON数据

JSON:就是⼀种数据格式,有自己的格式和语法，使用文本表示⼀个对象或数组的信息，因此JSON本质是字符串，主要负责在不同的语言中数据传递和交换。

SpringMVC已经帮我们把JSON转换工具引入进来了，直接使用就行，如果脱离SpringMVC使用就需要引入依赖

<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.13.5</version>
</dependency>

 使用提供的ObjectMapper对象来进行JSON字符串得转化

• writeValueAsString()：把对象转化为JSON字符串
• readValue()：把JSON转化为对象

我们得服务器接收JSON对象，需要使用 @RequestBody 注解 

@RequestMapping("json")public Object json(@RequestBody User user){return user.toString();}

 使用PostMan来发送请求

 

成功返回数据

然后如果我们去掉@RequestBody呢

可以看到依然可以成功返回但是未能成功赋值

如果后端想要返回一个json数据也可以直接以HashMap的方式返回

获取URL中参数

使用@PathVariable注解就可以拿到url中的参数，默认传递参数写在url上，SpringMVC就可以获取

@RequestMapping("pathVal/{gender}/{newName}")public String pathVal(@PathVariable String gender,@PathVariable("newName") String name){return "gender: " + gender + "name: " + name;}

 

@PathVariable也具有重命名得功能，url路径里的参数需要和{}里的名字对应，同时也要和方法名对应(如果@PathVariable重命名了的话则要和重命名得参数名对应)

上传文件

使用注解@RequestPart

@RequestMapping("file")public String getFile(@RequestPart("file") MultipartFile file) throws IOException {//获取文件名String fileName = file.getOriginalFilename();//上传文件到指定路径file.transferTo((new File("D:/" + file.getOriginalFilename())));return "文件名：" + fileName;}

 MultipartFile是Spring封装得一个用来处理文件得接口，可以通过这个接口对文件进行一系列操作

看以看到文件成功上传到本地文件夹

获取Cookie/Session

获取Cookie

@RequestMapping("/cookie")public String demo1(HttpServletResponse response, HttpServletRequest request){// 获取所有 cookie 信息Cookie[] cookies = request.getCookies();//打印Cookie信息StringBuilder builder = new StringBuilder();if (cookies!=null){for (Cookie ck:cookies) {builder.append(ck.getName()+":"+ck.getValue());}}return "Cookie信息:"+builder;}

结果 

 我们也可以直接使用@CookieValue注解来获取cookie

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

 @CookieValue里的字符就对应这cookie里面的key

Session存储

@RequestMapping("/setSess")public String setsess(HttpServletRequest request) {// 获取Session对象 HttpSession session = request.getSession();if (session != null) {session.setAttribute("username", "java");}return "session 存储成功";}

通过 session.setAttribute来指定一个名称以键值对的方式绑定一个对象到session会话

HttpSession.getSession()，当参数为true时，当前如果不存在会话就会创建一个新的，如果参数为false，则当不存在会话时会返回null而不会创建新的会话(默认时true)

Session读取

@RequestMapping("/getSess")public String sess(HttpServletRequest request) {// 如果 session 不存在, 不会⾃动创建HttpSession session = request.getSession(false);String username = null;if (session != null && session.getAttribute("username") != null) {username = (String) session.getAttribute("username");}return "username：" + username;}

 

通过session.getAttribute方法来获取我们存储的session，只需要传入key，就可以返回之间存储的value值，不过这里返回的是一个Object对象，需要强转为我们需要的。

而且可以看到此时SessionID也存储在Cookie中。

通过@SessionAttribute注解获取session

@RequestMapping("/getSess2")
public String sess2(@SessionAttribute(value = "username",required = false) 
String username) {return "username："+username;
}

 @SessionAttribute注解就相当于getAttribute，通过传入的值来返回对应的对象，required表示可以为空

通过SpringMVC内置对象获取session

@RequestMapping("/getSess3")
public String sess3(HttpSession session) {String username = (String)session.getAttribute("username");return "username："+username;
}

使用方法依然和刚刚的getAttribute一样

获取Header

@RequestMapping("/header")public String header(HttpServletRequest request, HttpServletResponse response){String name = request.getHeader("name");return "name" + "："+ name;}

这里获取的就是http请求报头里的key-value，这里也可以直接使用@RequestHeader注解来获取，使用方法和getHeader一样这里就不演示了

响应

我们可以返回的响应结果并不只有我们处理的一些数据，还可以是静态页面，设置返回报头，状态码等信息。

返回静态页面

首先我们先创建一个html页面

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"><title>Index⻚⾯</title>
</head><body><h1>Hello,Spring MVC,这是Index⻚⾯</h1>
</body></html>

后端代码

@RestController
public class IndexController {@RequestMapping("/index")public Object index(){//返回index.html return "/index.html";}
}

运行

可以看到好像并不是我们预期的结果，我们应该返回的是一个html页面，现在我们将@RestController注解变成@Controller注解

@Controller
@RequestMapping("test2")
public class IndexController {@RequestMapping("/index")public Object index(){//返回index.htmlreturn "/index.html";}
}

这时我们就得到了我们想要的结果，那为什么呢

 @RestController和@Controller的区别

我们刚刚有提到，SpringMVC可以返回视图但是随着前后端分离，View不在返回视图，而是返回显示视图所需要的数据，而@RestController 其实是返回的数据

我们点开​​​​@RestController的源码可以发现，在里面不加封装了@Controller还封装了@ResponseBody.

所以可以这样说@RestController =@Controller +@ResponseBody

@Controller :定义⼀个控制器,Spring框架启动时加载,把这个对象交给Spring管理.
@ResponseBody :定义返回的数据格式为非视图,返回⼀个text/html信息

所以

• @RestController一般用来返回数据,这些数据报头中的Content-Type都是text/html格式的。
• @Controller一般用来返回视图.这个视图一般是用前端的代码写好的文件(视图view).

返回数据@ResponseBody

 刚刚我们直到@ResponseBody是用来返回数据的，如果给刚刚的代码加上一个@ResponseBody就又会把"index.html"当作字符串展示出来。

@ResponseBody注解既可以作用在类上又可以作用在方法上，作用在方法上就只影响当前方法，作用在类上就影响类里的所有方法，同理因为@RestController注解封装了@ResponseBody注解所以也具有类似特征。

如果一个类里既要返回视图又要返回数据该怎么做？很简单，在类上添加@Controller注解，给要返回数据的方法添加@ResponseBod注解，可以认为@ResponseBody的优先级大于@Controller注解。

设置状态码

可以直接通过SpringMVC的内置对象HttpServletResponse提供的方法来进行设置

@RequestMapping("/setStatus")@ResponseBodypublic String setStatus(HttpServletResponse response) {response.setStatus(400);return "设置状态码成功";}