SpringMVC

文章目录

一 SpringMVC简介

1.1 什么是MVC

MVC是一种软件架构的思想,将软件架构按照模型、视图、控制器的结构来进行划分。

M:Model,模型层,指的是工程中的JavaBean,作用是处理数据。JavaBean分为两类:

  • 一类称为实体Bean,专门用于存储数据,与数据库表对应。如Student、User等
  • 一类称为业务Bean,指Service、Dao层的对象,专门用于处理业务逻辑和数据访问。一般由Sring容器进行管理。

V:View,视图层,指工程中的前段页面,一般是Html或者是Jsp页面。

C:Controller,控制层,指工程中的Servlet,作用是接受浏览器的请求和对浏览器进行响应。

MVC的工作流程:用户通过浏览器的视图层发送请求到服务器,在服务器中被Controller层响应的Servlet接收,Controller层调用Model层的Service和Dao进行数据处理,获得数据处理的结果,Controller层再将数据处理的结果返回给响应的View。早期会返回给视图解析器(例如Jsp、Thymeleaf等)进行页面渲染。目前而言一般返回的是固定格式的Json数据,前端页面完全交给前端工程师进行渲染。

1.2 什么是SpringMVC

SpringMVC是Spring后续的产品,是Spring的一个子项目。

SpringMVC是Spring为了表述层(控制层+视图层)开发提供的一套完整的解决方案。在表述层经历了Strust、WebWork、Strust2等诸多产品的历代迭代之后,目前业界普遍选择了SpringMVC作为Java EE的表述层首选方案

1.3 SpringMVC的特点

  • Spring家族的原生产品,与IOC容器等基础设施无缝对接
  • 基于原生的Servlet,通过功能强大的前段控制器DispatcherServlet,对请求和响应进行统一处理
  • 对表述层的问题进行全方面的覆盖,提供全面的解决方案
  • 代码清晰简洁,大幅提升开发效率
  • 内部组件化程度高,相应的组件即插即用
  • 性能卓著,尤其适合现代大型、超大型互联网项目的需求

二 SpringMVC开发环境配置

2.1 开发环境

IDE;IDEA 2021.3

构建工具:maven3.6.3

服务器:tomcat9.0.64

Spring版本:5.3.1

2.2 创建maven工程

  1. 添加web模块,新版本的IDEA可以直接右键->Add Framework Support即可添加web模块

  2. 设置打包方式为war

  3. 引入SpringMVC相关依赖

    <dependencies>
        <!-- SpringMVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.1</version>
        </dependency>
        <!-- 日志 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- ServletAPI -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>
        <!-- Spring5和Thymeleaf整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
    </dependencies>
    

    注:由于maven的传递性,我们不必将所有需要的包全部配置依赖,而是配置最顶端的依赖,其他靠传递性导入。
    在这里插入图片描述

2.3 配置web.xml

