Spring Web MVC框架（一）搭建环境

曾经终败给现在 2022-07-11 15:57 254阅读 0赞

学过Java的都知道SSH，也就是Struts、Spring和Hibernate。其中Struts是一个Web MVC框架，Hibernate是ORM框架，Spring是一组框架。不过由于Struts设计较早，其中有些设计已经过时了，框架漏洞也比较多。而且Struts的编写也不方便（例如控制器必须继承Controller类），所以现在Struts用的比较少了。现在更加常用的Web MVC框架是Spring Web MVC。所以我们今天就来介绍一下它。

## 新建项目 ##

首先要做的就是搭建环境。我们需要新建一个Java Web项目，可以直接新建一个项目，也可以使用Maven或Gradle这样的构建工具。在这里我用的是Gradle和IDEA。首先使用IDEA新建一个Gradle项目，在新建时选择Java和Web两个选项。然后点击完成。稍等片刻就会生成一个Gradle项目。然后我们打开`build.gradle`，然后修改为如下的样子。

group 'yitian.learn'
    version '1.0-SNAPSHOT'
    
    apply plugin: 'java'
    apply plugin: 'war'
    apply from: 'https://raw.github.com/akhikhl/gretty/master/pluginScripts/gretty.plugin'
    
    sourceCompatibility = 1.8
    
    repositories {
        jcenter()
    }
    ext {
        springVersion = '4.3.6.RELEASE'
        thymeleafVersion = '3.0.3.RELEASE'
    }
    dependencies {
        testCompile group: 'junit', name: 'junit', version: '4.12'
        compile group: 'org.springframework', name: 'spring-webmvc', version: springVersion
        compile group: 'javax.servlet.jsp.jstl', name: 'javax.servlet.jsp.jstl-api', version: '1.2.1'
        compile group: 'org.glassfish.web', name: 'jstl-impl', version: '1.2'
    }

稍等片刻，等待IDEA更新项目配置。完毕之后，我们查看一下项目的依赖，可以发现已经添加了所需的Spring依赖项，Spring依赖注入、事务管理、面向切面编程等依赖都已添加，非常方便。

## 配置Spring ##

我们可以根据需要配置一个或多个ApplicationContext，常见的做法是配置一个根ApplicationContext和一个前端ApplicationContext。前端ApplicationContext定义网络相关的配置，根ApplicationContext配置数据库等网络无关的组件。这样的话就需要`web.xml`写成类似这样的。

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1">
        <context-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/applicationContext.xml</param-value>
        </context-param>
        <servlet>
            <servlet-name>dispatcher</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <param-name>contextConfigLocation</param-name>
                
                <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <servlet-mapping>
            <servlet-name>dispatcher</servlet-name>
            <url-pattern>/</url-pattern>
        </servlet-mapping>
        <listener>
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
        </listener>
    </web-app>

如果只需要一个ApplicationContext，Servlet初始化参数的`contextConfigLocation`值留空即可。在上面的配置中，我们创建了两个ApplicationContext，一个是全局的，另一个是前端控制器dispatcher-servlet使用的。这里有一个命名规范，如果Spring前端控制器的名称是**X**，那么Spring会寻找**X**\-servlet.xml作为其配置文件的名称。当然这是针对没有显式配置contextConfigLocation的情况。如果像上面一样配置了contextConfigLocation，那么相应的Spring配置文件名就是任意的。

这里的ApplicationContext其实是一个WebApplicationContext，它可以配置一些网络相关的组件，例如视图解析器、异常解析器、主题解析器等等。

## 定义控制器 ##

新建一个Java文件，然后写为如下这样。这样就定义了一个控制器。Spring MVC框架非常灵活，我们只需要应用@Controller注解即可定义一个控制器，不像Struts2那样必须继承一个控制器基类。在控制器中我们可以定义若干方法，每个方法管理相应的URL请求。控制器方法的返回值不是任意的，必须遵循一定的规范。如果返回字符串，那么这个字符串代表着是相应视图的名称，然后会由视图解析器解析为相应的视图文件。Spring MVC框架非常灵活，利用视图解析器将具体的视图技术和MVC框架的视图层分离，我们可以应用Thymeleaf、JSP、FreeMarker等不同的视图技术，只要配置了相应的视图解析器。

