SpringMVC

TIP

SpringMVC 教程open in new window
学习流程：javaSE->javaWeb->SMM(框架整合开发：SpringMVC、Spring、Mybatis)->SMM 项目->Java 高级

什么是 MVC

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

M：Model，模型层，指工程中的 JavaBean，作用是处理数据

JavaBean 分为两类：

一类称为实体类 Bean：专门存储业务数据的，如 Student、User 等一类称为业务处理 Bean：指 Service 或 Dao 对象，专门用于处理业务逻辑和数据访问。 V：View，视图层，指工程中的 html 或 jsp 等页面，作用是与用户进行交互，展示数据

C：Controller，控制层，指工程中的 servlet，作用是接收请求和响应浏览器

MVC 的工作流程：用户通过视图层发送请求到服务器，在服务器中请求被 Controller 接收，Controller 调用相应的 Model 层处理请求，处理完毕将结果返回到 Controller，Controller 再根据请求处理的结果找到相应的 View 视图，渲染数据后最终响应给浏览器

什么是 SpringMVC

SpringMVC 是 Spring 的一个后续产品，是 Spring 的一个子项目
SpringMVC 是 Spring 为表述层开发提供的一整套完备的解决方案。在表述层框架历经 Strust、WebWork、Strust2 等诸多产品的历代更迭之后，目前业界普遍选择了 SpringMVC 作为 Java EE 项目表述层开发的首选方案。
注：三层架构分为表述层（或表示层）、业务逻辑层、数据访问层，表述层表示前台页面和后台 servlet

SpringMVC 的特点

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

HelloWorld

开发环境

IDEA 2021.2
构建工具 maven-3.6.3
服务器 tomcat8
Spring 5.2.6
JDK1.8

创建 Maven 工程

打开 idea 选择如下步骤，填写项目名称

配项目 pom.xml

在项目 pom.xml 文件配置打包方式：war

<!--配置打包方式,默认为jar包-->
<packaging>war</packaging>

在项目 pom.xml 文件，添加项目依赖

<!--添加项目依赖jar包-->
  <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>

添加 web 模块

新建 webapp 文件夹

打开项目配置

新建 web.xml

修改 web.xml 文件创建路径

web.xml 文件

默认配置方式

此配置作用下，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>

扩展配置方式