配置web.xml就是配置web服务器。需要给web服务器配置一些SpringMVC的组件,比如DispatcherServlet。

  • 默认配置方式:在此配置下,SpringMVC的默认配置文件位于WEB-INF下,默认名称为<servlet-name>-servlet.xml。例如以下配置文件所对应的SpringMVC配置文件位于WEB-INF下,名称为SpringMVC.xml

    <!-- 配置SpringMVC的前端控制器,对浏览器发送的请求统一进行处理 -->
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servletclass>
    </servlet>
    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <!--
    		注意,此处是/而不是/*
    	-->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    
  • 扩展配置方式:可以通过init-parm标签设置SpringMVC配置文件的名称和位置,通过load-on-startup标签设置SpringMVC配置文件和前段控制器DispatcherServlet的初始化时间。

    <!-- 配置SpringMVC的前端控制器,对浏览器发送的请求统一进行处理 -->
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servletclass>
        <!-- 通过初始化参数指定SpringMVC配置文件的位置和名称 -->
        <init-param>
            <!-- contextConfigLocation为固定值 -->
            <param-name>contextConfigLocation</param-name>
            <!-- 使用classpath:表示从类路径查找配置文件,例如maven工程中的src/main/resources -->
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <!--
    		作为框架的核心组件,在启动过程中有大量的初始化操作要做
    		而这些操作放在第一次请求时才执行会严重影响访问速度
    		因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时
    	-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <!--
    		注意,此处是/而不是/*
    	-->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    

    标签中使用//*的区别:

    • 设置springMVC的核心控制器所能处理的请求的请求路径,/所匹配的请求可以是/login或.html或.js或.css方式的请求路径,但是/不能匹配.jsp请求路径的请求。/*则能够匹配所有请求,例如在使用过滤器时,若需要对所有请求进行过滤,就需要使用/*的写法。
    • 在SpringMVC中,DispatcherServlet并不能处理.jsp结尾的请求,要把这种请求交给原生Servlet进行处理。

2.4 创建请求控制器

由于前段控制器对浏览器发送的请求进行了统一的处理,但具体的请求有不同的处理过程,因此需要创建处理具体请求的类,即请求控制器

请求控制器中每一个处理请求的方法称为控制器方法

在SpringMVC中,请求控制器由一个普通的Java类担任,因此需要注解@Controller来标识其为一个控制层组件,交由Spring的IOC容器进行管理。此时SpringMVC才能识别控制器的存在。

@Controller
public class HelloController {
    // 编写相应的控制器方法
}

2.5 创建SpringMVC的配置文件

<!-- 配置自动扫描的包 -->
<context:component-scan base-package="com.atguigu.mvc.controller"/>    
    
<!-- 配置视图解析器 -->
<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>    
<!-- 处理静态资源 -->
<mvc:default-servlet-handler/>
<!-- 开启MVC注解驱动 -->
<mvc:annotation-driven>
	<mvc:message-converters>
		<!-- 处理响应中文内容乱码 -->
		<bean class="org.springframework.http.converter.StringHttpMessageConverter">
			<property name="defaultCharset" value="UTF-8" />
			<property name="supportedMediaTypes">
				<list>
					<value>text/html</value>
					<value>application/json</value>
				</list>
			</property>
		</bean>
	</mvc:message-converters>
</mvc:annotation-driven>
<!-- 配置视图控制器 -->    

2.6 测试HelloWprld

  1. 实现对首页的访问:

    // @RequestMapping注解:处理请求和控制器方法之间的映射关系
    // @RequestMapping注解的value属性可以通过请求地址匹配请求,/表示的当前工程的上下文路径
    // localhost:8080/springMVC/
    @RequestMapping("/")
    public String index() {
        //设置视图名称
        return "index";
    }
    
  2. 通过超链接跳转指定页面

    <!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
        <head>
            <meta charset="UTF-8">
            <title>首页</title>
        </head>
        <body>
            <h1>首页</h1>
            <a th:href="@{/hello}">HelloWorld</a><br/>
        </body>
    </html>
    
  3. 在请求控制器中创建处理请求的方法

    @RequestMapping("/hello")
    public String HelloWorld() {
        return "target";
    }
    

2.7 总结

浏览器发送请求,若请求地址符合前端控制器的url-pattern,请求会被前端控制器DispatcherServlet处理。前端控制器会读取SpringMVC的核心配置文件,通过扫描组件找到对应的控制器方法,将请求地址和控制器中的@RequestMapping注解的value属性进行匹配。若匹配成功,该注解锁标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称(目前来说大部分都是返回json类型的字符串给前端),该视图名称会被视图解析器解析,加上前缀后缀组成视图的路径,通过Thymeleaf进行渲染,最终转到视图所对应的页面。

三 @RequestMapping注解

3.1 @RequestMapping注解的功能

从注解名称上来看,@RequestMapping注解的作用就是将请求和处理请求的控制器方法联系起来,简历映射关系。

SpringMVC接收到指定的请求,就会来找到映射关系中的控制器方法来处理这个请求。

3.2 @RequestMapping注解的位置

@RequestMapping标识一个类:设置映射请求的请求路径的初始信息

@RequestMapping标识一个方法:设置映射请求的请求路径的具体信息

@Controller
@RequestMapping("/test")
public class RequestMappingController {
    //此时请求映射所映射的请求的请求路径为:/test/testRequestMapping
    @RequestMapping("/testRequestMapping")
    public String testRequestMapping(){
        return "success";
    }
}

3.3 @RequestMapping注解的value属性

@RequestMapping注解的value属性表示用于匹配的url地址,是一个字符串类型的数组,表示该请求映射能够匹配多个请求地址所对应的请求。

@RequestMapping注解的value属性必须要设置,至少通过请求地址匹配请求映射。

<a th:href="@{/testRequestMapping}">
    测试@RequestMapping的value属性-->/testRequestMapping
</a>
<br>
<a th:href="@{/test}">
    测试@RequestMapping的value属性-->/test
</a>
<br>
@RequestMapping(
    value = {"/testRequestMapping", "/test"}
)
public String testRequestMapping(){
    return "success";
}

上述两个请求都能够被testRequestMapping()方法进行处理。

3.4 @RequestMapping注解的method属性

@RequestMapping注解的method属性表示匹配请求的请求方式,同样是一个数组,表示该请求能够匹配多种请求方式的请求。

若当前请求的地址满足映射value的属性,但是请求方式不满足method属性,则浏览器报错405:Request method ‘XXXX’ not supported

<a th:href="@{/test}">
    测试@RequestMapping的value属性-->/test
</a>
<br>
<form th:action="@{/test}" method="post">
    <input type="submit">
</form>
@RequestMapping(
    value = {"/testRequestMapping", "/test"},
    method = {RequestMethod.GET, RequestMethod.POST}
)
public String testRequestMapping(){
    return "success";
}

对于处理指定请求方式的控制器方法,SpringMVC中提供了@RequestMapping的派生注解:

  • 处理get请求的映射–>GetMapping
  • 处理post请求的映射–>PostMapping
  • 处理put请求的映射–>PutMapping
  • 处理delete请求的映射–>DeleteMapping

但目前浏览器只支持get和post方式的请求,如果要发送put和delete方式的请求,要先用post方式发送请求,然后在请求中进行设置。一般put和delete都是通过表单发送的,具体方式是在表单中设置隐藏域,name默认为_method,value则是真正需要发送的请求方式。此时要配置过滤器HiddenHttpMethodFilter

3.5 @RequestMapping注解的params属性

@RequestMapping注解的params属性通过请求的请求参数匹配请求映射,是一个字符串类型的数组,可以通过四种表达式设置请求参数和请求映射的匹配关系:

  • param:要求请求映射所匹配的请求必须携带param属性指定的参数
  • !param:要求请求映射所匹配的请求必须不能携带param属性指定的参数
  • param=value:要求请求映射所匹配的请求必须携带param属性指定的值为value的参数
  • param!=value:要求请求映射所匹配的请求必须携带参数,但不能为param属性指定的value参数
<a th:href="@{/test(username='admin',password=123456)"}>
    测试@RequestMapping的params属性-->/test
</a>
<br>
@RequestMapping(
    value = {"/testRequestMapping", "/test"},
    method = {RequestMethod.GET, RequestMethod.POST},
    params = {"username","password!=123456"}
)
public String testRequestMapping(){
    return "success";
}

上述请求将不能被testRequestMapping处理,若没有其他控制器处理该请求,则会报错400:Parameter conditions “username, password!=123456” not met for actual request parameters: username={admin}, password={123456}。

3.6 @RequestMapping注解的headers属性

@RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射,是一个字符串类型的数组,可以通过四种表达式设置请求头信息和请求映射的匹配关系:

  • header:要求请求映射所匹配的请求必须携带header属性指定的请求头信息
  • !header:要求请求映射所匹配的请求必须不能携带header属性指定的请求头信息
  • header=value:要求请求映射所匹配的请求必须携带header属性指定的值为value请求头信息
  • header!=value:要求请求映射所匹配的请求必须携带请求头信息,但不能为header属性指定的value请求头信息

若当前请求满足@RequestMapping注解的value和method属性,但是不满足headers属性,此时页面显示404错误,即资源未找到

3.7 SpringMVC支持ant风格的路径

?:表示任意单个字符

*:表示任意的0个或多个字符

**:表示任意层数的任意目录

注意:在使用**时,只能使用/**/xxx的形式

