10.SpringMVC入门案例

我们用SpringMVC，完成一个实际的案例 　　‍

需求

有一个index.jsp页面，上面有个超链接；

当点击超链接时，会发送一个请求，我们定义一个Servlet，处理该请求；然后转发到成功页面。

我们分两步完成：

1. 搭建开发环境（例如引入依赖，配置文件等）
2. 编写入门的程序（编写Servlet）

‍

‍

新建Maven项目

新建一个Maven的项目，使用的骨架是webapp，这里我创建一个叫LearnSpringMVC的项目；相关源码已上传到GitHub (opens new window)和Gitee (opens new window)上。

使用该骨架，默认目录结构是不全的，我们得创建一个java目录：

‍

导入依赖

这里我们统一使用5.0.2的版本，因此配置了一个属性spring.version，然后在依赖中使用该属性

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <spring.version>5.0.2.RELEASE</spring.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>2.5</version>
        <scope>provided</scope>
    </dependency>

    <dependency>
        <groupId>javax.servlet.jsp</groupId>
        <artifactId>jsp-api</artifactId>
        <version>2.0</version>
        <scope>provided</scope>
    </dependency>

    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>3.8.1</version>
        <scope>test</scope>
    </dependency>

</dependencies>

‍

‍

配置前端控制器

要使用SpringMVC，第一件事就是配置前端控制器，其实就是一个Servlet，由SpringMVC提供的。

我们在web.xml中这样配置：

<servlet>
    <servlet-name>DispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>

<servlet-mapping>
    <servlet-name>DispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

‍

简单来说，就是任何请求都先经过前端控制器，由控制权负责统一的分发调度

‍

‍

创建配置文件

我们使用SpringMVC框架，也是需要一个配置文件的，我们创建一个springmvc.xml：

‍

文件的内容：这里我们加上一些约束

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

</beans>

‍

配置服务器

此时我们基本上搭建好了环境，我们做了如下事情

1. 创建Maven项目
2. 完善Maven的目录结构
3. 引入SpringMVC的依赖
4. 配置前端控制器
5. 创建配置文件

接下来我们先试着部署下，我们新建一个运行配置：

‍

选择Tomcat服务器：

‍

‍

然后在配置底部点击修复：

‍

‍

在弹框中选择第一个

‍

‍

并且我们设置路径为根路径：

‍

‍

新建控制器类

在SpringMVC中，用来处理请求的叫控制器类。

‍

我们新建一个控制器类，并新建一个方法（SpringMVC是用方法来处理请求的）

package com.peterjxl.controller;


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

@Controller
public class HelloController {

    @RequestMapping(path = "/hello")
    public String sayHello() {
        System.out.println("Hello, World!");
        return "success";
    }
}

代码说明：

1. 这里我们使用了2个注解：@Controller的作用是告诉SpringMVC，这是一个控制器；
2. 然后方法上的注解@RequestMapping则是配置路径的，当访问/hello时会执行该方法
3. 我们返回的字符串success，SpringMVC会当成是一个静态资源文件的文件名

‍

配置IoC

要让一个方法执行，首先得创建一个对象；而我们是学过Spring的，我们可以将这个类交给IoC来管理，此时我们创建的配置文件就起作用了，我们在springmvc.xml中配置要扫描的包：

<!-- 开启注解扫描 -->
<context:component-scan base-package="com.peterjxl"/>

‍

加载配置文件

我们创建的这个springmvc.xml配置文件，如何让SpringMVC框架加载呢？如果不加载的话，我们就无法创建这个容器，并读取里面的配置，然后扫描包里的类，创建对象；

此时我们可以在web.xml中加载这个配置文件，我们添加一个初始化参数的配置（第4 ~ 7行）：

<servlet>
    <servlet-name>DispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

‍

这个init-param的配置是指，给DispatcherServlet这个类的属性contextConfigLocation赋值，值是springmvc.xml。然后控制器类，就可以帮我们加载配置文件了

然后我们配置load-on-startup参数，表明服务器一启动，就加载配置文件。

‍

‍

‍

新建success.jsp

我们在WEB-INF目录下，新建一个目录pages，然后新建一个success.jsp：这个文件用来当作请求成功后的页面

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
      <h1>入门成功</h1>
    </body>
</html>

‍

配置视图解析器

之前我们说过，控制器类的方法中，返回的字符串，SpringMVC会当成是一个JSP文件的名字，那么去何处寻找这个文件呢？此时我们就可以用SpringMVC的视图解析器，我们在springmvc.xml中配置：

 <!-- 视图解析器 -->
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/pages/"/> <!-- 前缀，可以理解为是文件的目录 -->
    <property name="suffix" value=".jsp"/>  <!-- 后缀，可以理解为是文件后缀名 -->
</bean>

当我们这样配置后，SpringMVC就知道会去哪个目录寻找文件，并且拼接文件名+文件后缀，然后返回文件。

‍

‍

修改index.jsp

然后我们就可以在index.jsp中，加上超链接了：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
        <h3>入门程序</h3>
        <a href="hello">入门程序</a>
    </body>
</html>

‍

测试

我们访问localhost:8080（其实默认就会寻找index.jsp页面然后访问），然后点击超链接，可以看到能成功调整，并且IDEA控制台有打印Hello, World!，因此我们的需求完成了。

‍

‍

总结

经过这么多的配置，我们总算是成功使用SpringMVC做了一个小案例，可能读者会有点晕，因此我们特此梳理一下。

首先我们可以将过程分为两部分：

1. 启动服务器的过程，加载一些配置文件
2. 发送HTTP请求，后台处理这个请求

‍

启动服务器的过程

‍

1. 首先，我们在web.xml中配置了前端控制器；
2. 然后我们配置了load-on-startup参数，并设置为1，这样在服务器创建的时候，前端控制器就会被创建
3. 然后前端控制器，会加载springmc.xml文件
4. springmc.xml中，我们开启了注解扫描，因此会去扫描代码中的控制器类，并加载到容器当中（默认是单例的）
5. 然后我们配置了视图解析器，会帮我们解析文件

‍

请求的过程

‍

1. 首先我们的index.jsp页面，会请求hello路径；

2. 由于我们配置了前端控制器DispatcherServlet，该请求首先会交给它处理

3. DispatcherServlet可以简单理解为是一个管理员，指挥中心

   1. DispatcherServlet会首先根据路径，寻找到具体的控制器类
   2. sayHello方法执行，会打印Hello, World!，然后返回结果success给DispatcherServlet
   3. DispatcherServlet会找视图解析器，根据结果找到具体的文件
   4. DispatcherServlet将文件返回给客户端，也就是浏览器，至此，请求完成

‍

‍

示意图：

‍

‍

‍

源码

本项目已将源码上传到GitHub (opens new window)和Gitee (opens new window)上。并且创建了分支demo1，读者可以通过切换分支来查看本文的示例代码。

‍