Java_SpringMVC_Learning

Java_SpringMVC_Learning

1. HelloWorld!

1. 开发环境

IDE:IntelliJ IDEA 2021.3.1

构建工具:Maven 3.6.1

服务器:Tomcat 8

Spring版本:5.3.1

2. 创建Maven工程

  1. 创建web模块

  2. 更改打包方式为war包

    <packaging>war</packaging>
    
  3. 引入依赖

    <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>
    

3. 配置web.xml

注册SpringMVC的前端控制器DispatcherServlet

1. 默认配置方式

此配置作用下,SpringMVC的配置文件默认位于WEB-INF下,默认名称为<servlet-name>-servlet.xml,例如,以下配置所对应SpringMVC的配置文件位于WEB-INF下,文件名为SpringMVC-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>

2. 扩展配置方式

可通过init-param标签设置SpringMVC配置文件的位置和名称,通过load-on-startup标签设置SpringMVC前端控制器DispatcherServlet的初始化时间

<!-- 配置SpringMVC的前端控制器,对浏览器发送的请求统一进行处理 -->
<servlet>
    <servlet-name>SpringMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 通过初始化参数指定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>
    <!--
        设置SpringMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求
     -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

注:

<url-pattern>标签中使用/和/*的区别:

/所匹配的请求可以是/login.html.js.css方式的请求路径,但是/不能匹配.jsp请求路径的请求

因此就可以避免在访问jsp页面时,该请求被DispatcherServlet处理,从而找不到相应的页面

/*则能够匹配所有请求,例如在使用过滤器时,若需要对所有请求进行过滤,就需要使用/*的写法

4. 创建请求控制器

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

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

因为SpringMVC的控制器由一个POJO(普通的Java类)担任,因此需要通过@Controller注解将其标识为一个控制层组件,交给Spring的IoC容器管理,此时SpringMVC才能够识别控制器的存在

package com.chester.controller;

import org.springframework.stereotype.Controller;

@Controller
public class HelloController {
    
}

但仅此一步还不够,需要在xml中配置包扫描,这在下一步中具体实现

5. 创建SpringMVC配置文件

<!-- 自动扫描包 -->
<context:component-scan base-package="com.chester.controller"/>
<!-- 配置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>
<!--
	处理静态资源,例如html、js、css、jpg
	若只设置该标签,则只能访问静态资源,其他请求则无法访问
	此时必须设置<mvc:annotation-driven/>解决问题
-->
<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>

6. 测试HelloWorld

  1. 实现对首页的访问
package com.chester.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class HelloController {

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

}

html代码略去

image-20220205171759788

  1. 通过超链接跳转到指定页面

在controller中添加

@RequestMapping("/target")
public String toTarget(){
    return "target";
}
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>首页</h1>
    <a th:href="@{/target}">访问目标页面:target.html</a>
</body>
</html>

image-20220205172510029

image-20220205172521097

7. 总结

浏览器发送请求,若请求地址符合前端控制器的url-pattern,该请求就会被前端控制器DispatcherServlet处理。

前端控制器会读取SpringMVC的核心配置文件,通过扫描组件找到控制器,将请求地址和控制器中@RequestMapping注解的value属性值进行匹配,若匹配成功,该注解所标识的控制器方法就是处理请求的方法。

处理请求的方法需要返回一个字符串类型的视图名称,该视图名称会被视图解析器解析,加上前缀和后缀组成视图的路径,通过Thymeleaf对视图进行渲染,最终转发到视图所对应页面。

2. @RequestMapping

1. @RequestMapping的功能

顾名思义,@RequestMapping就是请求映射,就是将浏览器请求和处理请求的控制器方法关联起来,建立映射关系。

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


@RequestMapping的全部属性

image-20220206184511724

2. @RequestMapping的位置

  1. 标识在类上:设置映射请求的请求路径初始信息
  2. 标识在方法上:设置映射请求的请求路径具体信息
package com.chester.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/hello")
public class TestController {

    @RequestMapping("/toindex")
    public String toIndex(){
        return "index";
    }

}

3. @RequestMapping的value属性

@RequestMapping注解的value属性通过请求的请求地址匹配请求映射

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

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

package com.chester.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {

    @RequestMapping(
            value = {"/toindex","/myindex"}
    )
    public String toIndex(){
        return "index";
    }

}

image-20220206191054717

image-20220206191108289

可见,通过http://localhost:8080/toindexhttp://localhost:8080/myindex均可以正常访问

4. @RequestMapping的method属性

@RequestMapping注解的method属性通过请求的请求方式(get或post)匹配请求映射

@RequestMapping注解的method属性是一个RequestMethod类型的数组,表示该请求映射能够匹配多种请求方式的请求

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

package com.chester.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class TestController {

    @RequestMapping(
            value = {"/"}
    )
    public String toIndex(){
        return "index";
    }

    @RequestMapping(
            value = {"/tosuccess"},
            method = {RequestMethod.GET}
    )
    public String toSuccess(){
        return "success";
    }

}
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>首 页</h1>
    <form th:action="@{/tosuccess}" method="post">
        <input type="submit" value="测试post">
    </form>
    <form th:action="@{/tosuccess}" method="get">
        <input type="submit" value="测试get">
    </form>
</body>
</html>

image-20220207115527524

5. @RequestMapping的param属性(了解)

  1. @RequestMapping注解的params属性通过请求的请求参数匹配请求映射

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

    1. “param”:要求请求映射所匹配的请求必须携带param请求参数
    2. “!param”:要求请求映射所匹配的请求必须不能携带param请求参数
    3. “param=value”:要求请求映射所匹配的请求必须携带param请求参数且param=value
    4. “param!=value”:要求请求映射所匹配的请求必须携带param请求参数但是param!=value
package com.chester.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {

    @RequestMapping(
            value = {"/testParams"},
            params = {"username"}
    )
    public String testParams(){
        return "success";
    }

}

此时如果访问http://localhost:8080/testParams,会报出400参数未找到错误

image-20220207130948300

如果我们加上参数username,访问http://localhost:8080/testParams?username=zhang,可见成功访问并返回success页面

image-20220207131018767

6. @RequestMapping的headers属性(了解)

  1. @RequestMapping注解的headers属性通过请求的请求头信息匹配请求映射

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

    1. “header”:要求请求映射所匹配的请求必须携带header请求头信息
    2. “!header”:要求请求映射所匹配的请求必须不能携带header请求头信息
    3. “header=value”:要求请求映射所匹配的请求必须携带header请求头信息且header=value
    4. “header!=value”:要求请求映射所匹配的请求必须携带header请求头信息且header!=value

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

7. SpringMVC支持ant风格的路径(模糊匹配)

?:表示任意的单个字符

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

**:表示任意的一层或多层目录

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

8. SpringMVC支持路径中的占位符(重点)

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

package com.chester.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {

    @RequestMapping("/testRest/{id}/{username}")
    public String testRest(@PathVariable("id") String id,
                           @PathVariable("username") String username
    ){
        System.out.println("id:" + id + ",username:" + username);
        return "success";
    }

}

访问http://localhost:8080/testRest/123456/zhangzuopeng,返回success页面,且控制台正确输出

image-20220207135150382

3. SpringMVC获取请求参数

1. 通过servletAPI获取参数

将HttpServletRequest作为控制器方法的形参,此时HttpServletRequest类型的参数表示封装了当前请求的请求报文的对象

<body>
    <a th:href="@{/testServletAPI(username='zhang',password=123456)}">
        测试testServletAPI获取请求参数
    </a>
</body>
@RequestMapping("/testServletAPI")
public String testServlerAPI(HttpServletRequest request){
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    System.out.println("username"+username+";password"+password);
    return "success";
}

image-20220207180813661

image-20220207180826492

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

@RequestMapping("/testParam")
public String testParam(String username, String password, String[] hobby){
    System.out.println("username"+username+
                       ";password"+password+
                       ";hobby"+ Arrays.toString(hobby));
    return "success";
}
<body>
    <a th:href="@{/testServletAPI(username='zhang',password=123456)}">
        测试testServletAPI获取请求参数
    </a>
    <a th:href="@{/testParam(username='zhang',password=123456)}">
        测试控制器形参获取请求参数
    </a>
    <form th:action="@{/testParam}" method="get">
        用户名:<input type="text" name="username">
        密码:<input type="password" name="password">
        爱好:<input type="checkbox" name="hobby" value="a">a
            <input type="checkbox" name="hobby" value="b">b
            <input type="checkbox" name="hobby" value="c">c
        <br><input type="submit" value="测试控制器形参获取请求参数">
    </form>
</body>

image-20220207182948938

提交表单后成功返回success页面,且控制台正确输出

image-20220207183023329

3. @RequestParam

  • @RequestParam是将请求参数和控制器方法的形参创建映射关系

  • @RequestParam注解一共有三个属性:

    1. value或name:指定为形参赋值的请求参数的参数名
    2. required:设置是否必须传输此请求参数,默认值为true
    3. defaultValue:不管required属性值为true或false,当value所指定的请求参数没有传输或传输的值为""(空字符串)时,则使用默认值为形参赋值

若设置为true时,则当前请求必须传输value所指定的请求参数,若没有传输该请求参数,且没有设置defaultValue属性,则页面报错400:Required String parameter ‘xxx’ is not present;

若设置为false,则当前请求不是必须传输value所指定的请求参数,若没有传输,则注解所标识的形参的值为null

4. @RequestHeader

@RequestHeader是将请求头信息和控制器方法的形参创建映射关系

@RequestHeader注解一共有三个属性:value、required、defaultValue,用法同@RequestParam

5. @CookieValue

@CookieValue是将cookie数据和控制器方法的形参创建映射关系

@CookieValue注解一共有三个属性:value、required、defaultValue,用法同@RequestParam


我们通过手动添加cookie的方法写入数据,在其他任一方法中添加代码:

HttpSession session = request.getSession();

然后在我们需要获取cookie的方法中写:

@RequestMapping("/testParam")
    public String testParam(String username, String password, String[] hobby,
                            @CookieValue("JSESSIONID") String session
    ){
        System.out.println("username "+username+
                ";password "+password+
                ";hobby "+ Arrays.toString(hobby)+
                ";JSESSIONID "+session);
        return "success";
    }

当我们第一次尝试获取cookie,服务器还没有值,会进行创建,所以我们会在响应头中看到cookie,而请求头中是没有的

image-20220207190855468

如果刷新页面,再次尝试获取cookie值,就会在请求头中看到cookie值,而响应头是没有的

image-20220207190959051

此时执行测试注解的方法

image-20220207191233764

可见,我们想要获取的数据成功输出

6. 通过POJO获取参数

实际开发中,我们往往会返回一整个Bean,一个一个返回会十分麻烦,我们可以直接打包获取这个Bean,如下

@RequestMapping("/testBean")
public String testBean(User user){
    System.out.println(user);
    return "success";
}

image-20220207192808909

提交表单,成功跳转到success页面,user信息也成功在控制台输出(自动执行toString方法)

image-20220207193049516

7. 解决获取请求参数的乱码问题

在上面的实例中,sex字段出现中文乱码问题

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

<!--配置springMVC的编码过滤器-->
<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>forceResponseEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

重新部署项目,成功输出

image-20220207194052342

4. 域对象共享数据

page(jsp有效)pageContext

request(一次请求)HttpServletContext

session(一次会话)HttpSession

application(当前web应用)ServletContext

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

@RequestMapping("/test_request_by_servlet_api")
public String test_request_by_servlet_api(HttpServletRequest request){
    request.setAttribute("testRequestScope","hello,servlet api");
    return "success";
}
<body>
shouye !<br>
<a th:href="@{/test_request_by_servlet_api}">通过ServletAPI向request域对象共享数据</a>
</body>
<body>
successsssssssssssssssss!
<p th:text="${testRequestScope}"/>
</body>
image-20220208194923946 image-20220208195137719

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

@RequestMapping("/test_model_and_view")
public ModelAndView testModelAndView(){
    ModelAndView mav = new ModelAndView();
    mav.addObject("testRequestScope","hello,model and view");
    mav.setViewName("success");
    return mav;
}
image-20220208201142150 image-20220208201156993

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

@RequestMapping("/test_model")
public String testModel(Model model){
    model.addAttribute("testRequestScope","hello,model");
    return "success";
}
image-20220209114725687 image-20220209115330732

4. 使用Map向request域对象共享数据

@RequestMapping("/test_map")
public String testMap(Map<String, Object> map){
    map.put("testRequestScope","hello,map");
    return "success";
}
image-20220209115718257 image-20220209115727373

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

@RequestMapping("/test_model_map")
public String testModelMap(ModelMap modelMap){
    modelMap.addAttribute("testRequestScope","hello,model map");
    return "success";
}
image-20220209120047370 image-20220209120104080

6. Model、ModelMap、Map的关系

在上述的五种方法中,ServletAPI是最原始的方法,不建议使用,Spring提供的后四种方法在开发中是被建议使用的

在后三种方法中,如果我们在代码中尝试直接输出对象本身,会发现输出了同样的内容

我们有理由猜想这三种方法底层都实例化了相同的对象,通过反射原理,我们分别添加以下代码

System.out.println(model.getClass().getName());
System.out.println(map.getClass().getName());
System.out.println(modelMap.getClass().getName());

然后尝试调用后三种方法

image-20220209121911456

发现他们都调用了相同的类:BindingAwareModelMap

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 {}

不管是哪个方法,最后都会调用到ModelAndView

7. 使用ServletAPI向session域共享数据

@RequestMapping("/test_session")
public String testSession(HttpSession httpSession){
    httpSession.setAttribute("testSessionScope","hello,session");
    return "success";
}
<a th:href="@{/test_session}">通过ServletAPI向session域对象共享数据</a><br>
<p th:text="${session.testSessionScope}"/>
image-20220209124716735 image-20220209124737601

8. 使用ServletAPI向application域共享数据

@RequestMapping("/test_application")
public String testApplication(HttpSession httpSession){
    ServletContext servletContext = httpSession.getServletContext();
    servletContext.setAttribute("testApplicationScope","hello,application");
    return "success";
}
<a th:href="@{/test_application}">通过ServletAPI向application域对象共享数据</a><br>
<p th:text="${application.testApplicationScope}"/>
image-20220209125314449 image-20220209125320657

5. SpringMVC的视图

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

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

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

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

1. ThymeleafView

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

781f6b299e6b41a8b006866ecbcb76ba

2. 转发视图InternalResourceView

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

  • SpringMVC中创建转发视图的情况:

    • 当控制器方法中所设置的视图名称以"forward:"为前缀时,创建InternalResourceView视图,此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析,而是会将前缀"forward:"去掉,剩余部分作为最终路径通过转发的方式实现跳转
    • 例如"forward:/",“forward:/employee”
@RequestMapping("/test_forward")
public String testForward(){
    return "forward:/test_thymeleaf_view";
}

1

3. 重定向视图RedirectView

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

  • SpringMVC中创建重定向视图的情况:

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

    • 例如"redirect:/",“redirect:/employee”

@RequestMapping("/test_redirect")
public String testRedirect(){
    return "forward:/test_thymeleaf_view";
}

2

4. forward与redirect的区别

  1. 转发是发送一次请求(浏览器一次,服务器内部还有一次),重定向两次请求(第一次访问Servlet,第二次访问重定向地址)

  2. 转发不改变浏览器的地址,重定向最终地址是重定向到的地址

  3. 转发可以获取请求域中的数据,重定向不可以。因为在重定向中浏览器发送了两次请求,属于不同的请求域

  4. 转发可以获取WEB-INF下的资源,重定向不可以。因为该文件夹下的资源具有隐藏性,只能通过服务器内部访问,不能通过浏览器访问

  5. 转发不可以跨域,重定向可以跨域。因为重定向可以通过浏览器来访问不同服务器的资源

5. 视图控制器viewController

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

@RequestMapping("/")
public String toIndex(){
    return "index";
}

这几行代码可以在SpringMVC配置文件中用一行xml代码代替

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

但是需要添加一行开启注解驱动的代码

<!--开启MVC注解驱动-->
<mvc:annotation-driven/>

6. RESTful

1. RESTful简介

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

  1. 资源

    资源是一种看待服务器的方式,即将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。

    与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称,也是资源在Web上的地址。对某个资源感兴趣的客户端应用,可以通过资源的URI与其进行交互。

  2. 资源的表述

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

  3. 状态转移

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

2. RESTful的实现

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

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

REST 风格提倡 URL 地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性。

操作传统方式REST风格
查询操作getUserById?id=1user/1–>get请求方式
保存操作saveUseruser–>post请求方式
删除操作deleteUser?id=1user/1–>delete请求方式
更新操作updateUseruser–>put请求方式

3. HiddenHttpMethodFilter

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

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

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

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

在web.xml中注册HiddenHttpMethodFilter

<!--配置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>

注:

  1. 目前为止,SpringMVC中提供了两个过滤器:CharacterEncodingFilter和HiddenHttpMethodFilter

  2. 在web.xml中注册时,必须先注册CharacterEncodingFilter,再注册HiddenHttpMethodFilter

7. RESTful案例:员工管理系统

1. 准备工作

  1. 实体类Employee(略去部分代码)

    public class Employee {
    
        private Integer id;
        private String lastName;
        private String email;
        //1 male, 0 female
        private Integer gender;
    
    }
    
  2. Dao类

    @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
查询全部数据/employeeGET
删除/employee/2DELETE
跳转到添加数据页面/toAddGET
执行保存/employeePOST
跳转到更新数据页面/employee/2GET
执行更新/employeePUT

3. 功能实现:访问首页

  1. 在SpringMVC.xml中配置视图控制器viewController

    <mvc:view-controller path="/" view-name="index"/>
    
  2. 创建index.html

    <!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="@{/employee}">查看员工信息</a>
    </body>
    </html>
    
  3. 访问http://localhost:8080即可进入首页

    image-20220211191211354

4. 功能实现:查询所有员工

  1. 控制器方法

    @Controller
    public class EmployeeController {
    
        @Autowired
        private EmployeeDao employeeDao;
    
        @GetMapping("/employee")
        public String getAllEmployee(Model model){
            Collection<Employee> employeeList = employeeDao.getAll();
            model.addAttribute("employeeList",employeeList);
            return "employee_list";
        }
    
    }
    
  2. 创建employee_list.html用来显示员工信息

    <!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>员工信息</title>
    </head>
    <body>
    
        <table id="dataTable" border="1" cellspacing="0" cellpadding="0" style="text-align: center;">
            <tr>
                <th colspan="5">员工信息</th>
            </tr>
            <tr>
                <th>员工编号</th>
                <th>员工姓名</th>
                <th>员工邮箱</th>
                <th>员工性别</th>
                <th>选项</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 href="">删除</a>
                    <a href="">更新</a>
                </td>
            </tr>
        </table>
    
    </body>
    </html>
    
  3. 进入首页,单击超链接

    image-20220211191637140

5. 功能实现:删除员工

在上一步,我们实现了显示模拟数据库中的内容,但是删除与更新按钮并没有进行配置,接下来进行相应的配置

  1. 在employee_list.html中添加处理delete请求的表单

    <form id="deleteForm" method="post">
        <input type="hidden" name="_method" value="delete">
    </form>
    
  2. 在employee_list.html中添加引入vue.js的代码

    <script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
    

    注意:script标签不能使用自闭合,否则报405

  3. 在SpringMVC.xml中开启对静态资源的访问

    <!--开放对静态资源的访问-->
    <mvc:default-servlet-handler/>
    
  4. 在employee_list.html中补充配置删除按钮的超链接

    <td>
        <a @click="deleteEmployee" th:href="@{'/employee/'+${employee.id}}">删除</a>
        <a href="">更新</a>
    </td>
    
  5. 在employee_list.html中添加通过vue处理点击事件的代码

    <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>
    
  6. 控制器方法

    @DeleteMapping("/employee/{id}")
    public String deleteEmployee(@PathVariable("id") Integer id){
        employeeDao.delete(id);
        return "redirect:/employee";
    }
    
  7. 此时进入表单,单击删除按钮,成功删除信息

    image-20220211192630827

6. 功能实现:添加并保存员工

  1. 在SpringMVC.xml中配置视图控制器viewController

    <mvc:view-controller path="/toAdd" view-name="employee_add"/>
    
  2. 创建employee_add.html

    <!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>添加员工</title>
    </head>
    <body>
    
        <form th:action="@{/employee}" method="post">
            员工姓名:<input type="text" name="lastName"><br>
            员工邮箱:<input type="text" name="email"><br>
            员工性别:<input type="radio" name="gender" value="1"><input type="radio" name="gender" value="1"><br>
            <input type="submit" value="add"><br>
        </form>
    
    </body>
    </html>
    
  3. 在employee_list.html中补充配置添加员工按钮的超链接

    <tr>
        <th>员工编号</th>
        <th>员工姓名</th>
        <th>员工邮箱</th>
        <th>员工性别</th>
        <th>选项(<a th:href="@{/toAdd}">添加员工</a></th>
    </tr>
    
  4. 控制器方法

    @PostMapping("/employee")
    public String addEmployee(Employee employee){
        employeeDao.save(employee);
        return "redirect:/employee";
    }
    
  5. 单击添加员工,输入信息并添加

    image-20220211193435567

image-20220211193453927

8. 功能实现:更新员工

  1. 在employee_list.html中补充配置更新按钮的超链接

    <td>
        <a @click="deleteEmployee" th:href="@{ '/employee/' + ${employee.id} }">删除</a>
        <a th:href="@{ '/employee/' + ${employee.id} }">更新</a>
    </td>
    
  2. 设置回显数据的控制器方法

    @GetMapping("/employee/{id}")
    public String getEmployeeById(@PathVariable("id") Integer id, Model model){
        Employee employee = employeeDao.get(id);
        model.addAttribute("employee",employee);
        return "employee_update";
    }
    
  3. 创建employee_update.html

    <!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>更新员工</title>
    </head>
    <body>
    
        <form th:action="@{/employee}" method="post">
            <input type="hidden" name="_method" th:value="put">
            <input type="hidden" name="id" th:value="${employee.id}">
            员工姓名:<input type="text" name="lastName" th:value="${employee.lastName}"><br>
            员工邮箱:<input type="text" name="email" th:value="${employee.email}"><br>
            员工性别:<input type="radio" name="gender" value="1" th:field="${employee.gender}"><input type="radio" name="gender" value="0" th:field="${employee.gender}"><br>
            <input type="submit" value="更新"><br>
        </form>
    
    </body>
    </html>
    
  4. 设置跳转的控制器方法

    @PutMapping("/employee")
    public String updateEmployee(Employee employee){
        employeeDao.save(employee);
        return "redirect:/employee";
    }
    
  5. 单击更新,输入新的信息并提交

    image-20220211202236459

    image-20220211202251615

9. 扩展:为何导入vue.js会报找不到该文件?

在删除员工功能编写中,我们发现,导入vue.js后,直接使用浏览器会找不到该文件,只有开启静态资源访问:

<mvc:default-servlet-handler/>

之后,文件才被成功加载

这是由于在Tomcat中也存在web.xml文件,该文件与我们工程中的web.xml文件属于父子关系,如果出现冲突会优先使用本工程的wen.xml文件

在Tomcat的web.xml文件中配置了默认DefaultServlet,而我们又在本工程中配置了DispatcherServlet,而两者的url-pattern标签内容都是/。这就使得二者冲突,且会以本工程为准。

DispatcherServlet会把每个请求都去控制器中寻找对应的映射,而我们却没有写访问静态资源(即vue.js)的映射,所以就找不到文件了。

添加上面的代码,就会使得:如果DispatcherServlet处理不了,就去找DefaultServlet来处理。

8. HttpMessageConverter

HttpMessageConverter,报文信息转换器,将请求报文转换为Java对象,或将Java对象转换为响应报文

HttpMessageConverter提供了两个注解和两个类型:@RequestBody,@ResponseBody,RequestEntity,ResponseEntity

1. @RequestBody

@RequestBody可以获取请求体,需要在控制器方法设置一个形参,使用@RequestBody进行标识,当前请求的请求体就会为当前注解所标识的形参赋值

@RequestMapping("/test_requestbody")
public String testRequestBody(@RequestBody String requestBody){
    System.out.println("requestBody" + requestBody);
    return "success";
}
<form th:action="@{/test_requestbody}" method="post">
    <input type="text" name="username">
    <input type="text" name="password">
    <input type="submit" value="测试@RequestBody">
</form>

image-20220212125641838

image-20220212125714552

2. RequestEntity

RequestEntity封装请求报文的一种类型,需要在控制器方法的形参中设置该类型的形参,当前请求的请求报文就会赋值给该形参,可以通过getHeaders()获取请求头信息,通过getBody()获取请求体信息

@RequestMapping("/test_requestentity")
public String testRequestEntity(RequestEntity<String> requestEntity){
    //requestEntity表示整个请求的信息
    System.out.println("请求头:"+requestEntity.getHeaders());
    System.out.println("请求体:"+requestEntity.getBody());
    return "success";
}
<form th:action="@{/test_requestentity}" method="post">
    <input type="text" name="username">
    <input type="text" name="password">
    <input type="submit" value="测试@RequestEntity">
</form>

image-20220212130526687

image-20220212130551626

3. @ResponseBody

@RequestMapping("/test_responsebody")
@ResponseBody
public String testResponseBody(){
    return "zhang";
}

执行该方法,字符串zhang被输出到浏览器

4. SpringMVC处理Json

  1. 在pom.xml中导入Jackson依赖

    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.12.1</version>
    </dependency>
    
  2. 开启MVC注解驱动

    <mvc:annotation-driven/>
    
  3. @RequestMapping("/test_response_user")
    @ResponseBody
    public User testResponseUser(){
        return  new User(1001,"admin","132465",23,"男");
    }
    
  4. 在浏览器中调用方法,就会返回Json格式的字符串(bean中没有写toString方法)

    image-20220212150442036

    image-20220212150454808

5. SpringMVC处理Ajax

  1. 请求超链接

    <div id="app">
        <a @click="textAxios" th:href="@{/text_axios}">SpringMVC处理Ajax请求</a>
    </div>
    
  2. 通过vue和axios处理点击事件

    <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:{
                textAxios:function (event) {
                    axios({
                        method:"post",
                        url:event.target.href,
                        params:{
                            username:"admin",
                            password:"123456"
                        }
                    }).then(function (response){
                        alert(response.data);
                    });
                    event.preventDefault();
                }
            }
        });
    </script>
    
  3. 控制器方法

    @RequestMapping("/text_axios")
    @ResponseBody
    public String testAxios(String username, String password){
        System.out.println(username+","+password);
        return "hello,axios";
    }
    
  4. 访问浏览器,点击超链接,弹出提示框

    image-20220212160922907

6. @RestController

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {

    /**
	 * The value may indicate a suggestion for a logical component name,
	 * to be turned into a Spring bean in case of an autodetected component.
	 * @return the suggested component name, if any (or empty String otherwise)
	 * @since 4.0.1
	 */
    @AliasFor(annotation = Controller.class)
    String value() default "";

}