3.8 SpringMVC中的占位符(重点)

SpringMVC路径中的占位符常用语RESTful风格中,当请求路径中将某些数据通过路径的方式传输到服务器,就可以在相应的@RequestMapping注解的value属性中通过占位符{xxx}表示传输的数据,再通过@PathVariable注解,将占位符所表示的数据复制给控制器方法的形参。

<a th:href="@{/testRest/1/admin}">
    测试路径中的占位符-->/testRest
</a>
<br>
@RequestMapping("/testRest/{id}/{username}")
public String testRest(@PathVariable("id") String id, @PathVariable("username")String username){
    System.out.println("id:"+id+",username:"+username);
    return "success";
}
//最终输出的内容为-->id:1,username:admin

四 SpringMVC获取请求参数

4.1 通过ServletAPI获取

将HttpServletRequest作为控制器方法的形参,此时HttpServletRequest类型的参数表示封装了当前请求的请求报文对象。再通过HttpServletRequest的getParameter方法来获取保存在请求域中的参数。

@RequestMapping("/testParam")
public String testParam(HttpServletRequest request){
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    System.out.println("username:"+username+",password:"+password);
    return "success";
}

4.2 通过控制器方法的形参获取请求参数

在控制器方法的形参位置,设置和请求参数同名的形参,当浏览器发送请求,匹配到请求映射时,在DispatcherServlet中就会将请求参数赋值给相应的形参。

<a th:href="@{/testParam(username='admin',password=123456)}">
    测试获取请求参数-->/testParam
</a>
<br>
@RequestMapping("/testParam")
public String testParam(String username, String password){
    System.out.println("username:"+username+",password:"+password);
    return "success";
}

若请求所传输的请求参数中有多个同名的请求参数,此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数

若使用字符串数组类型的形参,此参数的数组中包含了每一个数据

若使用字符串类型的形参,此参数的值为每个数据中间使用逗号拼接的结果

4.3 @RequestParam

@ResuestParam的作用是将请求参数和控制器方法形参创建映射关系,一共有三个属性

  • value:指定和形参匹配的请求参数的参数名
  • required:社遏制是否必须传输此请求参数,默认为true。当required为true时,若请求没有传输此参数,且没有设置defaultValue,则页面会报400:Required String parameter ‘xxx’ is not present。
  • defaultValue:不管required属性值为true或false,当value所指定的请求参数没有传输或者传输的值为""时,则使用默认值为形参赋值。

4.4 @RequestHeader

@RequestHeader的作用是将请求头信息和控制器方法的形参创建映射关系,一共有三个属性:value、required、defaultValue,用法同@RequestParam

4.5 @CookieValue

@CookieValue的作用是将cookie数据和控制器方法的形参创建映射关系,一共有三个属性:value、required、defaultValue,用法同@RequestParam

4.6 通过POJO获取请求参数

可以在控制器方法的形参位置设置一个实体类类型的形参,此时若浏览器传输的请求的参数名和实体类中的属性名一致,那么请求参数就会为此属性赋值

<form th:action="@{/testpojo}" method="post">
    用户名:<input type="text" name="username"><br>
    密码:<input type="password" name="password"><br>
    性别:<input type="radio" name="sex" value=""><input type="radio" name="sex" value=""><br>
    年龄:<input type="text" name="age"><br>
    邮箱:<input type="text" name="email"><br>
    <input type="submit">
</form>
@RequestMapping("/testpojo")
public String testPOJO(User user){
    System.out.println(user);
    return "success";
}
//最终结果-->User{id=null, username='张三', password='123', age=23, sex='男',email='123@qq.com'}

4.7 解决请求参数乱码的问题

解决获取请求参数乱码的问题,可以使用SpringMVC提供的编码过滤器CharacterEncodingFilter,但是必须在web.xml中进行配置。

<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

SpringMVC中编码过滤器一定要配置在其他过滤器之前,否则无效

五 域对象共享数据

5.1 使用ServletAPI向request域对象共享数据

在控制器方法的形参设置HttpServletRequest参数,并通过setAttribute方法共享数据

@RequestMapping("/testServletAPI")
public String testServletAPI(HttpServletRequest request){
    request.setAttribute("testScope", "hello,servletAPI");
    return "success";
}

5.2 使用ModelAndView向request域对象共享数据

在控制器方法中创建ModelAndView对象,并使用addObject方法共享数据

