Spring入門(十二)：Spring MVC使用講解

2019 年 10 月 3 日
筆記

1. Spring MVC介紹

提到MVC，參與過Web應用程式開發的同學都很熟悉，它是展現層(也可以理解成直接展現給用戶的那一層)開發的一種架構模式，M全稱是Model，指的是數據模型，V全稱是View，指的是視圖頁面，如JSP、Thymeleaf等，C全稱是Controller，指的是控制器，用來處理用戶在客戶端（瀏覽器）發起的請求。

Spring MVC就是基於MVC模式實現，能夠幫你構建像Spring框架那樣靈活和松耦合的Web應用程式。

也就是說，Spring MVC是基於Spring的，它主要用來開發Web應用程式。

2. Spring MVC請求流程

在Web應用程式中，請求是必不可少的，每次請求由用戶(客戶端)發起，到用戶(客戶端)接收到響應結束，下圖展示了一個請求在Spring MVC中所經歷的每個流程：

接下來我們對圖中的每個流程做下講解：

請求離開瀏覽器時（圖中的①），會帶有用戶所請求內容的資訊，比如請求的URL和提交的表單資訊。
然後進入到請求的第一站，即Spring的DispatcherServlet，它的任務是將請求發送給Spring MVC控制器。
因為在應用程式中會有多個控制器，因此DispatcherServlet會查詢一個或多個處理器映射(handler mapping)，處理器映射會根據請求所攜帶的URL來確定應該將請求發送給哪個控制器（圖中的②）。
確定好控制器後，DispatcherServlet會將請求發送給確定好的控制器，然後等待控制器處理用戶提交的資訊，不過一般情況下，控制器本身幾乎不處理工作，而是將業務邏輯委託給一個或多個服務對象進行處理（圖中的③）。
控制器完成業務邏輯處理後，通常會產生一些模型(Model)資訊，這些資訊需要返回給用戶並在瀏覽器上顯示，為了更友好的展示這些資訊，比如以Html形式展示，我們需要將資訊發送給一個視圖(View)，比如JSP、Thymeleaf。
控制器所做的最後一件事就是將模型數據打包，並且標示出用於渲染輸出的視圖名，它會將請求連同模型和視圖名發送回DispatcherServlet（圖中的④），不過控制器只會返回一個視圖的邏輯名稱，而不是返回具體的某個特定視圖，這個邏輯名稱將會用來查找產生結果的真正視圖。DispatcherServlet會使用視圖解析器(view resolver)來將邏輯視圖名匹配為某個特定視圖（圖中的⑤），比如JSP或者Thymeleaf。
請求的最後一站是視圖的實現（圖中的⑥），在這裡視圖將使用模型數據渲染輸出，這個輸出會通過響應對象傳遞給用戶/客戶端（圖中的⑦）。

了解了Spring MVC的請求流程後，我們來接著了解下如何搭建和配置Spring MVC項目。

3. 搭建Spring MVC項目

我們仍然延用之前部落格中新建的spring-action項目，有興趣的同學可以看下本系列的前11篇部落格或者直接下載源碼：https://github.com/zwwhnly/spring-action.git。

3.1 添加依賴

要想使用Spring MVC，首先我們需要在pom.xml中添加如下依賴：

<dependency>      <groupId>org.springframework</groupId>      <artifactId>spring-webmvc</artifactId>      <version>4.3.18.RELEASE</version>  </dependency>    <!-- 其他Web依賴 -->  <dependency>      <groupId>javax.servlet</groupId>      <artifactId>jstl</artifactId>      <version>1.2</version>  </dependency>  <dependency>      <groupId>javax.servlet</groupId>      <artifactId>javax.servlet-api</artifactId>      <version>4.0.1</version>      <scope>provided</scope>  </dependency>

因為後面要將項目部署到Tomcat，所以我們在pom.xml中配置下打包方式為war包：

<packaging>war</packaging>    <build>      <plugins>          <!--其他配置-->          <plugin>              <groupId>org.apache.maven.plugins</groupId>              <artifactId>maven-war-plugin</artifactId>              <version>3.2.3</version>              <configuration>                  <failOnMissingWebXml>false</failOnMissingWebXml>              </configuration>          </plugin>      </plugins>  </build>