可通过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>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springMVC.xml</param-value>
    </init-param>
    <!--将springMVC的前端控制器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 处理，从而找不到相应的页面 /*则能够匹配所有请求，例如在使用过滤器时，若需要对所有请求进行过滤，就需要使用/*的写法

创建请求控制器

由于前端控制器对浏览器发送的请求进行了统一的处理，但是具体的请求有不同的处理过程，因此需要创建处理具体请求的类，即请求控制器请求控制器中每一个处理请求的方法成为控制器方法因为 SpringMVC 的控制器由一个 POJO（普通的 Java 类）担任，因此需要通过@Controller 注解将其标识为一个控制层组件，交给 Spring 的 IoC 容器管理，此时 SpringMVC 才能够识别控制器的存在

@Controller
public class HelloController {
}

创建 springMVC 的配置文件

<!-- 自动扫描包 -->
<context:component-scan base-package="com.base.spmvc.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>

测试 HelloWorld

在 src/main/webapp/WEB-INF/templates 创建 index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
  <head>
    <meta charset="UTF-8" />
    <title>Title</title>
  </head>
  <body>
    <div>张三</div>
  </body>
</html>

实现对首页的访问:在请求控制器中创建处理请求的方法

@Controller
public class HelloController {

    // "/"-->/WEB-INF/templates/index.html
    // @RequestMapping注解：处理请求和控制器方法之间的映射关系
    // @RequestMapping注解的value属性可以通过请求地址匹配请求，/表示的当前工程的上下文路径
    // localhost:8080/springMVC/
    @RequestMapping(value = "/")
    public String index() {
        // 返回视图名称
        return "index";
    }
}

配置 tomcat 服务启动

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

在主页 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="@{/hello}">HelloWorld</a><br />
  </body>
</html>

在请求控制器中创建处理请求的方法

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

总结

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

@RequestMapping 注解

@RequestMapping 注解的功能

@RequestMapping 注解的作用就是将请求和处理请求的控制器方法关联起来,建立映射关系
SpringMVC 接受到指定的请求,就会来找到在映射关系中对应的控制器方法来处理这个请求

@RequestMapping 注解的位置

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


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

<a th:href="@{/test/success}">测试success</a>

@RequestMapping 注解的 value 属性

@RequestMapping 注解的 value 属性通过请求的请求地址匹配请求映射
@RequestMapping 注解的 value 属性是一个字符串类型的数组，表示该请求映射能够匹配多个请求地址所对应的请求
@RequestMapping 注解的 value 属性必须设置，至少通过请求地址匹配请求映射

<a th:href="@{/testRequestMapping}">
  测试@RequestMapping的value属性-- >/testRequestMapping
</a>
<br />
<a th:href="@{/test}">测试@RequestMapping</a>

@RequestMapping(value = {"/testRequestMapping", "/test"})
public String testRequestMapping(){
    return "success";
}

@RequestMapping 注解的 method 属性

@RequestMapping 注解的 method 属性通过请求的请求方式（get 或 post）匹配请求映射
@RequestMapping 注解的 method 属性是一个 RequestMethod 类型的数组，表示该请求映射能够匹配多种请求方式的请求
若当前请求的请求地址满足请求映射的 value 属性，但是请求方式不满足 method 属性，则浏览器报错 405：Request method 'POST' 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
- 但是目前浏览器只支持 get 和 post，若在 form 表单提交时，为 method 设置了其他请求方式的字符串（put 或 delete），则按照默认的请求方式 get 处理
- 若要发送 put 和 delete 请求，则需要通过 spring 提供的过滤器 HiddenHttpMethodFilter，在 RESTful 部分会讲到

@RequestMapping 注解的 params 属性（了解）

@RequestMapping 注解的 params 属性通过请求的请求参数匹配请求映射
@RequestMapping 注解的 params 属性是一个字符串类型的数组，可以通过四种表达式设置请求参数和请求映射的匹配关系
"param"：要求请求映射所匹配的请求必须携带 param 请求参数
"!param"：要求请求映射所匹配的请求必须不能携带 param 请求参数
"param=value"：要求请求映射所匹配的请求必须携带 param 请求参数且 param=value
"param!=value"：要求请求映射所匹配的请求必须携带 param 请求参数但是 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";
}

TIP

注：若当前请求满足@RequestMapping 注解的 value 和 method 属性，但是不满足 params 属性，此时页面回报错 400：Parameter conditions "username, password!=123456" not met for actual request parameters: username={admin}, password={123456}

@RequestMapping 注解的 headers 属性（了解）

@RequestMapping 注解的 headers 属性通过请求的请求头信息匹配请求映射
@RequestMapping 注解的 headers 属性是一个字符串类型的数组，可以通过四种表达式设置请求头信息和请求映射的匹配关系
"header"：要求请求映射所匹配的请求必须携带 header 请求头信息
"!header"：要求请求映射所匹配的请求必须不能携带 header 请求头信息
"header=value"：要求请求映射所匹配的请求必须携带 header 请求头信息且 header=value
"header!=value"：要求请求映射所匹配的请求必须携带 header 请求头信息且 header!=value
若当前请求满足@RequestMapping 注解的 value 和 method 属性，但是不满足 headers 属性，此时页面显示 404 错误，即资源未找到

SpringMVC 支持 ant 风格的路径

？：表示任意的单个字符
*：表示任意的 0 个或多个字符
**：表示任意的一层或多层目录
注意：在使用时，只能使用//xxx 的方式

<a th:href="@{/test/a1a/testAnt}"
  >测试@RequestMapping注解可以匹配ant风格的属性?</a
><br />
<a th:href="@{/test/a12a/testStartAnt}"
  >测试@RequestMapping注解可以匹配ant风格的属性*</a
><br />
<a th:href="@{/test/a1a/testStartStaAnt}"
  >测试@RequestMapping注解可以匹配ant风格的属性**</a
><br />

@RequestMapping("/a?a/testAnt")
public String testAnt() {
    return "success";
}

@RequestMapping("/a*a/testStartAnt")
public String testStartAnt() {
    return "success";
}

@RequestMapping("/**/testStartStaAnt")
public String testStartStaAnt() {
    return "success";
}

SpringMVC 支持路径中的占位符（重点）

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

<a th:href="@{/testRest/1/admin}">测试路径中的占位符-->/testRest</a><br />

@RequestMapping("/testRest/{id}/{username}")
publicStringtestRest(@PathVariable("id")Stringid,@PathVariable("username")Stringusername){
  System.out.println("id:"+id+",username:"+username);
  return"success";
}
//最终输出的内容为-->id:1,username:admin

SpringMVC 获取请求参数

通过 ServletAPI 获取

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

# SpringMVC

# 什么是 MVC

# HelloWorld

# 开发环境

# 创建 Maven 工程

# 配项目 pom.xml

# 添加 web 模块

# 默认配置方式

# 扩展配置方式

# @RequestMapping 注解

# @RequestMapping 注解的功能

# @RequestMapping 注解的位置

# @RequestMapping 注解的 value 属性

# @RequestMapping 注解的 method 属性

# 注意

# @RequestMapping 注解的 params 属性（了解）

# @RequestMapping 注解的 headers 属性（了解）

# SpringMVC 支持 ant 风格的路径

# SpringMVC 支持路径中的占位符（重点）

# SpringMVC 获取请求参数

# 通过 ServletAPI 获取