@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
    /**
	 * ModelAndView有Model和View的功能
	 * Model主要用于向请求域共享数据
	 * View主要用于设置视图,实现页面跳转
	 */
    ModelAndView mav = new ModelAndView();
    //向请求域共享数据
    mav.addObject("testScope", "hello,ModelAndView");
    //设置视图,实现页面跳转
    mav.setViewName("success");
    return mav;
}

5.3 使用Model向request域对象共享数据

在控制器方法的形参设置Model参数,并通过addAttribute方法共享数据

@RequestMapping("/testModel")
public String testModel(Model model){
    model.addAttribute("testScope", "hello,Model");
    return "success";
}

5.4 使用map向request域对象共享数据

在控制器方法的形参设置Map参数,并通过put方法共享数据

@RequestMapping("/testMap")
public String testMap(Map<String, Object> map){
    map.put("testScope", "hello,Map");
    return "success";
}

5.5 使用ModelMap向request域对象共享数据

在控制器方法的形参设置ModelMap参数,并通过addAttribute方法共享数据

@RequestMapping("/testModelMap")
public String testModelMap(ModelMap modelMap){
    modelMap.addAttribute("testScope", "hello,ModelMap");
    return "success";
}

5.6 Model、ModelMap、Map的关系

Model、ModelMap、Map类型的参数最终都会由DispatcherServlet创建一个BindingAwareModelMap类型的对象

public interface Model{}
public class ModelMap extends LinkedHashMap<String, Object> {}
public class ExtendedModelMap extends ModelMap implements Model {}
public class BindingAwareModelMap extends ExtendedModelMap {}

事实上,只要形参列表中设置一个BindingAwareModelMap继承的父类或者实现的接口,都可以想request域对象共享数据。

5.7 向Session域共享数据

@RequestMapping("/testSession")
public String testSession(HttpSession session){
    session.setAttribute("testSessionScope", "hello,session");
    return "success";
}

5.8 向Application共享数据

@RequestMapping("/testApplication")
public String testApplication(HttpSession session){
    ServletContext application = session.getServletContext();
    application.setAttribute("testApplicationScope", "hello,application");
    return "success";
}

六 SpringMVC视图

SpringMVC中的视图是View接口,视图的作用是渲染数据,将模型中的数据展示给用户

SpringMVC视图的种类很多,默认有转发视图和重定向视图

当工程引入jstl的依赖,转发视图会自动转换为jstlView

若使用的视图技术为Thymeleaf,在SpringMVC的配置文件中配置了Thymeleaf的视图解析器,由此视图解析器解析之后得到的是ThymeleafView

6.1 ThymeleafView

当控制器方法所设置的视图名称没有任何的前缀时,此时的视图名称会被SpringMVC配置文件所配置的视图解析器解析,视图名称拼接视图前缀和视图后缀得到最终路径,会通过转发的方式实现页面跳转。

@RequestMapping("/testHello")
public String testHello(){
    return "hello";
}

在这里插入图片描述

6.2 转发视图

SpringMVC中默认的转发视图是InternalResourceView。

当控制器方法锁设置的视图名称以"forward:"为前缀时,创建InternalResorceView视图,此时的视图名称不会被SpringMVC配置文件中的视图解析器解析,而是会将前缀中的"forward:"去掉,剩余部分作为最终路径通过转发的方式实现页面跳转(不会进行前缀后悔拼接,因此在转发访问静态资源时慎用)。》

@RequestMapping("/testForward")
public String testForward(){
    return "forward:/testHello";
}

在这里插入图片描述

在SpringMVC中一般比较少使用转发视图,因为Thymeleaf视图就是通过转发实现的,一般不会用转发视图来访问静态资源,只会访问接口。在这种情况下,不如直接使用thymeleaf视图直接访问。

6.3 重定向视图

SpringMVC中的重定向视图默认是RedirectView

当控制器方法所设置的视图名称以"redirect:"为前缀时,创建RedirectView视图,此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析,而是会将前缀"redirect:"去掉,剩余部分作为最终路径通过重定向的方式实现跳转。

@RequestMapping("/testRedirect")
public String testRedirect(){
    return "redirect:/testHello";
}

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EdCZXrn3-1677495380972)(C:\Users\86198\Desktop\Java技术栈\SpringMVC.assets\image-20230227014035076.png)]

重定向视图在解析时,会先将redirect:前缀去掉,然后会判断剩余部分是否以/开头,若是则会自动拼接上下文路径

6.4 视图控制器view-controller

当控制器方法中,仅仅用来实现页面跳转,即只需要设置视图名称时,可以将控制器方法使用view-controller标签进行表示

<!--
	path:设置处理的请求地址
	view-name:设置请求地址所对应的视图名称
-->
<mvc:view-controller path="/testView" view-name="success"></mvc:view-controller>

当SpringMVC中设置任何一个view-controller时,其他控制器中的请求全部失效,此时需要在SpringMVC核心配置文件中开启mvc注解驱动的标签

<mvc:annotataion-driven>

七 RESTful

7.1 RESTful简介

