1. 程式人生 > >整合SSM框架必備基礎—SpringMVC(下)

整合SSM框架必備基礎—SpringMVC(下)

在上一篇文章《整合SSM框架必備基礎—SpringMVC(上)》中,胖達介紹了關於SpringMVC的誕生、優勢以及執行流程等理論知識點,這篇文章打算在實操中加深一下對SpringMVC的認識,畢竟實踐才是學習技術最有效的方法嘛,Let's Go!

一、 首先來建立一個Web小專案吧

JDK版本:jdk1.7.0_07
開發環境:Intellij IDEA v2018.03

首先需要在IDEA的專案列表頁面新建一個Web專案,這裡IDEA給我們提供了眾多的專案模板,只要選擇了相應的模板就可以快速新建一個專案骨架,在這裡,我們可以首先通過一個webapp模板新建Web專案,步驟如下:

1.建立新專案

2.通過Maven模板選擇,新建專案骨架

3.為組織和專案新建唯一標誌符

4.選擇本地或者預設的Maven及其版本

5.確定專案名稱以及專案新建的位置即可

6.生成的Web專案目錄

在上述步驟完成後,點選Finish,即可成功利用模板生成了一個簡易的Web專案骨架,其生成的專案目錄如下圖所示:

二、SpringMVC的配置要經歷哪些過程呢?

1.在pom.xml中配置Maven依賴

配置SpringMVC首先需要新增該框架所需的Maven依賴(即jar檔案),思考一下SpringMVC的執行需要哪些jar包的支援呢?我們需要把這些依賴都新增到pom.xml檔案中,才可進行SpringMVC專案的構建,下面我整理了一份,雖然不是很全但是夠用。

新增依賴之前,首先需要在pom.xml中的properties標籤屬性中標記一下Spring的版本,如果像我一樣額外引入了Hibernate,順便標記一下Hibernate的版本哈,配置如下:

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <maven.compiler.source>1.7</maven.compiler.source>
  <maven.compiler.target>1.7</maven.compiler.target>
  <spring.version>4.2.6.RELEASE</spring.version>
  <hibernate.version>5.1.0.Final</hibernate.version>
</properties>

