Spring框架系列(5) - 深入淺出SpringMVC請求流程和案例

pdai發表於2022-06-24

前文我們介紹了Spring框架和Spring框架中最為重要的兩個技術點（IOC和AOP），那我們如何更好的構建上層的應用呢（比如web 應用），這便是SpringMVC；Spring MVC是Spring在Spring Container Core和AOP等技術基礎上，遵循上述Web MVC的規範推出的web開發框架，目的是為了簡化Java棧的web開發。本文主要介紹SpringMVC主要的流程和基礎案例的編寫和執行。@pdai

Spring框架系列(5) - 深入淺出SpringMVC請求流程和案例

引入

前文我們介紹了Spring框架和Spring框架中最為重要的兩個技術點（IOC和AOP），同時我們也通過幾個Demo應用了Core Container中包

Demo中core container中包使用如下

那麼問題是，我們如何更好的構建上層的應用呢？比如web 應用？

針對上層的Web應用，SpringMVC誕生了，它也是Spring技術棧中最為重要的一個框架。

所以為了更好的幫助你串聯整個知識體系，我列出了幾個問題，通過如下幾個問題幫你深入淺出的構建對SpringMVC的認知。

Java技術棧的Web應用是如何發展的？
什麼是MVC，什麼是SpringMVC？
SpringMVC主要的請求流程是什麼樣的？
SpringMVC中還有哪些元件？
如何編寫一個簡單的SpringMVC程式呢？

什麼是MVC

MVC英文是Model View Controller，是模型(model)－檢視(view)－控制器(controller)的縮寫，一種軟體設計規範。本質上也是一種解耦。

用一種業務邏輯、資料、介面顯示分離的方法，將業務邏輯聚集到一個部件裡面，在改進和個性化定製介面及使用者互動的同時，不需要重新編寫業務邏輯。MVC被獨特的發展起來用於對映傳統的輸入、處理和輸出功能在一個邏輯的圖形化使用者介面的結構中。

Model（模型）是應用程式中用於處理應用程式資料邏輯的部分。通常模型物件負責在資料庫中存取資料。
View（檢視）是應用程式中處理資料顯示的部分。通常檢視是依據模型資料建立的。
Controller（控制器）是應用程式中處理使用者互動的部分。通常控制器負責從檢視讀取資料，控制使用者輸入，並向模型傳送資料。

什麼是Spring MVC

簡單而言，Spring MVC是Spring在Spring Container Core和AOP等技術基礎上，遵循上述Web MVC的規範推出的web開發框架，目的是為了簡化Java棧的web開發。@pdai

(PS：從我的理解就上述一句話，為了讀者學習，這裡找了下kaitao老師寫的SpringMVC的介紹)

Spring Web MVC 是一種基於Java 的實現了Web MVC 設計模式的請求驅動型別的輕量級Web 框架，即使用了MVC 架
構模式的思想，將 web 層進行職責解耦，基於請求驅動指的就是使用請求-響應模型，框架的目的就是幫助我們簡化開
發，Spring Web MVC 也是要簡化我們日常Web 開發的。

相關特性如下：

讓我們能非常簡單的設計出乾淨的Web 層和薄薄的Web 層；
進行更簡潔的Web 層的開發；
天生與Spring 框架整合（如IoC 容器、AOP 等）；
提供強大的約定大於配置的契約式程式設計支援；
能簡單的進行Web 層的單元測試；
支援靈活的URL 到頁面控制器的對映；
非常容易與其他檢視技術整合，如 Velocity、FreeMarker 等等，因為模型資料不放在特定的 API 裡，而是放在一個
Model 裡（Map 資料結構實現，因此很容易被其他框架使用）；
非常靈活的資料驗證、格式化和資料繫結機制，能使用任何物件進行資料繫結，不必實現特定框架的API；
提供一套強大的JSP 標籤庫，簡化JSP 開發；
支援靈活的本地化、主題等解析；
更加簡單的異常處理；
對靜態資源的支援；
支援Restful 風格。

