Spring MVC之基於xml配置的web應用構建

時間  2019-11-05
標籤 spring mvc 基於 xml 配置 web 應用 構建 欄目 Spring 简体版
原文   原文鏈接

更多spring博文參考： http://spring.hhui.top/java

直接用SpringBoot構建web應用能夠說很是很是簡單了，在使用SpringBoot構建後端服務以前，一直用的是Spring + SpringMVC基於xml的配置方式來玩的，因此在正式進入SpringBoot Web篇以前，有必要看一下不用SpringBoot應該怎麼玩的，也所以方便凸顯SpringBoot的優越性git

<!-- more -->github

I. Web 構建

1. 項目依賴

咱們選擇使用傳統的SpringMVC + Tomcat/Jetty 運行war包方式來運行任務，建立一個maven項目以後，先添加上基本的依賴web

<artifactId>201-mvc-xml</artifactId>
<!-- 注意這一行，咱們指定war包 -->
<packaging>war</packaging>

<properties>
    <spring.version>5.1.5.RELEASE</spring.version>
</properties>

<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</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>
</dependencies>

2. 項目結構

對於web項目，和咱們傳統的不同的地方在於，會多一個 webapp 目錄，在這個目錄的 WEB-INF 文件夾下，會存有幾個必要的配置文件spring

項目結構

圖中的三個目錄，都屬於比較重要的後端

  • java : 存放源碼
  • resources: 項目資源文件存放地
  • webapp: web的配置文件，資源文件默認存放地

3. 配置文件說明

java和resources這兩個目錄沒啥好說的，主要來看一下webapp下面的三個xml配置文件api

a. web.xml

在咱們使用xml配置的生態體系中，這個配置文件相當重要；本節說到SpringMVC構建的應用，是在Servlet的生態上玩耍的；而web.xml這個配置文件，好比咱們常見的Servlet定義，filter定義等等，都在這xml文件中spring-mvc

實例以下tomcat

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://java.sun.com/xml/ns/j2ee/web-app_3_1.xsd" version="3.1">

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>

    <!-- 解決亂碼的問題 -->
    <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <async-supported>true</async-supported>
        <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>

    <servlet>
        <servlet-name>mvc-dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
        <async-supported>true</async-supported>
    </servlet>

    <servlet-mapping>
        <servlet-name>mvc-dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

上面的配置中，定義了 DispatcherServlet的名字爲 mvc-dispatcher，根據規範，會有一個叫作 mvc-dispatcher-servlet.xml的配置文件，其中的配置將應用於DispatcherServlet的上下文mvc

b. mvc-dispatcher-servlet.xml

這個文件主要能夠用來定義Servlet相關的配置信息，好比視圖解析，資源路徑指定等；一個最簡單的配置以下

<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:beans="http://www.springframework.org/schema/mvc"
       xmlns="http://www.springframework.org/schema/beans"
       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/aop http://www.springframework.org/schema/aop/spring-aop.xsd">


    <!--指定掃描的包路徑，自動註冊包含指定註解的對象到Spring容器，幷包含了 context:annotation-config 的做用-->
    <context:component-scan base-package="com.git.hui.spring"/>
</beans>

在web.xml中，context:component-scan很是很是重要，用來指定自動掃描並註冊bean到容器的包路徑，上面這一行配置，簡單來說能夠認爲作了下面幾件事情

  • 掃描包 com.git.hui.spring 下全部的類，若是類上有 @Component, @Service, @Repository, @Contorller, @RestContorller, @Configuration等註解，會實例化爲bean對象，並註冊到Spring容器中
  • 其次就是實現DI的功能，實現bean的依賴注入

接下來看一下，若是不加上面這一行，也想實現對應的效果改怎樣配置呢?

<!-- 這個使用來激活註冊的Bean，簡單來說就是使Ioc工做起來 -->
<context:annotation-config/>

<bean name="printServer" class="com.git.hui.spring.PrintServer"/>
<bean name="helloRest" class="com.git.hui.spring.HelloRest"/>