7. ResponseEntity

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

该类常用于文件下载

9. 文件上传与下载

1. 文件上传

文件上传要求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. 在配置文件中添加配置

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

    @RequestMapping("/test-up")
    public String testUp(MultipartFile photo,HttpSession session) throws IOException {
        //获取上传的文件名
        String filename = photo.getOriginalFilename();
        ServletContext servletContext = session.getServletContext();
        String photoPath = servletContext.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";
    }
    
  4. 表单

    <form th:action="@{/test-up}" method="post" enctype="multipart/form-data">
        头像:<input type="file" name="photo"><br>
        <input type="submit" value="上传">
    </form>
    
  5. 上传文件,并观察文件夹

    image-20220214120348180

    点击上传后,成功跳转到success页面,本地服务器中也成功出现新文件夹

    image-20220214120424689

    image-20220214120439219

2. 文件下载:使用ResponseEntity实现

  1. 控制器方法

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

  3. 点击下载,可见文件成功被下载

    image-20220213232940887

3. 解决重名问题:使用UUID实现

如果有大量图片上传到服务器,有可能会出现文件重名问题,我们可以通过通用唯一识别码(Universally Unique Identifier,UUID)来解决。

修改上传文件的控制器方法

@RequestMapping("/test-up")
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 servletContext = session.getServletContext();
    String photoPath = servletContext.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,几乎不会出现重名问题