3.2 新建演示頁面

在src/main/resources下新建views目錄，然後在此目錄下新建index.jsp頁面如下所示：

<%@ page contentType="text/html;charset=UTF-8" language="java" pageEncoding="UTF-8" %>  <html>  <head>      <title>Spring MVC</title>  </head>  <body>      <pre>          Welcome to Spring MVC world      </pre>  </body>  </html>

這裡可能存在的問題是，右鍵新建JSP文件時，沒有JSP文件模板，就像下面這樣：

解決方案如下所示：

依次點擊File–Project Structure，打開Project Structure對話框，左側選中Modules，然後點擊+號，選擇Web

此時再次右鍵新增JSP文件，就會看到JSP文件模板：

此時項目根目錄會生成1個web文件夾，可以將其刪除。

3.3 Spring MVC配置

新建配置類MyMvcConfig如下所示：

package chapter05.config;    import org.springframework.context.annotation.Bean;  import org.springframework.context.annotation.ComponentScan;  import org.springframework.context.annotation.Configuration;  import org.springframework.web.servlet.config.annotation.EnableWebMvc;  import org.springframework.web.servlet.view.InternalResourceViewResolver;  import org.springframework.web.servlet.view.JstlView;    /**   * Spring MVC配置   */  @Configuration  @EnableWebMvc  @ComponentScan("chapter05")  public class MyMvcConfig {      /**       * 視圖解析器配置       *       * @return       */      @Bean      public InternalResourceViewResolver viewResolver() {          InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();            viewResolver.setPrefix("/WEB-INF/classes/views/");          viewResolver.setSuffix(".jsp");          viewResolver.setViewClass(JstlView.class);            return viewResolver;      }  }

注意事項：

1)該配置類使用了@EnableWebMvc註解來啟用Spring MVC，它會開啟一些默認配置。

2)該配置類配置了視圖解析器，這裡我們配置的是JSP的視圖解析器。

視圖解析器中，我們設置了前綴和後綴，如果控制器中返回的邏輯視圖名稱是index，實際渲染時找的視圖就是/WEB-INF/classes/views/index.jsp，為什麼設置的前綴是/WEB-INF/classes/views/而不是/src/main/resources/views/呢，那是因為項目編譯完運行時的目錄是/WEB-INF/classes/views/。

如果編譯完成該目錄下沒有jsp文件，則需要在pom.xml中添加如下配置：

<build>      <resources>          <resource>              <directory>src/main/resources</directory>              <includes>                  <include>**/*.jsp</include>                  <include>**/*.js</include>              </includes>          </resource>      </resources>  </build>

3.4 Web配置

新建Web配置類WebInitializer如下所示：

package chapter05.config;    import org.springframework.web.WebApplicationInitializer;  import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;  import org.springframework.web.servlet.DispatcherServlet;    import javax.servlet.ServletContext;  import javax.servlet.ServletException;  import javax.servlet.ServletRegistration.Dynamic;    public class WebInitializer implements WebApplicationInitializer {      @Override      public void onStartup(ServletContext servletContext) throws ServletException {          AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();          context.register(MyMvcConfig.class);          context.setServletContext(servletContext);            Dynamic servlet = servletContext.addServlet("dispatcher", new DispatcherServlet(context));          servlet.addMapping("/");          servlet.setLoadOnStartup(1);      }  }

這裡重點要關注的是，該類實現了介面WebApplicationInitializer並重寫了onStartup()方法，WebApplicationInitializer類是Spring提供用來配置Servlet 3.0+版本配置的介面，從而可以替代掉web.xml。

3.5 新建控制器

新建控制器HelloController如下所示：

package chapter05.controller;    import org.springframework.stereotype.Controller;  import org.springframework.web.bind.annotation.RequestMapping;    @Controller  public class HelloController {      @RequestMapping("/index")      public String hello() {          // 這裡返回的邏輯視圖名          return "index";      }  }

上面程式碼中的@Controller註解聲明這是1個控制器，@RequestMapping("/index")用來配置URL映射，現在問題來了，我們如何查看程式碼的運行效果呢？

這就涉及到了項目打包和項目部署，我們繼續往下看。