SpringMVC学习笔记一
目录
- 一、SpringMVC概述
- 二、入门案例
-
- 1.导入相关依赖
- 2.配置web.xml
- 3.配置SpringMVC
- 4.创建测试用的html页面
- 5.编写Controller
- 三、请求映射规则@RequestMapping
-
- 1.@RequestMapping注解标识的位置
- 2.@RequestMapping注解value属性
- 3.@RequestMapping注解的method属性
- 4.@RequestMapping注解的params属性
- 5.@RequestMapping注解的headers属性
- 6.指定请求头Content-Type
- 7.SpringMVC支持ant风格的路径
- 四、RestFul风格
- 五、获取请求参数
-
- 5.1 获取路径参数
- 5.2 获取请求体中的Json格式参数
- 5.3 获取QueryString格式参数
- 六、 获取请求参数的几种方式
一、SpringMVC概述
- Spring 为展现层提供的基于 MVC 设计理念的优秀的 Web 框架，是目前最主流的MVC 框架之一。一种轻量级的、基于MVC的Web层应用框架。它能让我们对请求数据的出来，响应数据的处理，页面的跳转等等常见的web操作变得更加简单方便。
- SpringMVC支持多种视图技术，包括JSP、Thymeleaf、Freemarker等。可以选择最适合自己应用程序的视图技术，并使用视图解析器将模型数据渲染到相应的视图上。
1.MVC架构
SpringMVC采用了经典的MVC（Model-View-Controller）设计模式，将应用程序分为三个主要组件：
- Model：负责处理应用程序的数据逻辑和状态。
- View：负责渲染用户界面，并向用户展示数据。
- Controller：负责处理用户请求、调度任务和控制流程。
通过这种结构化的设计，开发人员可以更好地组织和维护代码，并实现良好的分离关注点。
二、入门案例
1.导入相关依赖
<dependencies>
<dependency>
<groupId>javax.servletgroupId>
<artifactId>javax.servlet-apiartifactId>
<version>3.1.0version>
<scope>providedscope>
dependency>
<dependency>
<groupId>org.thymeleafgroupId>
<artifactId>thymeleaf-spring5artifactId>
<version>3.0.12.RELEASEversion>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-webmvcartifactId>
<version>5.1.9.RELEASEversion>
dependency>
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-databindartifactId>
<version>2.9.0version>
dependency>
dependencies>
2.配置web.xml
DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Applicationdisplay-name>
<servlet>
<servlet-name>SpringMVCservlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
<init-param>
<param-name>contextConfigLocationparam-name>
<param-value>classpath:SpringMVC-servlet.xmlparam-value>
init-param>
<load-on-startup>1load-on-startup>
servlet>
<servlet-mapping>
<servlet-name>SpringMVCservlet-name>
<url-pattern>/url-pattern>
servlet-mapping>
<filter>
<filter-name>CharacterEncodingFilterfilter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
<init-param>
<param-name>encodingparam-name>
<param-value>UTF-8param-value>
init-param>
filter>
<filter-mapping>
<filter-name>CharacterEncodingFilterfilter-name>
<url-pattern>/*url-pattern>
filter-mapping>
web-app>
3.配置SpringMVC
<context:component-scan base-package="com.lx.controller">context:component-scan>
<bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
<property name="order" value="1"/>
<property name="characterEncoding" value="UTF-8"/>
<property name="templateEngine">
<bean class="org.thymeleaf.spring5.SpringTemplateEngine">
<property name="templateResolver">
<bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
<property name="prefix" value="/WEB-INF/templates/"/>
<property name="suffix" value=".html"/>
<property name="templateMode" value="HTML5"/>
<property name="characterEncoding" value="UTF-8" />
bean>
property>
bean>
property>
bean>
4.创建测试用的html页面
详细thymeleaf语法请看：http://c.biancheng.net/spring_boot/thymeleaf.html
DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documenttitle>
<style>
div{
display:block;
height: 200px;
font-size: 40px;
font-family: 楷体;
letter-spacing: -20px;
background-color: orange;
margin: auto;
animation: my 3s linear both;
text-align: center;
}
@keyframes my {
to{
letter-spacing: 0px;
}
}
style>
head>
<body>
<div>Lorem ipsum dolor sit amet consectetur, adipisicing elit.div>
<a th:href="@{/hello}">点我跳转successa>
body>
html>
5.编写Controller
定义一个类，在类上加上@Controller注解，声明其是一个Controller。主要要创建在之前注解扫描所配置的包下。
然后定义一个方法，在方法上加上@RequestMapping来指定哪些请求会被该方法所处理。
@Controller
public class HelloController {
@RequestMapping("/")
public String protal(){
//将逻辑视图返回,例如/WEB-INF/templates/index.html,通过去掉前缀和后缀最后就剩下index
return "index";
}
}
目录结构
三、请求映射规则@RequestMapping
1.@RequestMapping注解标识的位置
该注解可以加到方法上或者是类上。（查看其源码可知）
- @RequestMapping标识一个类:设置映射请求的请求路径的初始信息
- @RequestMapping标识一个方法:设置映射请求请求路径的具体信息
我们可以用其来设定所能匹配请求的要求。只有符合了设置的要求，请求才能被加了该注解的方法或类处理。
2.@RequestMapping注解value属性
作用:通过请求的请求路径匹配请求
value属性是数组类型，即当前浏览器所发送请求的请求路径匹配value属性中的任何一个值
则当前请求就会被注解所标识的方法进行处理
@Controller
@RequestMapping("/test")
public class TestController {
@RequestMapping("/testPath")
public String testPath(){
return "index";
}
}
3.@RequestMapping注解的method属性
method属性可以用来指定可处理的请求方式。
例如：
我们期望让请求的资源路径为/test/testMethod的POST请求能够被testMethod方法处理。则可以写如下代码
@Controller
@RequestMapping("/test")
public class TestController {
@RequestMapping(value = "/testMethod",method = RequestMethod.POST)
public String testMethod(){
System.out.println("testMethod处理了请求");
return "success";
}
}
注意：我们可以也可以运用如下注解来进行替换
- @PostMapping 等价于 @RequestMapping(method = RequestMethod.POST)
- @GetMapping 等价于 @RequestMapping(method = RequestMethod.GET)
- @PutMapping 等价于 @RequestMapping(method = RequestMethod.PUT)
- @DeleteMapping 等价于 @RequestMapping(method = RequestMethod.DELETE)
例如：
上面的需求我们可以使用下面的写法实现
@Controller
@RequestMapping("/test")
public class TestController {
@PostMapping(value = "/testMethod")
public String testMethod(){
System.out.println("testMethod处理了请求");
return "success";
}
}
4.@RequestMapping注解的params属性
我们可以使用params属性来对请求参数进行一些限制。可以要求必须具有某些参数，或者是某些参数必须是某个值，或者是某些参数必须不是某个值。
params可以使用四种表达式:
- “param”:表示当前所匹配请求的请求参数中必须携带param参数
- “!param”:表示当前所匹配请求的请求参数中一定不能携带param参数
- “param=value”:表示当前所匹配请求的请求参数中必须携带param参数且值必须为value
- “param!=value”:表示当前所匹配请求的请求参数中可以不携带param,若携带值一定不能是value
例如：
我们期望让请求的资源路径为/test/testParams的GET请求,并且请求参数中具有code参数的请求能够被testParams方法处理。则可以写如下代码
@Controller
@RequestMapping("/test")
public class TestController {
@RequestMapping(value = "/testParams",method = RequestMethod.GET,params = "code")
public String testParams(){
System.out.println("testParams处理了请求");
return "success";
}
}
5.@RequestMapping注解的headers属性
我们可以使用headers属性来对请求头进行一些限制。
- “header”:要求请求映射所匹配的请求必须携带header请求头信息
- “!header”:要求请求映射所匹配的请求必须不能携带header请求头信息
- “header=value”:要求请求映射所匹配的请求必须携带header请求头信息且header=value
- “header!=value”:要求请求映射所匹配的请求必须携带header请求头信息且header!=value
例如：
我们期望让请求的资源路径为/test/testHeaders的GET请求,并且请求头中具有deviceType的请求能够被testHeaders方法处理。则可以写如下代码
@Controller
@RequestMapping("/test")
public class TestController {
@RequestMapping(value = "/testHeaders",method = RequestMethod.GET,headers = "deviceType")
public String testHeaders(){
System.out.println("testHeaders处理了请求");
return "success";
}
}
6.指定请求头Content-Type
我们可以使用consumes属性来对Content-Type这个请求头进行一些限制。
范例一:
我们期望让请求的资源路径为/test/testConsumes的POST请求,并且请求头中的Content-Type头必须为 multipart/from-data 的请求能够被testConsumes方法处理。则可以写如下代码
@RequestMapping(value = "/testConsumes",method = RequestMethod.POST,consumes = "multipart/from-data")
public String testConsumes(){
System.out.println("testConsumes处理了请求");
return "success";
}
范例二
如果我们要求请求头Content-Type的值必须不能为某个multipart/from-data则可以改成如下形式：
@RequestMapping(value = "/testConsumes",method = RequestMethod.POST,consumes = "!multipart/from-data")
public String testConsumes(){
System.out.println("testConsumes处理了请求");
return "success";
}
7.SpringMVC支持ant风格的路径
在@RequestMapping注解的value属性值中设置一些特殊字符
?:任意的单个字符(不包括?)
*:任意个数的任意字符(不包括?和/)
**:任意层数的任意目录，注意使用方式只能**写在双斜线中(/**/)，前后不能有任何的其他字符
@RequestMapping("/a?c/test/ant")
public String testAnt(){
return "success";
}
四、RestFul风格
注意:浏览器目前只能发送get和post请求
若要发送put和delete请求，需要在web. xml中配置一个过滤器HiddenHt tpMethodFilter
配置了过滤器之后，发送的请求要满足两个条件，才能将请求方式转换为put或delete
1、当前请求必须为post
2、当前请求必须传输请求参数method,_ method的值才 是最终的请求方式
RestFul是一种网络应用程序的设计风格和开发方式 。现在很多互联网企业的网络接口定义都会符合其风格。
主要规则如下：
- 每一个URI代表1种资源
- 客户端使用GET、POST、PUT、DELETE 4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源，PUT用来更新资源，DELETE用来删除资源；
- 简单参数例如id等写到url路径上 例如：
- /user/1 HTTP GET：获取id=1的user信息
- /user/1 HTTP DELETE ：删除id=1的user信息
- 复杂的参数转换成json或者xml（现在基本都是json）写到请求体中。
五、获取请求参数
5.1 获取路径参数
RestFul风格的接口一些参数是在请求路径上的。类似： /user/1 这里的1就是id。
如果我们想获取这种格式的数据可以使用@PathVariable来实现。
范例一：根据id查询用户
@Controller
public class UserController {
@RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
public String findUserById( @PathVariable("id")Integer id){
System.out.println("findUserById");
System.out.println(id);
return "success";
}
5.2 获取请求体中的Json格式参数
RestFul风格的接口一些比较复杂的参数会转换成Json通过请求体传递过来。这种时候我们可以使用@RequestBody注解获取请求体中的数据。
SpringMVC可以帮我们把json数据转换成我们需要的类型。但是需要进行一些基本配置。SpringMVC默认会使用jackson来进行json的解析。所以我们需要导入jackson的依赖
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-databindartifactId>
<version>2.9.0version>
dependency>
配置注解驱动
<mvc:annotation-driven>
mvc:annotation-driven>
范例一：
要求定义个RestFul风格的接口，该接口可以用来新建用户。请求路径要求为 /user ，请求方式要求为POST。用户数据会转换成json通过请求体传递。
请求体数据：{"name":"张三","age":15}
1.获取参数封装成实体对象
@Controller
public class UserController {
@RequestMapping(value = "/user",method = RequestMethod.POST)
public String insertUser(@RequestBody User user){
System.out.println("insertUser");
System.out.println(user);
return "success";
}
}
User实体类
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private Integer id;
private String name;
private Integer age;
}
2.获取参数封装成Map集合
@RequestMapping(value = "/user",method = RequestMethod.POST)
public String insertUser(@RequestBody Map map){
System.out.println("insertUser");
System.out.println(map);
return "success";
}
范例二:
如果请求体传递过来的数据是一个User集合转换成的json，Json数据可以这样定义：
[{"name":"扎根三","age":14},{"name":"李四","age":15},{"name":"王五","age":16}]
服务端接收
@RequestMapping(value = "/users",method = RequestMethod.POST)
public String insertUsers(@RequestBody List<User> users){
System.out.println("insertUsers");
System.out.println(users);
return "success";
}
注意事项：如果需要使用@RequestBody来获取请求体中Json并且进行转换，要求请求头 Content-Type 的值要为： application/json 。
5.3 获取QueryString格式参数
如果接口的参数是使用QueryString的格式的话，我们也可以使用SpringMVC快速获取参数。
我们可以使用@RequestParam来获取QueryString格式的参数。
范例一:
要求定义个接口，该接口请求路径要求为 /testRequestParam，请求方式无要求。参数为id和name和likes。使用QueryString的格式传递。
1.参数单独的获取
如果我们想把id，name，likes单独获取出来可以使用如下写法：
在方法中定义方法参数，方法参数名要和请求参数名一致，这种情况下我们可以省略@RequestParam注解。
@RequestMapping("/testRquestParam")
public String testRquestParam(Integer id, String name, String[] likes){
System.out.println("testRquestParam");
System.out.println(id);
System.out.println(name);
System.out.println(Arrays.toString(likes));
return "success";
}
如果方法参数名和请求参数名不一致，我们可以加上@RequestParam注解例如:
@RequestMapping("/testRquestParam")
public String testRquestParam(@RequestParam("id") Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){
System.out.println("testRquestParam");
System.out.println(uid);
System.out.println(name);
System.out.println(Arrays.toString(likes));
return "success";
}
2.获取参数封装成实体对象
如果我们想把这些参数封装到一个User对象中可以使用如下写法：
@RequestMapping("/testRquestParam")
public String testRquestParam(User user){
System.out.println("testRquestParam");
System.out.println(user);
return "success";
}
User类定义如下：
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private Integer id;
private String name;
private Integer age;
private String[] likes;
}
注意：实体类中的成员变量要和请求参数名对应上。并且要提供对应的set/get方法。
六、 获取请求参数的几种方式
- 通过servletAPI获取
只需要在控制器方法的形参位置设置HttpservletRequest类型的形参
就可以在控制器方法中使用request对象获取请求参数 - 通过控制器方法的形参获取
只需要在控制器方法的形参位置，设置一个形参， 形参的名字和请求参数的名字一致即可 - @RequestParam:将请求参数和控制器方法的形参绑定
@RequestParam注解的三1属性: value: required, defaultValue
value:设置和形参绑定的请求参数的名字
required:设置是否必须传输value所对应的请求参数
默认值为true，表示value 所对应的请求参数必须传输，否则页面报错:
400一Required String parameter ‘xxx’ is not present
若设置为false,则表示value所对应的请求参数不是必须传输，若为传输，则形参值为null
defaultValue:设置当没有传输value所对应的请求参数时，为形参设置的默认值，此时和required属性值无关 - @RequestHeader:将请求头信息和控制器方法的形参绑定
- @CookieValue :将cookie 数据和控制器方法的形参绑定
- 通过控制器方法的实体类类型的形参获取请求参数
需要在控制器方法的形参位置设置实体类类型的形参，要保证实体类中的属性的属性名和请求参数的名字一致
可以通过实体类类型的形参获取请求参数 - 解决获取请求此参数的乱码问题
在web.xml中配置Spring的编码过滤器CharacterEncodingFilter