image-20220215121306725

10. 拦截器

1. 拦截器的配置

SpringMVC中的拦截器:

  1. 用于拦截控制器方法的执行

  2. 需要实现HandlerInterceptor

  3. 必须在SpringMVC的配置文件中进行配置:

    <bean class="com.chester.interceptors.FirstInterceptor"></bean>
    
    <ref bean="firstInterceptor"></ref>
    
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/"/>
        <ref bean="firstInterceptor"></ref>
    </mvc:interceptor>
    

    上述三种方法均可以实现,第二种需要将对应的类注册为组件并进行包扫描

    第三种可以实现具体路径的设置

2. 拦截器的三个抽象方法

preHandle:控制器方法执行之前执行preHandle(),其boolean类型的返回值表示是否拦截或放行,返回true为放行,即调用控制器方法;返回false表示拦截,即不调用控制器方法

postHandle:控制器方法执行之后执行postHandle()

afterCompletion:处理完视图和模型数据,渲染视图完毕之后执行afterCompletion()

3. 多个拦截器的执行顺序(源码分析)

  1. 若每个拦截器的preHandle()都返回true

    此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关:

    • preHandle()会按照配置的顺序执行
    • postHandle()和afterComplation()会按照配置的反序执行
  2. 若某个拦截器的preHandle()返回了false

    • preHandle()返回false和它之前的拦截器的preHandle()都会执行

    • postHandle()都不执行

    • 返回false的拦截器之前的拦截器的afterComplation()会执行

