目录
SpringMVC
一、SpringMVC简介
1、概述
SpringMVC是Spring为表述层(表示前台页面和后台Servlet)开发提供的一整套完整的解决方案。
注:三层架构:表述层、业务逻辑层、数据访问层
2、特点
- 基于原生的Servlet,通过提供功能强大的前端控制器DispatcherServlet,对请求和相应进行统一处理;
- 代码简洁;
- 内部组件化程度高;
- 性能卓越
二、入门案例
1、创建一个webapp项目
2、导入相关包
<!-- SpringMVC -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.19</version>
</dependency>
<!-- 日志 -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.11</version>
</dependency>
<!-- ServletAPI -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
<scope>provided</scope>
</dependency>
<!-- Spring和Thymeleaf整合包 -->
<dependency>
<groupId>org.thymeleaf</groupId>
<artifactId>thymeleaf-spring5</artifactId>
<version>3.1.0.M1</version>
</dependency>
3、配置web.xml文件
注册SpringMVC的前端控制器DispatcherServlet。
- 默认配置方式
这种配置作用下,SpringMVC的配置文件默认在WEB-INF下,默认名称为 <servlet-name>-servlet.xml。
<!-- 配置SpringMVC的前端控制器,对浏览器发送对请求进行统一处理 -->
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<!--
设置SpringMVC对核心控制器所能处理的请求的路径。
"/"所匹配的请求可以是/login或.html或.js或.css方式的请求路径,
但不能匹配.jsp请求路径
-->
<url-pattern>/</url-pattern>
</servlet-mapping>
- 扩展配置方式
可通过init-param标签设置SpringMVC配置文件的位置和名称,通过load-on-startup标签设置SpringMVC前端控制器DispatcherServlet的初始化时间。
在标签中添加下述两个配置:
<!-- 配置SpringMVC配置文件的位置和名称 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springMVC.xml</param-value>
</init-param>
<!-- 将前端控制器DispatcherServlet的初始化时间提前到服务器启动时 -->
<load-on-startup>1</load-on-startup>
4、创建请求控制器
建立一个普通Java类,使用@Controller注解将其标识为一个控制层组件
@Controller
public class controller {
}
5、配置SpringMVC配置文件
配置扫描组件和Thymeleaf视图解析器。
<!-- 扫描组件 -->
<context:component-scan base-package="com.minh" />
<!-- 配置Thymeleaf视图解析器 -->
<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>
6、测试
- 访问首页
在WEB-INF下新建一个文件夹templates,并在里面新建一个html文件,例如index.html;之后在创建的普通Java类中编写如下代码:
@RequestMapping(value = "/")
public String method(){
//返回视图名称
return "/index";
}
- 通过超链接跳转到指定页面
在index.html中添加超链接,并新建一个html文件,记target.html;在controller.java中添加方法,代码如下:
index.html
<a th:href="@{/target}">访问目标页面</a>
controller.java
@RequestMapping("/target")
public String method2(){
return "target";
}
7、总结
浏览器发送请求,若请求地址符合前端控制器的url-pattern,该请求就会被前端控制器DispatcherServlet处理。前端控制器会读取SpringMVC的核心配置文件,通过扫描组件找到控制器,将请求地址和控制器中@RequestMapping注解的value属性进行匹配,若匹配成功,该注解所标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称,该视图名称会被视图解析器解析,加上前缀和后缀组成视图的路径,通过Thymeleaf对视图进行渲染,最终转发到视图所对应的页面。
三、@RequestMapping注解
1、功能
它是将请求和处理请求的控制器方法关联起来,建立映射关系。
SpringMVC接收到指定的请求,就会找在映射关系中对应的控制器方法来处理这个请求。
2、位置
- 标识一个类:设置映射请求的请求路径的初始信息;
- 标识一个方法:设置映射请求的请求路径的具体信息。
@Controller
@RequestMapping("/hello")
public class controller {
//请求路径会变成:/hello/target
@RequestMapping("/target")
public String method2(){
return "target";
}
}
index.html
<a th:href="@{/hello/target}">访问目标页面</a>
给类上加@RequestMapping注解相当于多加一层目录,如果不加,则在另一个类中也想写target的页面就会发生冲突,而此时能解决两个target冲突。
3、value属性
@RequestMapping注解的value属性通过请求的请求地址匹配请求映射。
该属性值是一个字符串类型的数组,表示该请求映射能够匹配多个请求地址所对应的请求。
value属性必须设置!
@RequestMapping(value = {"/target", "/testTarget"})
public String method2(){
return "target";
}
index.html
<a th:href="@{/target}">访问目标页面:value属性1</a>
<a th:href="@{/testTarget}">访问目标页面:value属性2</a>
4、method属性
@RequestMapping注解的method属性通过请求的请求方式(get/post)匹配请求映射。
该属性是一个RequestMethod类型(枚举类型)的数组,表示该请求映射能够匹配多种请求方式的请求。若不指定,表示post和get方式均可。
代码示例:
若指定GET方式,则若以POST方式会报405错误。
@RequestMapping(value = {"/target", "/testTarget"},
method = {RequestMethod.GET}
)
public String method2(){
return "target";
}
Index.html
<form th:action="@{/test}" method="get">
<input type="submit">
</form>
注:
1、对于处理指定请求方式的控制器方法,SpringMVC中提供了@RequestMapping的派生注解
处理get请求的映射:@GetMapping
处理post请求的映射:@PostMapping
处理put请求的映射:@PutMapping
处理delete请求的映射:@DeleteMapping
2、常用的请求方式由get,post,put,delete
但目前浏览器只支持get和post方式,若在form表单提交时,为method设置了其他请求方式的字符串,则默认按get方式处理。
5、params属性(了解)
@RequestMapping注解的params属性通过请求的请求参数匹配请求映射。
该属性是一个字符串类型的数组,可以通过四种表达式设置请求参数和请求映射的匹配关系。
- param:要求请求映射所匹配的请求必须携带param请求参数;
- !param:要求请求映射所匹配的请求必须不能携带param请求参数;
- param=value:要求请求映射所匹配的请求必须携带param请求参数且param=value;
- param!=value:要求请求映射所匹配的请求必须携带param请求参数但param!=value;
@RequestMapping(value = "/TestParams",
params = {"username"}
)
public String TestParams(){
return "target";
}
Index.html
<a th:href="@{/TestParams}">测试TestParams</a> <!-- 报400错,因为没有添加username属性 -->
<a th:href="@{/TestParams(username='admin', password=123456)}">测试TestParams</a>
6、headers属性(了解)
@RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射。
该属性是一个字符串类型的数组,可以通过四种表达式设置请求头信息和请求映射的匹配关系。
- header:要求请求映射所匹配的请求必须携带header请求头信息;
- !header:要求请求映射所匹配的请求必须不能携带header请求头信息;
- header=value:要求请求映射所匹配的请求必须携带header请求头信息且header=value;
- header!=value:要求请求映射所匹配的请求必须携带header请求头信息且header!=value;
若当前请求满足@RequestMapping注解的value和method属性,但不满足headers属性,则报404错误。
7、SpringMVC支持ant风格(模糊匹配)的路径
- ?:表示任意的单个字符;(特殊符号不匹配,例:?, /)
- *:表示任意的零个或多个字符;
- **:表示任意的一层或多层目录;
注:在使用**时,只能使用/**/xxx的方式
@RequestMapping("/a?a/TestAnt")
//@RequestMapping("/a*a/TestAnt")
//@RequestMapping("/**/TestAnt")
public String TestAnt(){
return "target";
}
Index.html
<a th:href="@{/a1a/TestAnt}">测试Ant1</a>
<a th:href="@{/a111a/TestAnt}">测试Ant2</a>
<a th:href="@{/a/1/a/TestAnt}">测试Ant3</a>
8、SpringMVC支持路径中的占位符
-
原始方式:/deleteUser?id=1
-
restful方式:/deleteUser/1
当请求路径中将某些数据通过路径的方式传输到服务器中,就可以在相应的@RequestMapping注解的value属性中通过占位符{xxx}表示传输的数据,再通过@PathVariable注解,将占位符所标识的数据赋值给控制器方法的形参。
@RequestMapping("TestPath/{id}/{username}")
public String TestPath(@PathVariable(value = "id") String id, @PathVariable(value = "username") String username) {
System.out.println("id:" + id + " username:" + username);
return "target";
}
Index.html
<a th:href="@{/TestPath/1/username}">测试占位符</a>
四、SpringMVC获取请求参数
1、通过ServletAPI获取(不常用)
将HttpServletRequest作为控制器方法的形参,此时HttpServletRequest类型的参数表示封装了当前请求的请求报文的对象。
代码示例:
paramsController.java
@RequestMapping("testServletAPI")
//形参位置的request表示当前请求
public String testServletAPI(HttpServletRequest request){
String username = request.getParameter("username");
String password = request.getParameter("password");
System.out.println(username+" "+password);
return "target";
}
paramsTest.html
<a th:href="@{/testServletAPI(username='admin', password=123456)}">测试testServletAPI</a>
2、通过控制器方式的形参获取请求参数
在控制器方法的形参位置,设置和请求参数同名的形参,当浏览器发送请求,匹配到请求映射时,在DispatcherServlet中就会将请求参数赋值给相应的形参。
代码示例:
paramsController.java
@RequestMapping("/testParams")
public String testParams(String username, String password, String[] hobbies){
//若请求参数中出现多个同名的请求参数,可以在控制器方法的形参位置设置字符串类型或字符串数组接收此请求参数
//若使用字符串类型的形参,最终结果为请求参数的每一个值之间使用逗号进行拼接
System.out.println(username+" "+password + " " + Arrays.toString(hobbies));
return "target";
}
paramsTest.html
<form th:action="@{/testParams}" method="post">
用户名:<input type="text" name="username">
密码:<input type="password" name="password">
爱好:<input type="checkbox" name="hobbies" value="1">111
<input type="checkbox" name="hobbies" value="2">222
<input type="checkbox" name="hobbies" value="3">333
<input type="submit">
</form>
注:
若请求参数中出现多个同名的请求参数,可以在控制器方法的形参位置设置字符串类型或字符串数组接收此请求参数;
若使用字符串类型的形参,最终结果为请求参数的每一个值之间使用逗号进行拼接;
若使用字符串数组类型的形参,此形参的数组中包含每一个数据。
3、@RequestParam
@RequestParam是将请求参数和控制器方法的形参创建映射关系
共有三个属性:
- value:指定为形参赋值的请求参数的参数名;
- required:设置是否必须传输此请求参数,默认为true;
若设置为true时,则当前请求必须传输value所指定的请求参数,若没有传输该请求参数,且没有设置defaultValue属性,则报错400;若设置为false,则当前请求不是必须传输value所指定的请求参数,若没有传输,则注解所标识的形参的值为null;
- defaultValue:不管required属性值为true或false,当value所指定的请求参数没有传输或传输的值为空字符串时,则使用默认值为形参赋值。
paramsController.java
@RequestMapping("/testParams")
public String testParams(
@RequestParam(value = "user_name", required = false, defaultValue = "minh") String username,
System.out.println(username);
return "target";
}
4、@RequestHeader
@RequestHeader是将请求头信息和控制器方法的形参创建映射关系。
属性和用法同@RequestParam。
paramsController.java
@RequestMapping("/testParams")
public String testParams(
@RequestHeader(value = "Host", required = false, defaultValue = "myhost") String host){
System.out.println("Host:"+host);
return "target";
}
5、@CookieValue
@CookieValue是将cookie数据和控制器方法的形参创建映射关系。
属性和用法同@RequestParam。
6、通过POJO获取请求参数
可以通过在控制器方法的形参位置设置一个实体类的形参,此时若浏览器传输的请求参数的参数名和实体类中的属性名一致,那么请求参数就会为此属性赋值。
paramsController.java
@RequestMapping("/testPOJO")
public String testPOJO(User user){
System.out.println(user);
return "target";
}
POJOTest.html
<form th:action="@{/testPOJO}" method="get">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
性别:<input type="radio" name="sex" value="1">男<input type="radio" name="sex" value="2">女<br>
年龄:<input type="text" name="age"><br>
邮箱:<input type="text" name="email"><br>
<input type="submit">
</form>
7、解决获取请求参数可能出现的乱码问题
解决方法:添加过滤器
web.xml
<filter>
<filter-name>CharacterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<!-- 设置编码格式为UTF-8 -->
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<!-- 设置响应的格式 -->
<init-param>
<param-name>forceResponseEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
五、域对象共享数据
四大域对象:PageContext、Request、Session、Application
- PageContext:保存的数据只在一个页面中有效;
- Request:保存的数据只在一次请求中有效;
- Session:保存的数据只在一次会话中有效;
- Application:保存的数据只在服务器中有效。
1、使用servletAPI向request域对象共享数据(不常用)
代码示例:
ScopeController.java
//使用servletAPI向request域对象共享数据
@RequestMapping("/testRequestByServletAPI")
public String testRequestByServletAPI(HttpServletRequest request){
request.setAttribute("testRequestScope", "hello, ServletAPI");
return "success";
}
Index.html
<a th:href="@{/testRequestByServletAPI}">servletAPI共享数据</a>
success.html
<p th:text="@{testRequestScope}"></p>
2、使用ModelAndView向request域对象共享数据(重要)
代码示例:
ScopeController.java
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
/*
ModelAndView有model和view的功能
Model主要用于向请求域共享数据;
View主要用于设置视图,实现页面跳转
*/
ModelAndView mav = new ModelAndView();
//处理模型数据,即向请求域request共享数据
mav.addObject("testRequestScope", "hello, ModelAndView");
//设置视图名称,实现页面跳转
mav.setViewName("success");
return mav;
}
success.html中同上。
3、使用Model向request域对象共享数据
代码示例:
ScopeController.java
@RequestMapping("/testModel")
public String testModel(Model model){
model.addAttribute("testRequestScope", "hello, Model");
return "success";
}
success.html中同上。
4、使用map向request域对象共享数据
代码示例:
ScopeController.java
@RequestMapping("/testMap")
public String testMap(Map<String, Object> map){
map.put("testRequestScope", "hello, Map");
return "success";
}
success.html中同上。
5、使用ModelMap向request域对象共享数据
代码示例:
ScopeController.java
@RequestMapping("/testModelMap")
public String testModelMap(ModelMap modelMap){
modelMap.addAttribute("testRequestScope", "hello, ModelMap");
return "success";
}
success.html中同上。
6、Model、ModelMap、Map的关系
三者的参数本质上都是BindingAwareModelMap类型。
public interface Model {}
public class ModelMap extends LinkedHashMap<String, Object>{}
public class ExtendedModelMap extends ModelMap implements Model{}
public class BindingAwareModelMap extends ExtendedModelMap {}
上述五种向request域对象共享数据的方式,究其根源都是ModelAndView对象。
7、向session域共享数据
ServletAPI的方式。
代码示例:
ScopeController.java
@RequestMapping("/testSession")
public String testSession(HttpSession session){
session.setAttribute("testRequestScope", "hello, Session");
return "success";
}
success.html
<p th:text="${session.testRequestScope}"></p>
8、向application域共享数据
代码示例:
ScopeController.java
@RequestMapping("/testApplication")
public String testApplication(HttpSession session){
ServletContext application = session.getServletContext();
application.setAttribute("testRequestScope", "hello, Application");
return "success";
}
success.html
<p th:text="${application.testRequestScope}"></p>
六、SpringMVC的视图
SpringMVC中的视图是View接口,视图的作用是渲染数据,将模型Model的数据展示给用户。
SpringMVC视图的种类很多,默认有转发视图InternalResourceView和重定向视图RedirectView。
当工程引入jstl依赖,转发视图会自动转换为jstlView。
若使用的视图技术为Thymeleaf,在SpringMVC的配置文件中配置了Thymeleaf的视图解析器,由此视图解析器解析之后所得到的是ThymeleafView。
1、ThymeleafView
当控制器方法中所设置的视图名称没有任何前缀时,此时的视图名称会被SpringMVC配置文件中所配置的视图解析器解析,视图名称拼接视图前缀和视图后缀所得到的最终路径,会通过转发的方式实现跳转。
代码示例:
Viewcontroller.java
@RequestMapping("/testThymeleafView")
public String testThymeleafView(){
return "success";
}
2、转发视图
SpringMVC中默认的转发视图是InternalResourceView
当控制器方法中所设置的视图名称以"forward:"为前缀时,创建InternalResourceView视图,此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析,而是会将前缀"forward:"去掉,剩余部分作为最终路径通过转发的方式实现跳转。
代码示例:
Viewcontroller.java
@RequestMapping("testForward")
public String testForward(){
return "forward:/testThymeleafView";
}
3、重定向视图
SpringMVC中默认的重定向视图是RedirectView
当控制器方法中所设置的视图名称以"redirect:"为前缀时,创建RedirectView视图,此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析,而是会将前缀"redirect:"去掉,剩余部分作为最终路径通过重定向的方式实现跳转。
代码示例:
Viewcontroller.java
@RequestMapping("/testRedirect")
public String testRedirect(){
return "redirect:/testThymeleafView";
}
4、视图控制器view-controller
当控制器方法中,仅用来实现页面跳转,即只需要设置视图名称时,可以将处理器方法使用view-controller标签进行表示
SpringMVC.xml
- path:设置处理的请求地址;
- view-name:设置请求地址所对应的视图名称
<mvc:view-controller path="/" view-name="index"></mvc:view-controller>
<!-- 开启MVC的注解驱动 -->
<mvc:annotation-driven />
注:
当SpringMVC中设置任何一个view-controller时,其他控制器中的请求映射将全部失效,此时需要在springMVC的核心配置文件中设置开启mvc注解驱动的标签:<mvc:annotation-driven />
七、RESTFul
1、简介
REST: Representational State Transfer,表现层资源状态转移。
- 资源
资源是一种看待服务器的方式,即将服务器看作是由很多高散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个资源可以由一个或多个URL来标识。URL既是资源的名称,也是资源在Web上的地址。对某个资源感兴趣的客户端应用,可以通过资源的URL与其进行交互。
- 资源的表述
资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移(交换)。资源的表述可以有多种格式,例如HTML/XMUSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。
- 状态转移
状态转移说的是:在客户端和服务器端之问转移 (transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的。
2、RESTFul的实现
具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、 POST、PUT、DELETE。
它们分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资
源。
REST 风格提倡 URL地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求
参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性
操作 | 传统方式 | REST风格 |
---|---|---|
查询操作 | getUesrByID?id=1 | user/1–>get请求方式 |
保存操作 | saveUser | user–>post请求方式 |
删除操作 | deleteUser?id=1 | user/1–>delete请求方式 |
更新操作 | updateUser | user–>put请求方式 |
3、模拟GET、 POST、PUT请求
编写一个普通类UserController,添加一个页面test_rest.html,在SpringMVC.xml中添加响应的视图控制器,在web.xml中配置HiddenHttpMethodFilter过滤器,用以实现PUT请求。
UserController.java
@Controller
public class UserController {
/*
* 使用RESTFul模拟用户资源的增删改查
* /user GET 查询所有用户信息
* /user/1 GET 根据用户ID查询用户信息
* /user POST 添加用户信息
* /user/1 DELETE 删除用户信息
* /user PUT 修改用户信息
* */
@RequestMapping(value = "/user", method = RequestMethod.GET)
public String getAllUser(){
System.out.println("查询所有用户信息");
return "success";
}
@RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
public String getUserByID(){
System.out.println("根据用户ID查询用户信息");
return "success";
}
@RequestMapping(value = "/user", method = RequestMethod.POST)
public String insertUser(String username, String password){
System.out.println("添加用户信息:"+username+" "+password);
return "success";
}
@RequestMapping(value = "/user", method = RequestMethod.POST)
public String updatetUser(String username, String password){
System.out.println("修改用户信息:"+username+" "+password);
return "success";
}
}
SpringMVC.xml
<mvc:view-controller path="/test_rest" view-name="test_rest" />
<!-- 开启MVC的注解驱动 -->
<mvc:annotation-driven />
Test_rest.html
<a th:href="@{/user}">查询所有用户信息</a><br>
<a th:href="@{/user/1}">根据用户ID查询用户信息</a><br>
<form th:action="@{/user}" method="post">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="提交"><br>
</form>
<form th:action="@{/user}" method="post">
<input type="hidden" name="_method" value="PUT">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="提交"><br>
</form>
web.xml
<!-- 配置HiddenHttpMethodFilter -->
<filter>
<filter-name>HiddenHttpMethodFilter</filter-name>
<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>HiddenHttpMethodFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
4、案例
实现对员工信息的CRUD。
(1)准备工作
创建一个实体类Employee和Dao数据
Employee.java
public class Employee {
private Integer id;
private String lastName;
private String email;
//1 male, 0 female
private Integer gender;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Integer getGender() {
return gender;
}
public void setGender(Integer gender) {
this.gender = gender;
}
public Employee(Integer id, String lastName, String email, Integer gender) {
super();
this.id = id;
this.lastName = lastName;
this.email = email;
this.gender = gender;
}
public Employee() {
}
}
EmployeeDao.java
@Repository
public class EmployeeDao {
private static Map<Integer, Employee> employees = null;
static{
employees = new HashMap<Integer, Employee>();
employees.put(1001, new Employee(1001, "E-AA", "aa@163.com", 1));
employees.put(1002, new Employee(1002, "E-BB", "bb@163.com", 1));
employees.put(1003, new Employee(1003, "E-CC", "cc@163.com", 0));
employees.put(1004, new Employee(1004, "E-DD", "dd@163.com", 0));
employees.put(1005, new Employee(1005, "E-EE", "ee@163.com", 1));
}
private static Integer initId = 1006;
public void save(Employee employee){
if(employee.getId() == null){
employee.setId(initId++);
}
employees.put(employee.getId(), employee);
}
public Collection<Employee> getAll(){
return employees.values();
}
public Employee get(Integer id){
return employees.get(id);
}
public void delete(Integer id){
employees.remove(id);
}
}
(2)功能清单
功能 | URL地址 | 请求方式 |
---|---|---|
访问首页 | / | GET |
查询全部数据 | /employee | GET |
删除 | /employee/2 | DELETE |
跳转到添加数据页面 | /toAdd | GET |
执行保存 | /employee | POST |
跳转到更新数据页面 | /employee/2 | GET |
执行更新 | /employee | PUT |
(3)具体功能:访问首页
创建首页index.xml,并在SpringMVC.xml添加配置视图控制器和开启MVC的注解驱动。
index.xml
<h1>首页</h1>
<a th:href="@{/employee}">查看员工信息</a>
SpringMVC.xml
<!-- 配置视图控制器 -->
<mvc:view-controller path="/" view-name="index" />
<!-- 开启MVC的注解驱动 -->
<mvc:annotation-driven />
(4)具体功能:查询所有员工数据
添加控制器方法EmployeeController.java,创建员工信息网页employee_list.html。
EmployeeController.java
@Autowired
private EmployeeDao employeeDao;
@RequestMapping(value = "/employee", method = RequestMethod.GET)
public String getAllEmployee(Model model){
Collection<Employee> employeeList = employeeDao.getAll();
model.addAttribute("employeeList", employeeList);
return "employee_list";
}
employee_list.html
<body>
<table id="dataTable" style="text-align: center">
<tr>
<th>Employee Info</th>
</tr>
<tr>
<th>id</th>
<th>lastName</th>
<th>email</th>
<th>gender</th>
<th>options</th>
</tr>
<tr th:each="employee : ${employeeList}">
<td th:text="${employee.id}"></td>
<td th:text="${employee.lastName}"></td>
<td th:text="${employee.email}"></td>
<td th:text="${employee.gender}"></td>
<td>
<a @click="deleteEmployee" th:href="@{'/employee/' + ${employee.id}}">delete</a>
<a href="">update</a>
</td>
</tr>
</table>
</body>
(5)具体功能:删除
在EmployeeController.java添加相应的控制器方法,在employee_list.html中创建处理delete请求的表单和相应的脚本代码,并在SpringMVC.xml中开放对静态资源的访问。
这里需要引入vue.js(放在webapp/static/js中)
EmployeeController.java
@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
public String deleteEmployee(@PathVariable("id") Integer id){
employeeDao.delete(id);
return "redirect:/employee";
}
employee_list.html
<form id="deleteForm" method="post">
<input type="hidden" name="_method" value="delete">
</form>
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<script type="text/javascript">
var vue = new Vue({
el:"#dataTable",
methods:{
deleteEmployee:function (event){
//根据id获取表单元素
var deleteForm = document.getElementById("deleteForm");
//将触发点击事件的超链接的href属性赋值给表单的action
deleteForm.action = event.target.href;
//提交表单
deleteForm.submit();
//取消超链接的默认行为
event.preventDefault();
}
}
});
</script>
SpringMVC.xml
<!-- 开放对静态资源的访问 -->
<mvc:default-servlet-handler />
(6)具体功能:添加
在employee_list.html添加一个添加功能的超链接(直接在options这一格中添加add超链接),创建employee_add.html添加一个表单,实现员工添加,并在SpringMVC.xml中配置相应的视图控制器,并在EmployeeController.java中添加相应的控制器方法。
employee_list.html
<th>options(<a th:href="@{/toAdd}">add</a>)</th>
employee_add.html
<form th:action="@{/employee}" method="post">
lastName:<input type="text" name="lastName"><br>
email:<input type="text" name="email"><br>
gender:<input type="radio" name="gender" value="0">female
<input type="radio" name="gender" value="1">male<br>
<input type="submit" value="add"><br>
</form>
SpringMVC.xml
<mvc:view-controller path="/toAdd" view-name="employee_add" />
EmployeeController.java
@RequestMapping(value = "/employee", method = RequestMethod.POST)
public String addEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
(7)具体功能:修改
在实现修改功能之前,需要先实现回显的功能。employee_list.html添加修改的超链接,创建一个employee_update.html
实现数据的回显,之后在EmployeeController.java中添加相应的控制器方法
employee_list.html
<a th:href="@{'/employee/' + ${employee.id}}">update</a>
employee_update.html
<form th:action="@{/employee}" method="post">
<input type="hidden" name="_method" th:value="put">
<input type="hidden" name="id" th:value="${employee.id}">
lastName:<input type="text" name="lastName" th:value="${employee.lastName}"><br>
email:<input type="text" name="email" th:value="${employee.email}"><br>
gender:<input type="radio" name="gender" value="0" th:field="${employee.gender}">female
<input type="radio" name="gender" value="1" th:field="${employee.gender}">male<br>
<input type="submit" value="update"><br>
</form>
EmployeeController.java
@RequestMapping(value = "/employee", method = RequestMethod.PUT)
public String updateEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
八、HttpMessageConveter
HttpMessageConveter(报文信息转换器),将请求报文转换为Java对象,或将Java对象转换为响应报文。HttpMessageConveter提供了两个注解和两个类型:@RequestBody,@ResponseBody,RequestEntity,ResponseEntity。
1、@RequestBody(不常用)
@RequestBody可以获取请求体,需要在控制器方法设置一个形参,使用@RequestBody进行标识,当前请求的请求体就会为当前注解所标识的形参赋值。
index.html
<form th:action="@{/testRequestBody}" method="post">
<input type="text" name="username"><br>
<input type="password" name="password"><br>
<input type="submit" value="提交"><br>
</form>
HttpController.java
@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String requestBody){
System.out.println("requestBody:"+requestBody);
return "success";
}
2、RequestEntity(不常用)
RequestEntity封装请求报文的一种类型,需要在控制器方法的形参中设置该类型的形参,当前请求的请求报文就会赋值给该形参,可以通过getHeaders()获取请求头信息,通过getBody()获取请求体信息。
index.html
<form th:action="@{/testRequestEntity}" method="post">
<input type="text" name="username"><br>
<input type="password" name="password"><br>
<input type="submit" value="提交"><br>
</form>
HttpController.java
@RequestMapping("/testRequestEntity")
public String testRequestEntity(RequestEntity<String> requestEntity){
System.out.println("请求头:"+requestEntity.getHeaders());
System.out.println("请求体:"+requestEntity.getBody());
return "success";
}
3、@ResponseBody(常用)
@ResponseBody用来标识一个控制器方法,可以将该方法的返回值直接作为响应报文的响应体响应到浏览器。
HttpController.java
@RequestMapping("/testResponseBody")
@ResponseBody
public String testResponseBody(){
return "aaa";
}
4、SpringMVC使用@ResponseBody处理json
步骤:
(1)导入jackson依赖
pom.xml
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.13.2.2</version>
</dependency>
(2)在SpringMVC.xml中开启mvc注解驱动,此时HandlerAdaptor中会自动装配一个消息转换器:MappingJackson2HttpMessageConverter,可以将响应到浏览器的Java对象转换为Json格式的字符串
<mvc:annotation-driven />
(3)在处理器方法上使用@ResponseBody注解进行标识
(4)将Java对象直接作为控制器方法的返回值返回,就会自动转换为Json格式的字符串。
HttpController.java
@RequestMapping("/testResponseUser")
@ResponseBody
public User testResponseUser(){
return new User(1000, "admin", "123456", 11, "男");
}
Index.html
<a th:href="@{/testResponseUser}">测试ResponseBody处理User对象</a>
5、SpringMVC处理ajax
在index.html添加超链接,并通过vue和axios处理点击事件,再在HttpController.java添加相应的控制器方法。
需要引入vue.js和axios.min.js(均放在webapp/static/js下)
index.html
<div id="app">
<a @click="testAxios" th:href="@{/testAxios}">SpringMVC处理ajax</a>
</div>
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<script type="text/javascript" th:src="@{/static/js/axios.min.js}"></script>
<script type="text/javascript">
new Vue({
el:"#app",
methods:{
testAxios:function (event){
axios({
method:"post",
url:event.target.href,
params:{
username:"admin",
password:"123456"
}
}).then(function (response){
alert(response.data);
});
event.preventDefault();
}
}
});
</script>
HttpController.java
@RequestMapping("/testAxios")
@ResponseBody
public String testAxios(String username, String password){
System.out.println(username+" "+password);
return "hello, axios";
}
6、@RestController注解
@RestController注解是SpringMVC提供的一个复合注解,标识在控制器的类上,就相当于为类添加了@Controller注解并且为其中的每个方法添加了@ResponseBody注解。
7、ResponseEntity
ResponseEntity用于控制器方法的返回值类型,该控制器方法的返回值就是响应到浏览器的响应报文。
九、文件上传和下载
1、文件下载
使用ResponseEntity实现下载文件的功能。(格式比较固定,只需修改文件名)
FileController.java
@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
//获取ServletContext对象
ServletContext context = session.getServletContext();
//获取服务器中文件的真实路径
String realPath = context.getRealPath("/static/img/2.jpeg");
//创建输入流
InputStream is = new FileInputStream(realPath);
//创建字节数组
byte[] bytes = new byte[is.available()];
//将流读到字节数组中
is.read(bytes);
//创建HttpHeaders对象设置响应头信息
MultiValueMap<String, String> headers = new HttpHeaders();
//设置要下载方法以及下载文件的名字
headers.add("Content-Disposition", "attachment;filename=2.jpeg");
//设置响应状态码
HttpStatus statusCode = HttpStatus.OK;
//创建ResponseEntity对象
ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
//关闭输入流
is.close();
return responseEntity;
}
file.html
<a th:href="@{/testDown}">测试下载</a>
SpringMVC.xml
<mvc:view-controller path="/file" view-name="file" />
2、文件上传
文件上传要求form表单的请求方式必须为post,并且添加属性enctype=“multipart/form-data”
SpringMVC中将上传的文件封装到MultipartFile对象中,通过此对象可以获取文件相关信息。
步骤:
(1)在pom.xml添加依赖;
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
(2)在SpringMVC.xml文件中配置文件上传解析器,将上传的文件封装为MultipartFile;
<!-- 配置文件上传解析器,将上传的文件封装为MultipartFile -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver" />
(3)在file.html添加form表单;
<form th:action="@{/testUp}" method="post" enctype="multipart/form-data">
头像:<input type="file" name="photo"><br>
<input type="submit" name="上传"><br>
</form>
(4)在FileController.java中添加控制器方法
@RequestMapping("/testUp")
public String testUp(MultipartFile photo, HttpSession session) throws IOException {
//获取上传的文件的文件名
String fileName = photo.getOriginalFilename();
//获取上传的文件的后缀名
String suffixName = fileName.substring(fileName.lastIndexOf("."));
//将UUID作为文件名
String uuid = UUID.randomUUID().toString();
//将UUID和后缀名拼接后的结果作为最终的文件名
fileName = uuid + suffixName;
//通过ServletContext获取服务器中photo文件目录的路径
ServletContext context = session.getServletContext();
String photoPath = context.getRealPath("photo");
File file = new File(photoPath);
//判断photoPath对应的路径是否存在
if(!file.exists()){
//若不存在,则创建目录
file.mkdir();
}
String finalPath = photoPath + File.separator + fileName;
photo.transferTo(new File(finalPath));
return "success";
}
注:
在文件上传中会遇到文件重名问题,此时可以用UUID作为文件名,拼接上文件后缀的方式解决该类问题。
十、拦截器
1、拦截器的配置
SpringMVC中的拦截器用于拦截控制器方法的执行;
SpringMVC中的拦截器需要实现HandlerInterceptor;
SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置:
SpringMVC.xml
<!-- 配置拦截器 -->
<mvc:interceptors>
<bean class="minh.interceptors.FirstInterceptor" />
<ref bean="firstInterceptor" />
<!-- 以上两种配置方式都是对DispatcherServlet所处理的所有的请求进行拦截 -->
<mvc:interceptor>
<mvc:mapping path="/*"/>
<mvc:exclude-mapping path="/"/>
<ref bean="firstInterceptor" />
</mvc:interceptor>
<!--
以上配置方式可以通过ref或bean标签设置拦截器,通过mvc:mapping设置需要拦截的请求,通过mvc:exclude-mapping设置需要排除的请求,即不需要拦截的请求
-->
</mvc:interceptors>
2、拦截器的三个抽象方法
SpringMVC中的拦截器有三个抽象方法:
-
preHandle:控制器方法执行之前执行preHandle(),其boolean类型的返回值表示是否拦截或放行,返回true为放行,即调用控制器方法;返回false表示拦截,即不调用控制器方法
-
postHandle:控制器方法执行之后执行postHandle()
-
afterComplation:处理完视图和模型数据,渲染视图完毕之后执行afterComplation()
代码示例:
FirstInterceptor.java
@Component
public class FirstInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
}
3、多个拦截器的执行顺序
- 若每个拦截器的preHandle()都返回true
此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关:preHandle()会按照配置的顺序执行,而postHandle()和afterCompletion()会按照配置的反序执行。
- 若某个拦截器的preHandle()返回了false
preHandle()返回false和它之前的拦截器的preHandle()都会执行,postHandle()都不执行,返回false的拦截器之前的拦截器的afterCompletion()会执行。
十一、异常处理器
1、基于配置的异常处理
SpringMVC提供了一个处理控制器方法执行过程中所出现的异常的接口:HandlerExceptionResolver
HandlerExceptionResolver接口的实现类有:DefaultHandlerExceptionResolver和SimpleMappingExceptionResolver
SpringMVC提供了自定义的异常处理器SimpleMappingExceptionResolver,使用方式:
SpringMVC.xml
<!-- 配置异常处理 -->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<property name="exceptionMappings">
<props>
<!--
properties的键表示处理器方法执行过程中出现的异常
properties的值表示若出现指定异常时,设置一个新的视图名称,跳转到指定页面
-->
<prop key="java.lang.ArithmeticException">error</prop>
</props>
</property>
<!-- 设置将异常信息共享在请求域中的键中 -->
<property name="exceptionAttribute" value="ex"></property>
</bean>
error.html
<h1>Error!</h1>
<p th:text="${ex}"></p>
2、基于注解的异常处理
ExceptionController.java
//@ControllerAdvice将当前类标识为异常处理的组件
@ControllerAdvice
public class ExceptionController {
//@ExceptionHandler用于设置所标识方法处理的异常
@ExceptionHandler(value = {ArithmeticException.class, NullPointerException.class})
//ex表示当前请求处理中出现的异常对象
public String handleException(Exception ex, Model model){
model.addAttribute("ex", ex);
return "error";
}
}
十二、注解配置SpringMVC
使用配置类和注解代替web.xml和SpringMVC.xml 的功能。
1、创建初始化类,代替web.xml
在Servlet3.0环境中,容器会在类路径中查找实现javax.servlet.ServletContainerInitializer接口的类,如果找到的话就用它来配置Servlet容器。
Spring提供了这个接口的实现,名为SpringServletContainerInitializer,这个类反过来又会查找实现WebApplicationInitializer的类并将配置的任务交给它们来完成。Spring3.2引入了一个便利的WebApplicationInitializer基础实现,名为AbstractAnnotationConfigDispatcherServletInitializer,当我们的类扩展了AbstractAnnotationConfigDispatcherServletInitializer并将其部署到Servlet3.0容器的时候,容器会自动发现它,并用它来配置Servlet上下文。
WebInit.java
//Web工程的初始化类,用来代替web.xml
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
/**
* 指定Spring的配置类
*/
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[]{SpringConfig.class};
}
/**
* 指定SpringMVC的配置类
*/
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[]{WebConfig.class};
}
/**
* 指定DispatcherServlet的映射规则,即url-pattern
*/
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
/**
* 注册过滤器
*/
@Override
protected Filter[] getServletFilters() {
//编码过滤器
CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
characterEncodingFilter.setEncoding("UTF-8");
characterEncodingFilter.setForceResponseEncoding(true);
//HiddenHttpMethodFilter
HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
return new Filter[]{characterEncodingFilter, hiddenHttpMethodFilter};
}
}
2、创建SpringConfig配置类,代替Spring的配置文件
SpringConfig.java
@Configuration
public class SpringConfig {
}
3、创建WebConfig配置类,代替SpringMVC的配置文件
WebConfig.java
/**
* 代替SpringMVC的配置文件:
* 1、扫描组件
* 2、视图解析器
* 3、视图控制器
* 4、开启静态资源的访问
* 5、mvc注解驱动
* 6、文件上传解析器
* 7、异常处理
* 8、拦截器
*/
@Configuration //将当前类标识为一个配置类
@ComponentScan("minh.controller") //扫描组件
@EnableWebMvc //mvc注解驱动
public class WebConfig implements WebMvcConfigurer {
//开放对静态资源的访问,相当于default-servlet-handler
//需要实现一个接口:WebMvcConfigurer
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
//配置拦截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
TestInterceptor testInterceptor = new TestInterceptor();
registry.addInterceptor(testInterceptor).addPathPatterns("/**");
}
//配置视图控制器
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/hello").setViewName("hello");
}
//配置文件上传解析器
@Bean
public CommonsMultipartResolver multipartResolver(){
CommonsMultipartResolver commonsMultipartResolver = new CommonsMultipartResolver();
return commonsMultipartResolver;
}
//配置异常处理
@Override
public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();
Properties properties = new Properties();
properties.setProperty("java.lang.ArithmeticException", "error");
simpleMappingExceptionResolver.setExceptionMappings(properties);
simpleMappingExceptionResolver.setExceptionAttribute("exception");
resolvers.add(simpleMappingExceptionResolver);
}
//配置生成模板解析器
@Bean
public SpringResourceTemplateResolver templateResolver() {
SpringResourceTemplateResolver springResourceTemplateResolver = new SpringResourceTemplateResolver();
springResourceTemplateResolver.setApplicationContext(ContextLoader.getCurrentWebApplicationContext());
springResourceTemplateResolver.setPrefix("/WEB-INF/templates/");
springResourceTemplateResolver.setSuffix(".html");
springResourceTemplateResolver.setCharacterEncoding("UTF-8");
springResourceTemplateResolver.setTemplateMode(TemplateMode.HTML);
return springResourceTemplateResolver;
}
//生成模板引擎并为模板引擎注入模板解析器
@Bean
public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
SpringTemplateEngine templateEngine = new SpringTemplateEngine();
templateEngine.setTemplateResolver(templateResolver);
return templateEngine;
}
//生成视图解析器并为解析器注入模板引擎
@Bean
public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
viewResolver.setCharacterEncoding("UTF-8");
viewResolver.setTemplateEngine(templateEngine);
return viewResolver;
}
}
4、测试
TestController.java
@Controller
public class TestController {
@RequestMapping("/")
public String testIndex(){
return "index";
}
}
十三、SpringMVC执行流程
1、SpringMVC常用组件
- DispatcherServlet:前端控制器,不需要工程师开发,由框架提供;
作用:统一处理请求和响应,整个流程控制的中心,由它调用其它组件处理用户的请求。
- HandlerMapping:处理器映射器,不需要工程师开发,由框架提供;
作用:根据请求的url、method等信息查找Handler,即控制器方法。
- Handler:处理器(控制器),需要工程师开发;
作用:在DispatcherServlet的控制下Handler对具体的用户请求进行处理。
- HandlerAdapter:处理器适配器,不需要工程师开发,由框架提供;
作用:通过HandlerAdapter对处理器(控制器方法)进行执行。
- ViewResolver:视图解析器,不需要工程师开发,由框架提供;
作用:进行视图解析,得到相应的视图,例如:ThymeleafView、InternalResourceView、RedirectView。
- View:视图,不需要工程师开发,由框架或视图技术提供;
作用:将模型数据通过页面展示给用户。
2、DispatcherServlet初始化过程
DispatcherServlet 本质上是一个 Servlet,所以天然的遵循 Servlet 的生命周期。所以宏观上是 Servlet 生命周期来进行调度。
(1)初始化WebApplicationContext
所在类:org.springframework.web.servlet.FrameworkServlet
protected WebApplicationContext initWebApplicationContext() {
WebApplicationContext rootContext =
WebApplicationContextUtils.getWebApplicationContext(getServletContext());
WebApplicationContext wac = null;
if (this.webApplicationContext != null) {
// A context instance was injected at construction time -> use it
wac = this.webApplicationContext;
if (wac instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
if (!cwac.isActive()) {
// The context has not yet been refreshed -> provide services such as
// setting the parent context, setting the application context id, etc
if (cwac.getParent() == null) {
// The context instance was injected without an explicit parent -> set
// the root application context (if any; may be null) as the parent
cwac.setParent(rootContext);
}
configureAndRefreshWebApplicationContext(cwac);
}
}
}
if (wac == null) {
// No context instance was injected at construction time -> see if one
// has been registered in the servlet context. If one exists, it is assumed
// that the parent context (if any) has already been set and that the
// user has performed any initialization such as setting the context id
wac = findWebApplicationContext();
}
if (wac == null) {
// No context instance is defined for this servlet -> create a local one
// 创建WebApplicationContext
wac = createWebApplicationContext(rootContext);
}
if (!this.refreshEventReceived) {
// Either the context is not a ConfigurableApplicationContext with refresh
// support or the context injected at construction time had already been
// refreshed -> trigger initial onRefresh manually here.
synchronized (this.onRefreshMonitor) {
// 刷新WebApplicationContext
onRefresh(wac);
}
}
if (this.publishContext) {
// Publish the context as a servlet context attribute.
// 将IOC容器在应用域共享
String attrName = getServletContextAttributeName();
getServletContext().setAttribute(attrName, wac);
}
return wac;
}
(2)创建WebApplicationContext
所在类:org.springframework.web.servlet.FrameworkServlet
protected WebApplicationContext createWebApplicationContext(@Nullable ApplicationContext parent) {
Class<?> contextClass = getContextClass();
if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
throw new ApplicationContextException(
"Fatal initialization error in servlet with name '" + getServletName() +
"': custom WebApplicationContext class [" + contextClass.getName() +
"] is not of type ConfigurableWebApplicationContext");
}
// 通过反射创建 IOC 容器对象
ConfigurableWebApplicationContext wac =
(ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
wac.setEnvironment(getEnvironment());
// 设置父容器
wac.setParent(parent);
String configLocation = getContextConfigLocation();
if (configLocation != null) {
wac.setConfigLocation(configLocation);
}
configureAndRefreshWebApplicationContext(wac);
return wac;
}
(3)DispatcherServlet初始化策略
FrameworkServlet创建WebApplicationContext后,刷新容器,调用onRefresh(wac),此方法在DispatcherServlet中进行了重写,调用了initStrategies(context)方法,初始化策略,即初始化DispatcherServlet的各个组件。
所在类:org.springframework.web.servlet.DispatcherServlet
protected void initStrategies(ApplicationContext context) {
initMultipartResolver(context);
initLocaleResolver(context);
initThemeResolver(context);
initHandlerMappings(context);
initHandlerAdapters(context);
initHandlerExceptionResolvers(context);
initRequestToViewNameTranslator(context);
initViewResolvers(context);
initFlashMapManager(context);
}
3、DispatcherServlet调用组件处理请求
(1)processRequest();
FrameworkServlet重写HttpServlet中的service()和doXxx(),这些方法中调用了processRequest(request, response)
所在类:org.springframework.web.servlet.FrameworkServlet
protected final void processRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
long startTime = System.currentTimeMillis();
Throwable failureCause = null;
LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext();
LocaleContext localeContext = buildLocaleContext(request);
RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes();
ServletRequestAttributes requestAttributes = buildRequestAttributes(request, response, previousAttributes);
WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
asyncManager.registerCallableInterceptor(FrameworkServlet.class.getName(), new RequestBindingInterceptor());
initContextHolders(request, localeContext, requestAttributes);
try {
// 执行服务,doService()是一个抽象方法,在DispatcherServlet中进行了重写
doService(request, response);
}
catch (ServletException | IOException ex) {
failureCause = ex;
throw ex;
}
catch (Throwable ex) {
failureCause = ex;
throw new NestedServletException("Request processing failed", ex);
}
finally {
resetContextHolders(request, previousLocaleContext, previousAttributes);
if (requestAttributes != null) {
requestAttributes.requestCompleted();
}
logResult(request, response, failureCause, asyncManager);
publishRequestHandledEvent(request, response, startTime, failureCause);
}
}
(2)doService();
所在类:org.springframework.web.servlet.DispatcherServlet
@Override
protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {
logRequest(request);
// Keep a snapshot of the request attributes in case of an include,
// to be able to restore the original attributes after the include.
Map<String, Object> attributesSnapshot = null;
if (WebUtils.isIncludeRequest(request)) {
attributesSnapshot = new HashMap<>();
Enumeration<?> attrNames = request.getAttributeNames();
while (attrNames.hasMoreElements()) {
String attrName = (String) attrNames.nextElement();
if (this.cleanupAfterInclude || attrName.startsWith(DEFAULT_STRATEGIES_PREFIX)) {
attributesSnapshot.put(attrName, request.getAttribute(attrName));
}
}
}
// Make framework objects available to handlers and view objects.
request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE, getWebApplicationContext());
request.setAttribute(LOCALE_RESOLVER_ATTRIBUTE, this.localeResolver);
request.setAttribute(THEME_RESOLVER_ATTRIBUTE, this.themeResolver);
request.setAttribute(THEME_SOURCE_ATTRIBUTE, getThemeSource());
if (this.flashMapManager != null) {
FlashMap inputFlashMap = this.flashMapManager.retrieveAndUpdate(request, response);
if (inputFlashMap != null) {
request.setAttribute(INPUT_FLASH_MAP_ATTRIBUTE, Collections.unmodifiableMap(inputFlashMap));
}
request.setAttribute(OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());
request.setAttribute(FLASH_MAP_MANAGER_ATTRIBUTE, this.flashMapManager);
}
RequestPath requestPath = null;
if (this.parseRequestPath && !ServletRequestPathUtils.hasParsedRequestPath(request)) {
requestPath = ServletRequestPathUtils.parseAndCache(request);
}
try {
// 处理请求和响应
doDispatch(request, response);
}
finally {
if (!WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
// Restore the original attribute snapshot, in case of an include.
if (attributesSnapshot != null) {
restoreAttributesAfterInclude(request, attributesSnapshot);
}
}
if (requestPath != null) {
ServletRequestPathUtils.clearParsedRequestPath(request);
}
}
}
(3)doDispatch();
所在类:org.springframework.web.servlet.DispatcherServlet
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
boolean multipartRequestParsed = false;
WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
try {
ModelAndView mv = null;
Exception dispatchException = null;
try {
processedRequest = checkMultipart(request);
multipartRequestParsed = (processedRequest != request);
// Determine handler for the current request.
/*
mappedHandler:调用链
包含handler、interceptorList、interceptorIndex
handler:浏览器发送的请求所匹配的控制器方法
interceptorList:处理控制器方法的所有拦截器集合
interceptorIndex:拦截器索引,控制拦截器afterCompletion()的执行
*/
mappedHandler = getHandler(processedRequest);
if (mappedHandler == null) {
noHandlerFound(processedRequest, response);
return;
}
// Determine handler adapter for the current request.
// 通过控制器方法创建相应的处理器适配器,调用所对应的控制器方法
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// Process last-modified header, if supported by the handler.
String method = request.getMethod();
boolean isGet = "GET".equals(method);
if (isGet || "HEAD".equals(method)) {
long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
return;
}
}
// 调用拦截器的preHandle()
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
// Actually invoke the handler.
// 由处理器适配器调用具体的控制器方法,最终获得ModelAndView对象
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
if (asyncManager.isConcurrentHandlingStarted()) {
return;
}
applyDefaultViewName(processedRequest, mv);
// 调用拦截器的postHandle()
mappedHandler.applyPostHandle(processedRequest, response, mv);
}
catch (Exception ex) {
dispatchException = ex;
}
catch (Throwable err) {
// As of 4.3, we're processing Errors thrown from handler methods as well,
// making them available for @ExceptionHandler methods and other scenarios.
dispatchException = new NestedServletException("Handler dispatch failed", err);
}
// 后续处理:处理模型数据和渲染视图
processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}
catch (Exception ex) {
triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
}
catch (Throwable err) {
triggerAfterCompletion(processedRequest, response, mappedHandler,
new NestedServletException("Handler processing failed", err));
}
finally {
if (asyncManager.isConcurrentHandlingStarted()) {
// Instead of postHandle and afterCompletion
if (mappedHandler != null) {
mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
}
}
else {
// Clean up any resources used by a multipart request.
if (multipartRequestParsed) {
cleanupMultipart(processedRequest);
}
}
}
}
(4)processDispatchResult();
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
@Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
@Nullable Exception exception) throws Exception {
boolean errorView = false;
if (exception != null) {
if (exception instanceof ModelAndViewDefiningException) {
logger.debug("ModelAndViewDefiningException encountered", exception);
mv = ((ModelAndViewDefiningException) exception).getModelAndView();
}
else {
Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
mv = processHandlerException(request, response, handler, exception);
errorView = (mv != null);
}
}
// Did the handler return a view to render?
if (mv != null && !mv.wasCleared()) {
// 处理模型数据和渲染视图
render(mv, request, response);
if (errorView) {
WebUtils.clearErrorRequestAttributes(request);
}
}
else {
if (logger.isTraceEnabled()) {
logger.trace("No view rendering, null ModelAndView returned.");
}
}
if (WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
// Concurrent handling started during a forward
return;
}
if (mappedHandler != null) {
// Exception (if any) is already handled..
// 调用拦截器的afterCompletion()
mappedHandler.triggerAfterCompletion(request, response, null);
}
}
4、SpringMVC的执行流程
(1)用户向服务器发送请求,请求被SpringMVC前端控制器DispatcherServlet捕获;
(2)DispatcherServlet对请求URL进行解析,得到请求资源标识符(URI),判断请求URI对应的映射:
-
不存在
- 再判断是否配置了default-servlet-handler(处理静态资源);
- 如果没配置,则展示404错误;
错误:“no mapping for …”
- 如果有配置,则访问目标资源(一般为静态资源,如:js、css、html),找不到也会展示404。
错误:“DefaultServletHttpRequestHandler”
-
存在
- 根据该URI,调用HandlerMapping获得该Handler配置的所有相关的对象(包括Handler对象以及Handler对象对应的拦截器),最后以HandlerExecutionChain执行链对象的形式返回;
- DispatcherServlet 根据获得的Handler,选择一个合适的HandlerAdapter;
- 如果成功获得HandlerAdapter,此时将开始执行拦截器的preHandler(…)方法【正向】;
- 提取Request中的模型数据,填充Handler入参,开始执行Handler(Controller)方法,处理请求。在填充Handler的入参过程中,根据你的配置,Spring将帮你做一些额外的工作:
- HttpMessageConveter:将请求消息(如Json、xml等数据)转换成一个对象,将对象转换为指定的响应信息;
- 数据转换:对请求消息进行数据转换。如String转换成Integer、Double等;
- 数据格式化:对请求消息进行数据格式化。 如将字符串转换成格式化数字或格式化日期等;
- 数据验证: 验证数据的有效性(长度、格式等),验证结果存储到BindingResult或Error中。
- Handler执行完成后,向DispatcherServlet 返回一个ModelAndView对象;
- 此时将开始执行拦截器的postHandle(…)方法【逆向】;
- 根据返回的ModelAndView(此时会判断是否存在异常:如果存在异常,则执行HandlerExceptionResolver进行异常处理)选择一个适合的ViewResolver进行视图解析,根据Model和View,来渲染视图;
- 渲染视图完毕执行拦截器的afterCompletion(…)方法【逆向】;
- 将渲染结果返回给客户端。
请求 --> 前端控制器 --> 拦截器(preHandle()正向,postHandle()和afterCompletion()逆向) --> 异常处理 --> 返回