REST:Representational State Transfer,表现层资源状态转移

  1. 资源

    资源是一种看待服务器的方式,即,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个 可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、 数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端 应用开发者能够理解。与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个 资源可以由一个或多个URI来标识。URI既是资源的名称,也是资源在Web上的地址。对某个资源感兴 趣的客户端应用,可以通过资源的URI与其进行交互。

  2. 资源的表述

    资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移(交换)。资源的表述可以有多种格式,例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格 式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。

  3. 状态转移

    状态转移说的是:在客户端和服务器端之间转移(transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的。

简单的来说,就是通过统一的路径+请求的方式实现对某一资源的增删改查,然后服务器通过相应状态码来返回操作的结果

7.2 RESTful的实现

具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE

它们分别来对应四种基本操作:GET用来获取资源,POST用来创建新资源,PUT用来更新资源,DELETE用来删除资源。

RESTful风格提倡URL地址使用统一的风格设计,从后面各个单词使用\分开,不使用问号键值对的方式携带请求数据,而是将这些数据作为URL地址的一部分,以保证整体风格的一致性。

在这里插入图片描述

7.3 HiddenHttpMethodFilter

由于浏览器只支持发送get和post方式的请求,那么该如何发送put和delete请求呢?

SpringMVC提供了HiddenHttpMethodFilter帮助将POST请求转换为DELETE或PUT请求。HiddenHttpMethodFilter处理put请求和delete请求的条件:

  • 当前请求的请求方式必须为post
  • 当前请求必须传输请求参数_method

满足以上条件,HiddenHttpMethodFilter过滤器就会将当前请求的请求方式转换为请求参数_method的值,因此请求参数_method的值才是最终的请求方式

在web.xml中注册HiddenHttpMethodFilter

<filter>
    <filter-name>HiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filterclass>
</filter>
<filter-mapping>
    <filter-name>HiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

八 SpringMVC处理ajax请求

8.1 @RequestBody

@RequestBody可以获取请求信息,使用@RequestBody注解标识控制器方法的形参,当前请求的请求体就会为当前标识的形参赋值

<!--此时必须使用post请求方式,因为get请求没有请求体-->
<form th:action="@{/test/RequestBody}" method="post">
    用户名:<input type="text" name="username"><br>
    密码:<input type="password" name="password"><br>
    <input type="submit">
</form>
@RequestMapping("/test/RequestBody")
public String testRequestBody(@RequestBody String requestBody){
    System.out.println("requestBody:"+requestBody);
    return "success";
}
// 结果输出:requestBody:username=admin&password=123456

8.2 @RequestBody获取json格式的请求参数

在使用了axios发送ajax请求后,浏览器发送到服务器的参数有两种格式:

  1. name=value&name=value…,此时的参数可以通过request.getParamater()获取,对应SpringMVC中,可以直接通过控制器方法的形参获取此类请求的参数。
  2. {key:value, key:value…},此时无法通过request.getParamater()获取参数,可以使用操作json的相关jar包gson或者jackson处理此类请求参数,可以将其转换为指定的实体类对象或map集合。在SpringMVC中,直接使用@RequestBody注解标识控制器方法的形参可以将此类请求参数转化为java对象。

使用@RequestBody获取json格式的请求参数的条件:

  1. 导入jackson依赖

    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.12.1</version>
    </dependency
    
  2. 在SpringMVC核心配置文件中设置开启mvc的注解驱动

    <!--开启mvc的注解驱动-->
    <mvc:annotation-driven />
    
  3. 在控制器方法的形参位置,设置json格式的请求参数要转化成的java类型(实体类或map)的参数,并用@RequestBody注解标识

    <input type="button" value="测试@RequestBody获取json格式的请求参数"
           @click="testRequestBody()"><br>
    <script type="text/javascript" th:src="@{/js/vue.js}"></script>
    <script type="text/javascript" th:src="@{/js/axios.min.js}"></script>
    <script type="text/javascript">
        var vue = new Vue({
            el:"#app",
            methods:{
                testRequestBody(){
                    axios.post(
                        "/SpringMVC/test/RequestBody/json",
                        {username:"admin",password:"123456"}
                    ).then(response=>{
                        console.log(response.data);
                    });
                }
            }
        });
    </script>
    
    //将json格式的数据转换为map集合
    @RequestMapping("/test/RequestBody/json")
    public void testRequestBody(@RequestBody Map<String, Object> map, HttpServletResponse response) throws IOException {
        System.out.println(map);
        //{username=admin, password=123456}
        response.getWriter().print("hello,axios");
    }
    //将json格式的数据转换为实体类对象
    @RequestMapping("/test/RequestBody/json")
    public void testRequestBody(@RequestBody User user, HttpServletResponse response) throws IOException {
        System.out.println(user);
        //User{id=null, username='admin', password='123456', age=null, gender='null'}
    	response.getWriter().print("hello,axios");
    }
    

8.3 @ResponseBody

@ResponseBody用于标识一个控制器方法,可以将该方法的返回值直接作为响应报文的响应体响应到浏览器

@RequestMapping("/testResponseBody")
public String testResponseBody(){
    //此时会跳转到逻辑视图success所对应的页面
    return "success";
}
@RequestMapping("/testResponseBody")
@ResponseBody
public String testResponseBody(){
    //此时响应浏览器数据success
    return "success";
}

8.4 @ResponseBody响应浏览器json数据

服务器处理完ajax请求后,大多数情况都要想浏览器响应一个java对象,此时必须将java对象转化为json字符串才可以响应到浏览器,可以使用之前我们使用操作json的jar包gson或jackson将java对象转化为json字符串。在SpringMVC中,我们可以使用@ResponseBody注解直接将java对象当作json字符串返回给浏览器。

@ResponseBody响应浏览器json数据的条件:

  1. 导入jackson依赖

  2. 在SpringMVC核心配置文件中设置开启mvc的注解驱动

  3. 使用@ResponseBody注解标识控制器方法,在方法中,将需要转换为json字符串并响应到浏览器的java对象作为控制器方法的返回值,此时SpringMVC就可以将此对象直接转化为json字符串并响应到浏览器。

    <input type="button" value="测试@ResponseBody响应浏览器json格式的数据" @click="testResponseBody()"><br>
    <script type="text/javascript" th:src="@{/js/vue.js}"></script>
    <script type="text/javascript" th:src="@{/js/axios.min.js}"></script>
    <script type="text/javascript">
        var vue = new Vue({
            el:"#app",
            methods:{
                testResponseBody(){
                    axios.post("/SpringMVC/test/ResponseBody/json").then(response=>{
                        console.log(response.data);
                    });
                }
            }
        });
    </script>
    
    //响应浏览器list集合
    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public List<User> testResponseBody(){
        User user1 = new User(1001,"admin1","123456",23,"男");
        User user2 = new User(1002,"admin2","123456",23,"男");
        User user3 = new User(1003,"admin3","123456",23,"男");
        List<User> list = Arrays.asList(user1, user2, user3);
        return list;
    }
    //响应浏览器map集合
    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public Map<String, Object> testResponseBody(){
        User user1 = new User(1001,"admin1","123456",23,"男");
        User user2 = new User(1002,"admin2","123456",23,"男");
        User user3 = new User(1003,"admin3","123456",23,"男");
        Map<String, Object> map = new HashMap<>();
        map.put("1001", user1);
        map.put("1002", user2);
        map.put("1003", user3);
        return map;
    }
    //响应浏览器实体类对象
    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public User testResponseBody(){
        return user;
    }
    

8.5 @RestController注解

@RestController注解是SpringMVC提供的一个符合注解,标识在控制器的类上,就相当于为类添加了@Controller注解,并且为类中的每个方法添加了@ResponseBody注解

九 文件上传和下载

9.1 文件下载

ResponseEntity用于控制器方法的返回类型,该控制器方法返回值就是响应到浏览器的响应报文。

使用ResponseEntity实现下载文件的功能

@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws
    IOException {
    //获取ServletContext对象
    ServletContext servletContext = session.getServletContext();
    //获取服务器中文件的真实路径
    String realPath = servletContext.getRealPath("/static/img/1.jpg");
    //创建输入流
    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=1.jpg");
    //设置响应状态码
    HttpStatus statusCode = HttpStatus.OK;
    //创建ResponseEntity对象
    ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers,
                                                                 statusCode);
    //关闭输入流
    is.close();
    return responseEntity;
}