11. 异常处理器

1. 基于配置的异常处理

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

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

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

  1. SpringMVC配置文件配置

    <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>
    
  2. 编写error.html

    <body>
        error~~
        <p th:text="${ex}"></p>
    </body>
    
  3. 控制器方法

@RequestMapping("/test-exception-handler")
public String testExceptionHandler(){
    System.out.println(1/0);
    return "success";
}
  1. 此时访问控制器方法,跳转到error页面,并输出信息

    image-20220215144630292

2. 基于注解的异常处理

添加异常处理的控制器方法

@ControllerAdvice
public class ExceptionController {

    @ExceptionHandler(value = {ArithmeticException.class, NullPointerException.class})
    public String testException(Exception exception, Model model){
        model.addAttribute("exception", exception);
        return "error";
    }

}

此时如果页面出现错误同样会跳转到error页面,并输出对应错误

12. 注解配置SpringMVC

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

1. 创建初始化类WebInit.java,代替web.xml

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

  • Spring提供了这个接口的实现,名为SpringServletContainerInitializer,这个类反过来又会查找实现WebApplicationInitializer的类并将配置的任务交给它们来完成。

  • Spring3.2引入了一个便利的WebApplicationInitializer基础实现,名为AbstractAnnotationConfigDispatcherServletInitializer,当我们的类扩展了AbstractAnnotationConfigDispatcherServletInitializer并将其部署到Servlet3.0容器的时候,容器会自动发现它,并用它来配置Servlet上下文。