然後在這個檔案中新增dependency依賴,依賴檔案的配置如下:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>4.2.5.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>4.2.5.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>${spring.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-jpa</artifactId>
    <version>1.10.1.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-entitymanager</artifactId>
    <version>${hibernate.version}</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-c3p0</artifactId>
    <version>${hibernate.version}</version>
</dependency>
<dependency>
    <groupId>com.mchange</groupId>
    <artifactId>c3p0</artifactId>
    <version>0.9.5.2</version>
</dependency>
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>jstl</artifactId>
    <version>1.2</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.39</version>
</dependency>

另外,如果你pom.xml檔案中build屬性標籤中沒有關於maven編譯打包的外掛maven-compiler-plugin這一項,你還需要新增一個關於它的配置,因為沒有它你的Maven是沒辦法給你編譯專案原始碼的,但是如果有的話你可以自動忽略掉,配置內容如下:

<build>
    <finalName>springmvcdemo</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

2.web.xml檔案的配置

對於一個Web專案,web.xml是這個專案的整體配置檔案,需要在這個檔案中新增相關的一些配置,例如DispatcherServlet配置、字符集編碼設定過濾器、錯誤跳轉頁面等等,其中DispatcherServlet做為框架的入口,是使用SpringMVC必需的配置;encodingFilter過濾器是為了處理請求中的中文,防止出現亂碼。

配置程式碼如下:

<?xml version="1.0" encoding="UTF-8"?>
<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <!--根目錄跳轉-歡迎頁面-->
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  <!--編碼過濾器-->
  <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>
  <!--錯誤頁面跳轉-->
  <error-page>
    <!-- 路徑不正確 -->
    <error-code>404</error-code>
    <location>/WEB-INF/errorpage/404.jsp</location>
  </error-page>
  <error-page>
    <!-- 沒有訪問許可權,訪問被禁止 -->
    <error-code>405</error-code>
    <location>/WEB-INF/errorpage/405.jsp</location>
  </error-page>
  <error-page>
    <!-- 內部錯誤 -->
    <error-code>500</error-code>
    <location>/WEB-INF/errorpage/500.jsp</location>
  </error-page>
  <!--SpringMVC入口配置-->
  <servlet>
    <servlet-name>spring-mvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!--此處後面會有說明-->
      <!--<init-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>/WEB-INF/springmvc-servlet.xml</param-value>
      </init-param>-->
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>spring-mvc</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

3.SpringMVC自身xml檔案配置

SprignMVC自身也存在一個配置檔案,如果你的專案中不包含這個配置檔案,可以通過IDEA自帶的方式去生成,步驟如下圖所示:

(1)在WEB-INF根目錄下點選右鍵

(2)點選New在右側找到XML Configuration File

(3)點選後找到Spring Config

(4)為XML配置檔案命名,例如:XXX-servlet.xml即可,命名時需要注意SpringMVC會預設去找/WEB-INF/XXX-servlet.xml這個XML,其中XXX是上述Web.xml中所配置的servlet-name名稱,如果不想用這個作為配置檔案的名稱,且不想用-servlet為字尾,就需要在Web.xml中配置contextConfigLocation來指定檔案路徑,例如:

<!--SpringMVC入口配置-->
<servlet>
  <servlet-name>spring-mvc</servlet-name>
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  <!--此處就必須添加了-->
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/springmvc-servlet.xml</param-value>
    </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
  <servlet-name>spring-mvc</servlet-name>
  <url-pattern>/</url-pattern>
</servlet-mapping>

新建了配置檔案,IDEA並不會預設生成所有配置,我們最終還是看到一個空空的XML檔案,需要對其配置進行手動新增,新增之前首先搞清楚這個配置檔案到底能有啥用途呢?

(1)配置自動掃描的包路徑,通過這項配置,自動掃描某個包下的Controller控制器,方便管理Bean,並在請求的時候快速定位Controller並訪問。

(2)註解對映支援配置即註解開關,只有配置了這一項,註解才能有效果。

(3)配置檢視解析器,通過檢視解析器可以給請求頁面新增字首和字尾,而不用每次SpringMVC返回檢視的時候再去單獨指定字首、字尾,例如:

<bean id="viewResolver" class="org.springframework.web.servlet.view.UrlBasedViewResolver">
    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
    <property name="prefix" value="/WEB-INF/pages/"/>
    <property name="suffix" value=".jsp"/>
</bean>

(4)配置靜態資原始檔的訪問,如果 DispatcherServlet 攔截了所有的請求,同時對.js,.jpg的訪問也會被攔截,導致執行時跳轉後的頁面無法載入靜態資原始檔,這時需要對靜態資原始檔的訪問進行配置。

(5)配置上傳檔案資料解析器,方便管理上傳資料的資訊,包括檔案的格式、最大最小資料量等等,例如:

<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
  <property name="maxUploadSize" value="10485760"/>
  <property name="defaultEncoding" value="UTF-8"/>
</bean>

(6)配置全域性異常處理器,針對異常處理做統一的處理和維護,並對一些特殊異常做特殊處理,例如:

<!-- 全域性異常處理器,實現HandlerExceptionResolver介面就是全域性異常處理器-->
<bean class="com.eurasia.exception.CustomExceptionResolver"></bean>

(7)自定義引數型別繫結,SpringMVC框架可以實現傳參到Controller請求方法中返回檢視和引數的功能,在Controller中可以完成對於引數的處理,例如你的引數是一個實體類,其中的某個欄位需要轉換為Date,這時可以通過配置自定義轉換器來實現引數轉換,例如:

<bean id="objectMapper" class="com.fasterxml.jackson.databind.ObjectMapper">
  <property name="dateFormat">
    <bean class="java.text.SimpleDateFormat">
      <constructor-arg type="java.lang.String" value="yyyy-MM-dd HH:mm:ss" />
    </bean>
  </property>
</bean>

明確了這些用途,在來看看檔案中應該如何具體的進行配置,配置內容如下(上述某些用途的配置在當前小專案中沒有用到,所以未提供相關配置):

<?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"
       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">

        <!--指明 controller 所在包,並掃描其中的註解-->
        <context:component-scan base-package="hello"/>
        <!-- 靜態資源(js、image等)的訪問 -->
        <mvc:default-servlet-handler/>
        <!-- 開啟註解 -->
        <mvc:annotation-driven/>
        <!--ViewResolver 檢視解析器-->
        <!--用於支援Servlet、JSP檢視解析-->
        <bean id="jspViewResolver"

        class="org.springframework.web.servlet.view.UrlBasedViewResolver"

            <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
            <property name="prefix" value="/WEB-INF/pages/"/>
            <property name="suffix" value=".jsp"/>
        </bean>
</beans>

注意:如果你生成的配置檔案在加入這些標籤時報錯,記得檢查你的xmlns:mvc和xmlns:context頭資訊,把它們補全即可

4.建立我們的Controller控制器

在src/main目錄下新建包名,例如com.hello這樣,然後在下面新建一個java檔案HiController.java,這個就是我們新建的第一個Contrller控制器,通過這個控制器,就可以向前臺傳遞ModelAndView,當然你也可以指定view路徑最終呈現給使用者一個展示的介面。

前面我們已經啟用了SpringMVC提供的註解功能,那我們在這裡就可以直接用註解來註釋我們的控制器,這樣才能識別到這個控制器,程式碼呈上:

@Controller
@RequestMapping("/hello")
public class HiController {

    /**
     * 測試返回指定的view檔名
     * @return
     */
    @RequestMapping("/welcome")
    public String helloWorld() {
        return "welcome";
    }

    /**
     * 測試返回帶有資料的ModelAndView物件
     * @return
     */
    @RequestMapping("/view")
    public ModelAndView getView() {
        String message = "<br><div style='text-align:center;'>"
                + "<h3>我叫胖達,來自HiController.java(公眾號:Java知識共享)</h3>";
        return new ModelAndView("welcome", "message", message);
    }
}

這裡Controller最終是要向前臺的介面返回資料或者調起某個介面的,所以必須在前臺也要指定一個頁面,我在webapp下的WEB-INF中建立了一個pages資料夾專門存放前臺的頁面,這裡暫時先放一個welcome.jsp頁面,給大家打個招呼,頁面內容如下:

<%@ page language="java" contentType="text/html; charset=UTF-8"
         pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>Insert title here</title>
</head>
<body>
Hi!
${message}</body>
</html>

根據前臺和後臺的這兩段程式碼,看懂的小夥伴應該知道了我的演示效果,等我啟動起來專案再展示哈。

5.配置Tomcat,啟動小專案

我已經迫不及待的要啟動我的專案了,IDEA中配置tomcat的步驟其實很簡單,如果你pom.xml中引入maven-tomcat外掛,可能會更簡單,這裡我用傳統外部tomcat的方式吧。

首先點選右上角的edit Configurations按鈕:

這樣就打開了run/debug Configurations視窗,在這個視窗繼續操作如下:

特別注意:第四個步驟是為了選擇本地的tomcat路徑哈,直接選擇自己的外部tomcat,選擇根路徑即可。

然後還有一步就是需要選擇tomcat啟動的時候需要Deployment也就是要釋出的應用,按照下述步驟1-6即可:

到此,tomcat配置成功,直接點選右上角,啟動我們的小專案即可。

由於前面配置了歡迎介面,當系統啟動成功後我會自動訪問index.jsp歡迎頁面,併成功展示HelloWorld字樣,接下來我們要依次訪問一下我們控制器中寫的兩個方法:

第一個方法

訪問路徑:

http://localhost:8088/SpringMVCStarter/hello/welcome

訪問結果:

結論:在上面後端的程式碼中會發現,我只是指定了一個view的路徑welcome,結果會自動跳轉出welcome.jsp的原有內容,說明我們的呼叫成功了

第二個方法

訪問路徑:

http://localhost:8088/SpringMVCStarter/hello/view

訪問結果:

結論:與第一個不同的是,這個方法會跳轉同一個介面welcome.jsp,但是後臺我返回的是ModelAndView物件,這樣的話,後臺會將資料和檢視經過渲染後一併呈現給使用者,如上圖黑色字型為後臺傳遞到前臺的資料。

三、 SpringMVC的幾種註解

提及SpringMVC,不得不順便囉嗦一下它的註解,確實非常好用,常用的幾個重要註解如下:

1.Controller

這個可以說是最重要的一個註解了,主要用於標識是Controller處理器類.表示把我的控制器物件交給Spring來建立。

2.RequestMapping

請求對映的註解,也就是標記請求路徑名的重要註解,就比如我們小專案中的hello和welcome用法,當然還有指定其他引數的用法,例如請求方式是post還是get,都可以在這個註解中標明。

3.RequestParam

這個註解的功能主要是給引數設定預設值,或者給引數定義別名,只要別名和頁面傳遞引數匹配即可傳遞成功,例如:

@RequestParam(defaultValue="1",value="myid")

它的配置項主要包含:

(1) value:引數名字,即入參的請求引數名字,如value=“studentid”表示請求的引數區中的名字為studentid的引數的值將傳入;

(2) required:是否必須,預設是true,表示請求中一定要有相應的引數,否則將報400錯誤碼;

(3) defaultValue:預設值,表示如果請求中沒有同名引數時的預設值

4.Redirect

通過這個註解,Contrller方法返回結果重定向到一個url地址,例如redirect:/user/add.do即可跳轉到這個add.do指定的相應頁面。

5.Forward

利用這個註解,Controller方法執行後還會繼續執行另一個controller方法,例如return “forward:/user/userlist.do”;,就會去執行其他的userlist這個方法

6.RequestBody/ResponseBody

如果要用到json傳遞資料,那這個註解是非常重要的,其實也是日常開發必須的一個註解。

其中@RequestBody註解用於讀取http請求的內容(字串),通過springmvc提供的HttpMessageConverter介面將讀到的內容轉換為json、xml等格式的資料並繫結到controller方法的引數上。

@RequestBody註解實現接收http請求的json資料,將json資料轉換為java物件,但是@RequestBody/@ResponseBody一般要依賴Jackson使用。

四、總結

關於SpringMVC的整個訪問流程在上篇文章中簡單介紹了一下,這篇文章也通過搭建流程、建立配置檔案的方式做了一個簡單的介紹,假想我們從訪問一個Controller控制器的url出發,首先通過web.xml中的入口DispatchServlet進入了SpringMVC這個框架的流程,再通過框架內的HandlerMapping、HandlerAdapter找到我們提前通過註解注入的Controller方法,執行完成後返回帶著資料的ModelAndView物件,在通過我們配置的ViewResolver給我們view路徑新增上字首字尾,最終做一些資料和檢視的渲染工作,就可以將一個期待的效果頁面展現給我們了,這個過程是不是很清晰?其實雖然寫了那麼多,但是對於SpringMVC內部的處理情況還是有一點點疑問,以後有機會我會帶著疑問跟大家一起去擼一遍原始碼,或許通過原始碼才能更加深入的瞭解到SpringMVC這個神奇的框架,期待ING