源碼後面會給出，首先是主動定義兩個bean，其中 helloRest 爲Controller， printServer 爲一個Service，並被注入到helloRest中

若是隻定義了兩個bean，而不加上<context:annotation-config/>，則HelloRest中的printService會是null，演示以下圖

異常示意圖

此外，若是用了舊的Spring版本，直接用前面的配置，可能依然沒法訪問web服務，這個時候有必要加一下下面的註解; 對於使用aop，但願使用cglib代理的，須要以下配置

<!-- 支持mvc註解-->
<mvc:annotation-driven/>

<!-- 使用cglib實現切面代理 -->
<aop:aspectj-autoproxy proxy-target-class="true"/>

額外說明：如今基本上不怎麼用xml配置了，有更簡單的註解方式，上面的配置內容瞭解便可

c. applicationContext.xml

前面的截圖中，還有個配置文件，這個是幹嗎的呢？

DispatchServlet加載包含在web組件中的bean（如mapper，Controller，ViewResolver)；咱們應用中，還有些其餘的Spring Bean（好比其餘rpc訪問的服務bean代理，db驅動組件等）則更多的是放在這個配置文件中定義

固然這個裏面最簡單的配置內容就是啥都沒有，好比咱們的demo工程

<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd">
</beans>

4. 實例代碼

配置完了以後，咱們簡單的定義一個reset服務用來測試，好比一個簡單dean對象和一個簡單的Controller

簡單的bean對象

@Component
public class PrintServer {

    public void print() {
        System.out.println(System.currentTimeMillis());
    }

}

Controller以下

@RestController
public class HelloRest {

    @Autowired
    private PrintServer printServer;

    @ResponseBody
    @GetMapping("hello")
    public String sayHello(HttpServletRequest request) {
        printServer.print();
        return "hello, " + request.getParameter("name");
    }
}

5. 測試

上面咱們的web應用就搭建完畢了，而後就是把它部署起來，看下能不能愉快的玩耍了；咱們有兩個方法

方法一:tomcat方式

  • 打包 mvn clean package -DskipTests=true ，而後target目錄下會生成一個war包
  • 將war包放在tomcat的webapps目錄下，而後啓動tomcat進行訪問便可

方法二:jetty方式

前面一種方式，有不少公司的服務是這麼玩的，將服務達成war包丟到tomcat中，而後服務上線；然而在本地開發測試時，這樣有點麻煩（固然能夠經過idea配置tomcat調試法，我的感受，依然麻煩）

咱們使用jetty來玩耍就很簡單了，首先在pom中添加配置，引入jetty插件

<build>
    <finalName>web-mvc</finalName>
    <plugins>
        <plugin>
            <groupId>org.eclipse.jetty</groupId>
            <artifactId>jetty-maven-plugin</artifactId>
            <version>9.4.12.RC2</version>
            <configuration>
                <httpConnector>
                    <port>8080</port>
                </httpConnector>
            </configuration>
        </plugin>
    </plugins>
</build>

而後啓動方式可使用命令: mvn jetty:run， 也可使用idea，以下，直接雙擊運行或者右鍵選擇debug模式啓動

啓動說明

而後咱們愉快的啓動測試過程以下

web測試

到此，一個基於 Spring + SpringMVC + Jetty + xml配置的web應用就搭建起來了；下一篇咱們將講一下，純java註解方式，拋棄xml配置又能夠怎樣搭建一個web應用

II. 其餘

- 系列博文

web系列:

mvc應用搭建篇:

0. 項目

1. 一灰灰Blog

一灰灰的我的博客，記錄全部學習和工做中的博文，歡迎你們前去逛逛

2. 聲明

盡信書則不如，以上內容，純屬一家之言，因我的能力有限，不免有疏漏和錯誤之處，如發現bug或者有更好的建議，歡迎批評指正，不吝感激

3. 掃描關注

一灰灰blog

QrCode

知識星球

goals

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程