9.2 文件上传

文件上传要求form表单的请求方式必须为post,并且添加属性enctype=“multipart/form-data”

SpringMVC中将上传的文件封装到MultipartFile对象中,通过此对象可以获取文件相关信息

文件上传的步骤:

  1. 添加依赖

    <!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
    <dependency>
        <groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.3.1</version>
    </dependency>
    
  2. 在SpringMVC配置文件中添加配置:

    <!--必须通过文件解析器的解析才能将文件转换为MultipartFile对象-->
    <!--并且id必须为multipartResolver-->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    </bean>
    
  3. 编写控制器方法

    @RequestMapping("/testUp")
    public String testUp(MultipartFile photo, HttpSession session) throws
        IOException {
        //获取上传的文件的文件名
        String fileName = photo.getOriginalFilename();
        //处理文件重名问题
        String hzName = fileName.substring(fileName.lastIndexOf("."));
        fileName = UUID.randomUUID().toString() + hzName;
        //获取服务器中用于保存上传文件的目录的路径
        ServletContext servletContext = session.getServletContext();
        String photoPath = servletContext.getRealPath("photo");
        File file = new File(photoPath);
        if(!file.exists()){
            file.mkdir();
        }
        // 最终上传的文件的路径
        String finalPath = photoPath + File.separator + fileName;
        //实现上传功能
        photo.transferTo(new File(finalPath));
        return "success";
    }
    

十 拦截器

10.1 拦截器的配置

SpringMVC中的拦截器用于拦截控制器方法的执行

SpringMVC中的拦截器需要实现HandlerInterceptor

SpringMVC中的拦截器必须在SpringMVC的配置文件中进行配置

<bean class="com.atguigu.interceptor.FirstInterceptor"></bean>
<ref bean="firstInterceptor"></ref>
<!-- 以上两种配置方式都是对DispatcherServlet所处理的所有的请求进行拦截 -->
<mvc:interceptor>
    // /**表示能够处理所有层级的请求,/*只能处理一层请求
    <mvc:mapping path="/**"/>
    <mvc:exclude-mapping path="/testRequestEntity"/>
    <ref bean="firstInterceptor"></ref>
</mvc:interceptor>
<!--
 	以上配置方式可以通过ref或bean标签设置拦截器
 	通过mvc:mapping设置需要拦截的请求
 	通过mvc:exclude-mapping设置需要排除的请求,即不需要拦截的请求
-->

10.2 拦截器的三个抽象方法

SpringMVC的拦截器有三个抽象方法:

  1. preHandle:控制方法执行之前执行preHandle(),其boolean类型的返回值表示是否拦截或放行。返回true为放行,返回false为拦截
  2. postHandle:控制器方法执行之后执行postHandle()
  3. afterCompletion:处理完视图和模型数据,渲染视图完毕之后执行afterCompletion()

10.3 多个拦截器的执行顺序

  1. 若每个拦截器的preHandle()都返回true,则拦截器的执行顺序和拦截器在SpringMVC配置文件中配置的顺序有关:
    • preHandle会顺序执行,postHandle和afterCompletion会逆序执行
  2. 若某个拦截器的preHandle()返回了false,则之前拦截器的preHandle()都会执行,postHandle()都不执行,返回false的拦截器之前的拦截器的afterCompletion()会执行

十一 异常处理器

11.1 基于配置的异常处理

SpringMVC提供了一个处理控制器方法执行过程中出现的异常的接口:HandlerExceptionResolver