Spring MVC的請求流程

Spring Web MVC 框架也是一個基於請求驅動的Web 框架，並且也使用了前端控制器模式來進行設計，再根據請求對映
規則分發給相應的頁面控制器（動作/處理器）進行處理。

核心架構的具體流程步驟

首先讓我們整體看一下Spring Web MVC 處理請求的流程：

核心架構的具體流程步驟如下：

首先使用者傳送請求——>DispatcherServlet，前端控制器收到請求後自己不進行處理，而是委託給其他的解析器進行
處理，作為統一訪問點，進行全域性的流程控制；
DispatcherServlet——>HandlerMapping， HandlerMapping 將會把請求對映為 HandlerExecutionChain 物件（包含一
個Handler 處理器（頁面控制器）物件、多個HandlerInterceptor 攔截器）物件，通過這種策略模式，很容易新增新
的對映策略；
DispatcherServlet——>HandlerAdapter，HandlerAdapter 將會把處理器包裝為介面卡，從而支援多種型別的處理器，
即介面卡設計模式的應用，從而很容易支援很多型別的處理器；
HandlerAdapter——>處理器功能處理方法的呼叫，HandlerAdapter 將會根據適配的結果呼叫真正的處理器的功能處
理方法，完成功能處理；並返回一個ModelAndView 物件（包含模型資料、邏輯檢視名）；
ModelAndView 的邏輯檢視名——> ViewResolver，ViewResolver 將把邏輯檢視名解析為具體的View，通過這種策
略模式，很容易更換其他檢視技術；
View——>渲染，View 會根據傳進來的Model 模型資料進行渲染，此處的Model 實際是一個Map 資料結構，因此
很容易支援其他檢視技術；
返回控制權給DispatcherServlet，由DispatcherServlet 返回響應給使用者，到此一個流程結束。

對上述流程的補充

上述流程只是核心流程，這裡我們再補充一些其它元件：

Filter(ServletFilter)

進入Servlet前可以有preFilter, Servlet處理之後還可有postFilter

LocaleResolver

在檢視解析/渲染時，還需要考慮國際化(Local)，顯然這裡需要有LocaleResolver.

ThemeResolver

如何控制檢視樣式呢？SpringMVC中還設計了ThemeSource介面和ThemeResolver，包含一些靜態資源的集合(樣式及圖片等），用來控制應用的視覺風格。

對於檔案的上傳請求？

對於常規請求上述流程是合理的，但是如果是檔案的上傳請求，那麼就不太一樣了；所以這裡便出現了MultipartResolver。

Spring MVC案例

這裡主要向你展示一個基本的SpringMVC例子，後文中將通過以Debug的方式分析原始碼。

本例子中主要檔案和結構如下：

Maven包引入

主要引入spring-webmvc包（spring-webmvc包中已經包含了Spring Core Container相關的包），以及servlet和jstl（JSP中使用jstl)的包。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>tech-pdai-spring-demos</artifactId>
        <groupId>tech.pdai</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>011-spring-framework-demo-springmvc</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <spring.version>5.3.9</spring.version>
        <servlet.version>4.0.1</servlet.version>
    </properties>

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

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
        <dependency>
            <groupId>taglibs</groupId>
            <artifactId>standard</artifactId>
            <version>1.1.2</version>
        </dependency>
    </dependencies>

</project>

業務程式碼的編寫

User實體

package tech.pdai.springframework.springmvc.entity;

/**
 * @author pdai
 */
public class User {

    /**
     * user's name.
     */
    private String name;

    /**
     * user's age.
     */
    private int age;

    /**
     * init.
     *
     * @param name name
     * @param age  age
     */
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

Dao

package tech.pdai.springframework.springmvc.dao;

import org.springframework.stereotype.Repository;
import tech.pdai.springframework.springmvc.entity.User;

import java.util.Collections;
import java.util.List;

/**
 * @author pdai
 */
@Repository
public class UserDaoImpl {