/**
 * 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 = new HiddenHttpMethodFilter();
        return new Filter[]{characterEncodingFilter, hiddenHttpMethodFilter};
    }

}

2. 创建SpringConfig.java配置类,代替Spring配置文件

/**
 * Spring配置文件
 */
@Configuration
public class SpringConfig {
    //暂时没有整合Spring,故没有Spring相关配置文件
}

3. 创建WebConfig配置类,代替SpringMVC配置文件

/**
 * 代替SpringMVC配置文件,即SpringMVC.xml
 * 1.扫描组件
 * 2.视图解析器
 * 3.view-controller
 * 4.静态资源处理default-servlet-handler
 * 5.开启mvc注解驱动
 * 6.文件上传解析器
 * 7.异常处理
 * 8.拦截器
 */
@Configuration  //将当前类标识为配置类
@ComponentScan("com.chester.controller")  //1.扫描组件
@EnableWebMvc   //5.开启mvc注解驱动
public class WebConfig implements WebMvcConfigurer {

    //2.1配置生成模板解析器
    @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;
    }

    //2.2生成模板引擎并为模板引擎注入模板解析器
    @Bean
    public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    //2.3生成视图解析器并为视图解析器注入模板引擎
    @Bean
    public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }

    //3.view-controller
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/hello").setViewName("hello");
    }

    //4.静态资源处理default-servlet-handler
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    //6.文件上传解析器
    @Bean
    public MultipartResolver multipartResolver(){
        CommonsMultipartResolver commonsMultipartResolver = new CommonsMultipartResolver();
        return commonsMultipartResolver;
    }

    //7.异常处理
    @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);
    }

    //8.拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        TestInterceptor testInterceptor = new TestInterceptor();
        registry.addInterceptor(testInterceptor).addPathPatterns("/**");
    }

}