HandlerExceptionResolver接口的实现类有:DefaultHandlerExceptionResolver和SimpleMappingExceptionResolver

SpringMVC提供了自定义的异常处理器SimpleMappingExceptionResolver,使用方式:

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            <!--
				properties的键表示处理器方法执行过程中出现的异常
				properties的值表示若出现指定异常时,设置一个新的视图名称,跳转到指定页面
			-->
            <prop key="java.lang.ArithmeticException">error</prop>
        </props>
    </property>
    <!--
		exceptionAttribute属性设置一个属性名,将出现的异常信息在请求域中进行共享
	-->
    <property name="exceptionAttribute" value="ex"></property>
</bean>

11.2 基于注解的异常处理

使用@ControllerAdvice将当前类标识为一个异常处理组件,交由Spring的IOC容器进行管理

@ControllerAdvice
public class ExceptionController {
    //@ExceptionHandler用于设置所标识方法处理的异常
    @ExceptionHandler(ArithmeticException.class)
    //ex表示当前请求处理中出现的异常对象
    public String handleArithmeticException(Exception ex, Model model){
        model.addAttribute("ex", ex);
        return "error";
    }
}

十二 注解配置SpringMVC

使用配置类和注解代替web.xml和SpringMVC配置文件

12.1 创建初始化类,代替web.xml

在Servlet3.0中,容器会在类路径中查找实现了javax.servlet.ServletContainerInitializer接口的类,如果找到的话就用它来配置Servlet容器。

Spring提供了这个接口的实现,名为SpringServletContainerInitializer,这个类会反过来查找实现了WebApplicationInitializer的类并把配置的任务交给它们来完成。Spring3.2引入了一个便利的WebApplicationInitializer的基础实现,名为AbstractAnnotationConfigDispatcherServletInitializer,当我们的类扩展了AbstractAnnotationConfigDispatcherServletInitializer并将其部署到Servlet3.0容器的时候,容器会自动发现它,并用它来配置Servlet的上下文。

因此,我们只需要创建一个实现了AbstractAnnotationConfigDispatcherServletInitializer的Java类就可以进行Servlet的配置。

public class WebInit extends
    AbstractAnnotationConfigDispatcherServletInitializer {
    /**
	 * 指定spring的配置类
	 * @return
	 */
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }
    /**
	 * 指定SpringMVC的配置类
	 * @return
	 */
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }
    /**
	 * 指定DispatcherServlet的映射规则,即url-pattern
	 * @return
	 */
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    /**
	 * 添加过滤器
	 * @return
	 */
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter();
        encodingFilter.setEncoding("UTF-8");
        encodingFilter.setForceRequestEncoding(true);
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{encodingFilter, hiddenHttpMethodFilter};
    }
}

12.2 创建SpringConfig配置类,代替spring的配置文件

@Configuration
public class SpringConfig {
    //ssm整合之后,spring的配置信息写在此类中
}

12.3 创建WebConfig配置类,代替SpringMVC的配置文件

@Configuration
//扫描组件
@ComponentScan("com.atguigu.mvc.controller")
//开启MVC注解驱动
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    //使用默认的servlet处理静态资源
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer
                                                configurer) {
        configurer.enable();
    }
    //配置文件上传解析器
    @Bean
    public CommonsMultipartResolver multipartResolver(){
        return new CommonsMultipartResolver();
    }
    //配置拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        FirstInterceptor firstInterceptor = new FirstInterceptor();
        registry.addInterceptor(firstInterceptor).addPathPatterns("/**");
    }
    //配置视图控制
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }
    //配置异常映射
    @Override
    public void
        configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
        Properties prop = new Properties();
        prop.setProperty("java.lang.ArithmeticException", "error");
        //设置异常映射
        exceptionResolver.setExceptionMappings(prop);
        //设置共享异常信息的键
        exceptionResolver.setExceptionAttribute("ex");
        resolvers.add(exceptionResolver);
    }
    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver需要一个ServletContext作为构造参数,可通过WebApplicationContext 的方法获得
        ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(webApplicationContext.getServletContext());
        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setCharacterEncoding("UTF-8");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        return templateResolver;
    }
    //生成模板引擎并为模板引擎注入模板解析器
    @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;
    }
}

十三 SpringMVC执行流程

13.1 SpringMVC常用组件

  1. 前端控制器DispatcherServlet,不需要工程师开发,由框架提供,作用是统一处理请求和响应,是整个控制流程的中心,它调用其他组件处理用户的请求
  2. 处理器映射器HandlerMapping:不需要工程师开发,由框架提供,作用是根据url、method等信息查找对应的Handler,即控制器方法
  3. 控制器方法Handler:需要工程师开发,作用是对具体的请求进行处理
  4. 处理器适配器HandlerAdapter:不需要工程师开发,由框架提供,用于执行控制器方法。
  5. 视图解析器ViewerResolver:不需要工程师开发,由框架提供,作用是进行视图解析,得到相应的视图。例如:ThymeleafView、InternalResourceView、RedirectView
  6. 视图View:需要前端工程师开发,作用是将模型数据通过前端页面展示给用户

13.2 DispatcherServlet初始化过程

DispatcherServlet本质上是一个Servlet,所以天然遵循Servlet的生命周期。所以,宏观上是Servlet生命周期来进行调度。

在这里插入图片描述