package yitian.learn.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    
    @Controller
    public class MainController { 
    
        @RequestMapping("/hello")
        public String hello(@RequestParam(defaultValue = "苟") String name, Model model) {
            model.addAttribute("name", name);
            return "hello";
        }
    
        @RequestMapping("/index")
        public String index() {
            return "index";
        }
    }

## 配置视图 ##

### 配置视图解析器 ###

在`dispatcher-servlet.xml`中添加代码，使其变成这样。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" 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">
    
        <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
            <property name="prefix" value="/WEB-INF/jsp/"/>
            <property name="suffix" value=".jsp"/>
        </bean>
        <mvc:default-servlet-handler/>
        <mvc:annotation-driven/>
        <context:component-scan base-package="yitian.learn"/>
    </beans>

名为`viewResolver`的Bean定义了一个视图解析器，对于不同的视图技术有不同的视图解析器，这里用`InternalResourceViewResolver`来解析JSP页面。如果需要在JSP中使用JSTL，还需要添加`viewClass`属性并设置为`org.springframework.web.servlet.view.JstlView`，这样才能让Spring正确处理JSTL。另外两个属性是前缀和后缀，Spring会用这些前后缀查找具体的视图文件名称。假如控制器传过来的视图名为`index`，那么添加前后缀之后的就是该视图的真正文件名`/WEB-INF/jsp/index.jsp`。

为什么不直接在`webapp`文件夹下放置JSP文件？由于`webapp`文件夹下的JSP可以直接被客户端访问到，因此不利于服务端的控制。例如我们有一个用户信息页面需要在用户登录之后才能显示具体用户信息。如果放到`webapp`下，用户可能在没有登录的情况下就访问到该页面。将页面全部放到`WEB-INF`下，客户端无法直接访问，这样就提高了程序的安全性。

`<mvc:default-servlet-handler/>`指定让Spring的DispatcherServlet作为默认Servlet，这样我们就可以让Spring处理根路径`/`的请求了。如果不加这个，那么根路径的请求默认会由服务器来处理。`<mvc:annotation-driven/>`启用MVC的注解支持。如果不添加这个，那么我们就需要在XML文件中为每个控制器写一个Bean配置，想想就知道很麻烦。`<context:component-scan base-package="yitian.learn"/>`告诉Spring从哪里搜索注解，如果不添加这个，Spring就无法查找我们编写的控制器等文件了。

上面的配置可以使用mvc命名空间简化。我们可以使用如下的配置替代上面的视图解析器配置。

<mvc:view-resolvers>
        <mvc:jsp view-class="org.springframework.web.servlet.view.JstlView" prefix="/WEB-INF/jsp/" suffix=".jsp"/>
    </mvc:view-resolvers>

### 添加视图 ###

由于上面我们在配置视图解析器的时候配置了JSP，那么我们就需要新建JSP文件。在上面的控制器中我们返回了`index`和`hello`两个视图，那么根据视图解析器的配置，我们需要在`/WEB-INF/jsp/`下新建JSP文件。

`index.jsp`文件如下。

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>主页</title>
    </head>
    <body>
    <h1>欢迎</h1>
    <h2><a href="<c:url value="/hello"/>">问候</a></h2>
    </body>
    </html>

`hello.jsp`文件如下。由于上面的控制器向视图传递了一个参数`name`，所以我们可以使用EL表达式在JSP中直接使用该参数。

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>hello</title>
    </head>
    <body>
    <h1>你好，${name} </h1>
    <h2><a href="<c:url value="/index"/>">返回主页</a></h2>
    </body>
    </html>

最后使用命令`gradle tomcatRun`来运行一下程序。如果成功的出现了主页和问候页面，那么我们的Spring Web MVC环境就配置成功了。这样，我们就可以进行下一步的学习了。