13. SpringMVC执行流程

1. SpringMVC常用组件

  1. DispatcherServlet:前端控制器,不需要工程师开发,由框架提供

    作用:统一处理请求和响应,整个流程控制的中心,由它调用其它组件处理用户的请求

  2. HandlerMapping:处理器映射器,不需要工程师开发,由框架提供

    作用:根据请求的url、method等信息查找Handler(controller),即控制器方法

  3. Handler:处理器,需要工程师开发

    作用:在DispatcherServlet的控制下Handler对具体的用户请求进行处理

  4. HandlerAdapter:处理器适配器,不需要工程师开发,由框架提供

    作用:通过HandlerAdapter对处理器(控制器方法)进行执行

  5. ViewResolver:视图解析器,不需要工程师开发,由框架提供

    作用:进行视图解析,得到相应的视图,例如:ThymeleafView、InternalResourceView、RedirectView

  6. View:视图,不需要工程师开发,由框架或视图技术提供

    作用:将模型数据通过页面展示给用户

2. DispatcherServlet初始化过程

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

image-20220217154628142

1. 初始化WebApplicationContext

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

protected WebApplicationContext initWebApplicationContext() {
   WebApplicationContext rootContext =
         WebApplicationContextUtils.getWebApplicationContext(getServletContext());
   WebApplicationContext wac = null;

   if (this.webApplicationContext != null) {
      ......
   }
   if (wac == null) {
      wac = findWebApplicationContext();
   }
   if (wac == null) {
      //创建WebApplicationContext
      wac = createWebApplicationContext(rootContext);
   }

   if (!this.refreshEventReceived) {
      synchronized (this.onRefreshMonitor) {
         //刷新WebApplicationContext
         onRefresh(wac);
      }
   }

   if (this.publishContext) {
      //在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;

    ......

    try {
		// 执行服务,doService()在FrameworkServlet类中是一个抽象方法,但在DispatcherServlet中进行了重写
        doService(request, response);
    }
    
    ......
        
}

2. doService()

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

@Override
protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {
    logRequest(request);

    ......

    // 向请求域注入参数值
    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());

    ......

    try {
        // 处理请求和响应
        doDispatch(request, response);
    }
    
    ......
        
}

