天天看點
傳回

【SpringMVC】SpringMVC基礎-SpringMVC項目快速搭建、日志架構為logback

分析

Spring MVC提供了一個DispatcherServlet來開發Web應用。

在Servlet 2.5 及以下的時候隻要在web.xml下配置​

​<servlet>​

​元素即可。

在下面的示例中，使用的是Servlet3.0+無web.xml的配置方式，在Spring MVC裡實作WebApplicationInitialzer接口實作等同于web.xml的配置。

下面執行個體在IDEA中基于Maven搭建零配置的Spring MVC原型項目。

示例

建構Maven項目

pom.xml内容：

<?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">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.chenhaoxiang</groupId>
    <artifactId>highlight_springmvc4</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <!--Generic properties -->
        <java.version>1.7</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <!-- Web -->
        <jsp.version>2.2</jsp.version>
        <jstl.version>1.2</jstl.version>
        <servlet.version>3.1.0</servlet.version>

        <!-- Spring -->
        <spring-framework.version>4.2.3.RELEASE</spring-framework.version>

        <!--Logging -->
        <logback.version>1.0.13</logback.version>
        <slf4j.version>1.7.7</slf4j.version>
        <log4j.version>1.2.17</log4j.version>

    </properties>

    <dependencies>
        <dependency>
            <groupId>javax</groupId>
            <artifactId>javaee-web-api</artifactId>
            <version>7.0</version>
            <scope>provided</scope>
        </dependency>

        <!-- Spring MVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring-framework.version}</version>
        </dependency>

        <!-- 其他Web依賴 -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>${jstl.version}</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>${servlet.version}</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>${jsp.version}</version>
            <scope>provided</scope>
        </dependency>

        <!-- Spring and Transaction -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring-framework.version}</version>
        </dependency>

        <!-- 使用SLF4J和LogBack作為日志 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>${logback.version}</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>${logback.version}</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-access</artifactId>
            <version>${logback.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

日志配置

在src/main/resources目錄下，建立logback.xml用來配置日志，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 可以這樣描述配置檔案的基本結構：以<configuration>開頭，
後面有零個或多個<appender>元素，有零個或多個<logger>元素，有最多一個<root>元素 -->
<configuration debug="false" scan="true" scanPeriod="1 seconds">
    <!-- debug : 預設為false ，設定為true時，将列印出logback内部日志資訊，實時檢視logback運作狀态。
    scan : 配置檔案如果發生改變，将會重新加載，預設值為true；
    scanPeriod : 檢測配置檔案是否有修改的時間間隔，如果沒有給出時間機關，預設機關時毫秒，
    當scan為true時，這個屬性生效，預設時間間隔為1min。    -->

    <contexListener class="ch.qos.logback.classic.jul.LevelChangePropagator">
        <resetJUL>true</resetJUL>
    </contexListener>

    <jmxConfigurator/>

    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!-- <appender>  是  <configuration> 的子節點，是負責寫日志的元件。
         appender 有兩個必要屬性 name ，class 。name指定appender 的名稱， class 指定appender的全限定名
         class 包括 ：ch.qos.logback.core.ConsoleAppender / ch.qos.logback.core.FileAppender/ ch.qos.logback.core.RollingFileAppender -->
        <encoder>
            <!--ch.qos.logback.core.ConsoleAppender 把日志添加到控制台，有如下節點： <encoder> : 對日志進行格式化。
            <target> : 字元串System.out 或者 System.err, 預設 System.out;
            ch.qos.logback.core.FileAppender 把日志添加到檔案
             ch.qos.logback.core.RollingFileAppender[常用] 滾動紀錄檔案，先将日志記錄到指定檔案，當符合某種條件時，将日志記錄到其他檔案-->
            <pattern>logbak: %d{HH:mm:ss.SSS} %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="org.springframework.web" level="DEBUG"></logger>
    <!--logger 是 <configuration> 的子節點 來設定某一個包或者具體的某一個類的日志列印級别，以及指定<appender>
      loger 僅有一個name屬性，兩個可選屬性 level／addtivity
      name ： 用來指定受此loger限制的某一個包或者具體的某一個類
      level：用來設定列印級别，大小寫無關-->

    <!-- 元素配置根 logger。該元素有一個 level 屬性。沒有 name 屬性，因為已經被命名 為“root”-->
    <!-- 預設根節點是INFO級别的日志 -->
    <!-- root：logger的根節點，就這一個，預設名稱就是root
        level：日志級别
        appender-ref：确定使用哪個appender
         -->
    <root level="info">
        <appender-ref ref="console"></appender-ref>
    </root>

</configuration>

将org.springframwork.web包下的類的日志級别設定為DEBUG，我們開發Spring MVC經常出現和參數類型相關的4XX錯誤，設定此項我們會看到更詳細的錯誤資訊。

示範頁面

在這裡有一個注意的地方，頁面的建立位置。

在src/main/resources下建立views目錄，并在此目錄下建立index.jsp。

内容如下：

<%--
  Created by IntelliJ IDEA.
  User: 陳浩翔
  Date: 2016/12/18
  Time: 下午 12:45
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>MVC Title</title>
</head>
<body>
    <pre>Welcome to Spring MVC</pre>
    <br/>
    歡迎！
</body>
</html>

這裡的頁面不放在Maven标準的src/main/webapp/WEB-INF下，在這裡這麼放的原因是，Spring Boot的頁面是放置在src/main/resources下。

Spring MVC配置類

這個就是一個簡單的Spring配置類。

在這裡配置了一個JSP的ViewResolver，用來映射路徑和實際頁面的位置，其中，@EnableWebMvc注解會開啟一些預設配置，如一些ViewResolver或者MessageConverter等

package cn.hncu.springmvc;

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;

/**
 * Created with IntelliJ IDEA.
 * User: 陳浩翔.
 * Date: 2016/12/19.
 * Time: 下午 3:39.
 * Explain:配置類
 */
@Configuration
@EnableWebMvc
@ComponentScan("cn.hncu.springmvc")
public class MyMvcConfig {
    @Bean
    public InternalResourceViewResolver viewResolver(){
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/classes/views/");//映射路徑-運作時代碼會将我們的頁面自動編譯到/WEB-INF/classes/views/下
        viewResolver.setSuffix(".jsp");//實際頁面字尾
        viewResolver.setViewClass(JstlView.class);
        return viewResolver;
    }
}

Spring MVC的ViewResolver，這個是Spring MVC視圖(JSP下就是html)渲染的核心機制；Spring MVC裡有一個接口叫做ViewResolver(我們的ViewResolver都實作該接口)，實作這個接口要重寫resolverViewName()，這個方法的傳回值是接口View，而View的職責就是使用model、request、response對象，并将渲染的視圖(不一定是html，可能是json、xml、pdf)傳回給浏覽器。

可能會對映射路徑字首配置為/WEB-INF/classes/views/有點奇怪，這不是我們放頁面的路徑啊。

這是因為看到的頁面效果是運作時而不是開發時的代碼，運作時代碼會将我們的頁面自動編譯到/WEB-INF/classes/views/下、

如圖：

【SpringMVC】SpringMVC基礎-SpringMVC項目快速搭建、日志架構為logback

這個是編譯後的路徑！

Web配置類

這個類就是為了代替web.xml的位置的。

package cn.hncu.springmvc;

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;

/**
 * Created with IntelliJ IDEA.
 * User: 陳浩翔.
 * Date: 2016/12/19.
 * Time: 下午 3:44.
 * Explain:Web配置
 */
public class WebInitializer implements WebApplicationInitializer {
    //WebApplicationInitializer是spring提供用來配置Servlet3.0+配置的接口，進而實作了替代web.xml的位置。
    //實作此接口将會自動被SpringServletContainerInitializer（用來啟動Servlet3.0容器）擷取到

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
        context.register(MyMvcConfig.class);
        context.setServletContext(servletContext);//建立WebApplicationContext,注冊配置類，并将其和目前servletContext關聯

        ServletRegistration.Dynamic servlet = servletContext.addServlet("dispatcher",new DispatcherServlet(context));
        //注冊Spring MVC的DispatcherServlet
        servlet.addMapping("/");
        servlet.setLoadOnStartup(1);
    }
}