在细节方面,DispatcherServlet初始化的过程分为如下几步:

  1. 初始化WebApplicationContext

    所在类:org.springframework.web.servlet.FrameworkServlet

    WebApplicationContext本质上就是IOC容器

    作用是将Spring容器设置为SpringMVC的父容器,则SpringMVC容器就可以使用Spring容器中的组件

    onRefresh()方法则是空方法,由DispatcherServlet进行实现,作用是设置初始化策略

    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 contextid, 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 theparent
                        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 = this.getContextClass();
        if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Fatal initialization error in servlet with name '" + this.getServletName() + "': custom WebApplicationContext class [" + contextClass.getName() + "] is not of type ConfigurableWebApplicationContext");
        } else {
            ConfigurableWebApplicationContext wac = (ConfigurableWebApplicationContext)BeanUtils.instantiateClass(contextClass);
            wac.setEnvironment(this.getEnvironment());
            // 设置Spring容器是SpringMVC容器的父容器
            wac.setParent(parent);
            String configLocation = this.getContextConfigLocation();
            if (configLocation != null) {
                wac.setConfigLocation(configLocation);
            }
    
            this.configureAndRefreshWebApplicationContext(wac);
            return wac;
        }
    }
    
  3. DispatcherServlet初始化策略

    在对应的策略中,调用context容器中的相关的Bean进行初始化

    protected void onRefresh(ApplicationContext context) {
        this.initStrategies(context);
    }
    
    protected void initStrategies(ApplicationContext context) {
        this.initMultipartResolver(context);
        this.initLocaleResolver(context);
        this.initThemeResolver(context);
        this.initHandlerMappings(context);
        this.initHandlerAdapters(context);
        this.initHandlerExceptionResolvers(context);
        this.initRequestToViewNameTranslator(context);
        this.initViewResolvers(context);
        this.initFlashMapManager(context);
    }
    

13.3 DispatcherServlet调用组件处理请求

Servlet接口的service方法用于处理请求。HttpServlet重写了Servlet接口的service方法,根据请求的类型来调用相应的doXxx方法,例如get请求会调用doGet()方法。FrameworkServlet重写了这些doXxx方法,在doXxx方法中统一调用processRequest(request, response)。processRequest(request, response)方法会doService(request, response)来处理请求。doService()最终会调用doDispatcher(request, response)方法处理请求。

所在类:org.springframework.web.servlet.FrameworkServlet

  1. processRequest()
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);
    }
}
  1. doService()
protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {
    this.logRequest(request);
    Map<String, Object> attributesSnapshot = null;
    if (WebUtils.isIncludeRequest(request)) {
        attributesSnapshot = new HashMap();
        Enumeration attrNames = request.getAttributeNames();

        label120:
        while(true) {
            String attrName;
            do {
                if (!attrNames.hasMoreElements()) {
                    break label120;
                }

                attrName = (String)attrNames.nextElement();
            } while(!this.cleanupAfterInclude && !attrName.startsWith("org.springframework.web.servlet"));

            attributesSnapshot.put(attrName, request.getAttribute(attrName));
        }
    }

    request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.getWebApplicationContext());
    request.setAttribute(LOCALE_RESOLVER_ATTRIBUTE, this.localeResolver);
    request.setAttribute(THEME_RESOLVER_ATTRIBUTE, this.themeResolver);
    request.setAttribute(THEME_SOURCE_ATTRIBUTE, this.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 {
        this.doDispatch(request, response);
    } finally {
        if (!WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted() && attributesSnapshot != null) {
            this.restoreAttributesAfterInclude(request, attributesSnapshot);
        }

        if (requestPath != null) {
            ServletRequestPathUtils.clearParsedRequestPath(request);
        }

    }

}
  1. doDispatcher()
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 dispatchfailed", 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);
            }
        }
    }
}
  1. processDispatcherResult()
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);
    }
}

13.4 SpringMVC执行流程

  1. 用户向服务器发送请求,请求被SpringMVC的前端控制器DispatcherServlet捕获
  2. DispatcherServlet对请求的URL进行解析,得到请求资源标识符URI,判断请求URI对应的映射:
    • 不存在,则判断是否配置了mvc:default-servlet-handler,
      • 如果没配置,则控制台报映射查找不到,客户端显示404错误
      • 如果配置了,再看访问的静态资源能够找到,找到则返回,找不到则报404
    • 存在,则接着执行流程
  3. 根据URI,调用HandlerMapping获得该Handler配置的所有相关对象(包括Handler对象以及Handler对象对应的拦截器),最后以HandlerExceptionChain执行链的形式返回
  4. DispatcherServlet根据获得的Handler,判断是否能够找到执行该Handler的HandlerAdapter。
  5. 如果成功获得HandlerAdapter,此时开始执行拦截器的preHandler()方法,正向执行
  6. 如果preHandler()方法返回true,则执行控制器方法(Controller中的方法)。在生成Handler对象的过程中,Spring会做一些额外的工作:
    • HttpMessageConveter:将请求消息(如json、html等格式的数据)转换成一个对象,将对象转换为指定的响应信息
    • 数据转换:对请求消息进行数据转换。如String转换成Integer、Double等
    • 数据格式化:对请求消息进行数据格式化。如将字符串转换成格式化数字或格式化日期等
    • 数据验证:验证数据的有效性(长度、格式等),验证结果存储到BindingResult或Error中
  7. Handler执行完成后,向DispatcherServlet返回一个ModelAndView对象
  8. 此时开始执行拦截器的postHandler()方法,逆向执行
  9. 根据返回的ModelAndView选择一个合适的ViewResolver进行视图解析,根据Model和View,来渲染视图。此时会判断是否存在异常,如果存在异常,则执行HandlerExceptionResolver进行异常处理。
  10. 渲染视图完毕后执行拦截器的afterCompletion()方法,逆向执行
  11. 将渲染的结果返回给客户端
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值