3. doDispatch()

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

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    HttpServletRequest processedRequest = request;
    // 控制器方法执行链,包含handler、interceptorList、interceptorIndex
    HandlerExecutionChain mappedHandler = null;
    boolean multipartRequestParsed = false;

    WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

    // try:1
    try {
        ModelAndView mv = null;
        Exception dispatchException = null;

        // try:2
        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);
        }// try:2 end
       
        ......
        
        // 后续处理:处理模型数据和渲染视图
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    } //try:1 end
    
    ......
    
}

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对应的映射:

    1. 请求映射不存在

      1. 再判断是否配置了mvc:default-servlet-handler

      2. 如果没配置,所有请求只会被DispatcherServlet处理。则控制台报映射查找不到,客户端展示404错误

        在这里插入图片描述

      3. 如果有配置,则访问目标资源(一般为静态资源,如:JS,CSS,HTML),找不到客户端也会展示404错误

        在这里插入图片描述

    2. 存在则执行下面的流程

      1. 根据该URI,调用HandlerMapping获得该Handler配置的所有相关的对象(包括Handler对象以及Handler对象对应的拦截器),最后以HandlerExecutionChain执行链对象的形式返回。
      2. DispatcherServlet 根据获得的Handler,选择一个合适的HandlerAdapter。
      3. 如果成功获得HandlerAdapter,此时将开始执行拦截器的preHandler(…)方法【正向】
      4. 提取Request中的模型数据,填充Handler入参,开始执行Handler(Controller)方法,处理请求。在填充Handler的入参过程中,根据你的配置,Spring将帮你做一些额外的工作:
        1. HttpMessageConveter: 将请求消息(如Json、xml等数据)转换成一个对象,将对象转换为指定的响应信息
        2. 数据转换:对请求消息进行数据转换。如String转换成Integer、Double等
        3. 数据格式化:对请求消息进行数据格式化。 如将字符串转换成格式化数字或格式化日期等
        4. 数据验证: 验证数据的有效性(长度、格式等),验证结果存储到BindingResult或Error中
      5. Handler执行完成后,向DispatcherServlet 返回一个ModelAndView对象
      6. 此时将开始执行拦截器的postHandle(…)方法【逆向】。、
      7. 根据返回的ModelAndView(此时会判断是否存在异常:如果存在异常,则执行HandlerExceptionResolver进行异常处理)选择一个适合的ViewResolver进行视图解析,根据Model和View,来渲染视图。
      8. 渲染视图完毕执行拦截器的afterCompletion(…)方法【逆向】。
      9. 将渲染结果返回给客户端。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值