    /**
     * mocked to find user list.
     *
     * @return user list
     */
    public List<User> findUserList() {
        return Collections.singletonList(new User("pdai", 18));
    }
}

Service

package tech.pdai.springframework.springmvc.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import tech.pdai.springframework.springmvc.dao.UserDaoImpl;
import tech.pdai.springframework.springmvc.entity.User;

import java.util.List;

/**
 * @author pdai
 */
@Service
public class UserServiceImpl {

    /**
     * user dao impl.
     */
    @Autowired
    private UserDaoImpl userDao;

    /**
     * find user list.
     *
     * @return user list
     */
    public List<User> findUserList() {
        return userDao.findUserList();
    }

}

Controller

package tech.pdai.springframework.springmvc.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import tech.pdai.springframework.springmvc.service.UserServiceImpl;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

/**
 * User Controller.
 *
 * @author pdai
 */
@Controller
public class UserController {

    @Autowired
    private UserServiceImpl userService;

    /**
     * find user list.
     *
     * @param request  request
     * @param response response
     * @return model and view
     */
    @RequestMapping("/user")
    public ModelAndView list(HttpServletRequest request, HttpServletResponse response) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("dateTime", new Date());
        modelAndView.addObject("userList", userService.findUserList());
        modelAndView.setViewName("userList"); // views目錄下userList.jsp
        return modelAndView;
    }
}

webapp下的web.xml

（建立上圖的檔案結構）

webapp下的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">

    <display-name>SpringFramework - SpringMVC Demo @pdai</display-name>

    <servlet>
        <servlet-name>springmvc-demo</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>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>springmvc-demo</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <filter>
        <filter-name>encodingFilter</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>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

springmvc.xml

web.xml中我們配置初始化引數contextConfigLocation，路徑是classpath:springmvc.xml

<init-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:springmvc.xml</param-value>
</init-param>

在resources目錄下建立

<?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:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:jpa="http://www.springframework.org/schema/data/jpa"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
       http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa.xsd
       http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">

    <!-- 掃描註解 -->
    <context:component-scan base-package="tech.pdai.springframework.springmvc"/>

    <!-- 靜態資源處理 -->
    <mvc:default-servlet-handler/>

    <!-- 開啟註解 -->
    <mvc:annotation-driven/>

    <!-- 檢視解析器 -->
    <bean id="jspViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="prefix" value="/WEB-INF/views/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

</beans>

JSP檢視

建立userList.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>User List</title>

    <!-- Bootstrap -->
    <link rel="stylesheet" href="//cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap.min.css">

</head>
<body>
    <div class="container">
        <c:if test="${!empty userList}">
            <table class="table table-bordered table-striped">
                <tr>
                    <th>Name</th>
                    <th>Age</th>
                </tr>
                <c:forEach items="${userList}" var="user">
                    <tr>
                        <td>${user.name}</td>
                        <td>${user.age}</td>
                    </tr>
                </c:forEach>
            </table>
        </c:if>
    </div>
</body>
</html>

部署測試

我們通過IDEA的tomcat外掛來進行測試

下載Tomcat：tomcat地址

下載後給tomcat/bin執行檔案賦權

pdai@MacBook-Pro pdai % cd apache-tomcat-9.0.62 
pdai@MacBook-Pro apache-tomcat-9.0.62 % cd bin 
pdai@MacBook-Pro bin % ls
bootstrap.jar			makebase.sh
catalina-tasks.xml		setclasspath.bat
catalina.bat			setclasspath.sh
catalina.sh			shutdown.bat
ciphers.bat			shutdown.sh
ciphers.sh			startup.bat
commons-daemon-native.tar.gz	startup.sh
commons-daemon.jar		tomcat-juli.jar
configtest.bat			tomcat-native.tar.gz
configtest.sh			tool-wrapper.bat
daemon.sh			tool-wrapper.sh
digest.bat			version.bat
digest.sh			version.sh
makebase.bat
pdai@MacBook-Pro bin % chmod 777 *.sh
pdai@MacBook-Pro bin %

配置Run Congfiuration