簡單的控制器 

package cn.hncu.springmvc;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * Created with IntelliJ IDEA.
 * User: 陳浩翔.
 * Date: 2016/12/19.
 * Time: 下午 3:55.
 * Explain:簡單控制器
 */
@Controller //利用@Controller注解聲明是一個控制器
public class HelloController {
    @RequestMapping("/index")//利用@RequestMapping配置URL和方法之間的映射
    public String hello(){
        return "index";//通過上面ViewResolver的Bean配置，傳回值為index，說明我們的頁面放置的路徑是：/WEB-INF/classes/views/index.jsp
    }
}

在這裡，我們通過@RequestMapping配置URL和方法之間的映射，來通路實際的頁面！

運作結果

最後，将程式部署到Tomcat中，啟動Tomcat,通路：

http://localhost:8080/springMVC/index

【SpringMVC】SpringMVC基礎-SpringMVC項目快速搭建、日志架構為logback

本篇部落格涉及到的源碼連結：

【​​->點選通路源碼-©CHX​​】

作者：谙憶， 所有權利保留。

歡迎轉載，分享是進步的源泉。

spring mvc spring mvc xml
上一篇: 【Spring】Spring進階話題-計劃任務-@EnableScheduling
下一篇: Spring Boot Spring Cloud 微服務 分布式項目 實作接口幂等性的 4 種方案

繼續閱讀