前言

　　Spring mvc框架相信很多人都很熟悉了，關於這方面的資料也是一搜一大把。但是感覺講的都不是很細緻，讓很多初學者都雲裡霧裡的。本人也是這樣，之前研究過，但是後面一段時間不用發現又忘記了。所以決定寫下來，以備後用。
　　本系列文基於spring-4.3.1，配置方式全部基於java-based方式

從配置講起

先上一段配置的程式碼：

@EnableWebMvc
@Configuration
public class MvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configureDefaultServletHandling
 
(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        registry.jsp("/WEB-INF/jsp/", ".jsp");
        registry.enableContentNegotiation(new MappingJackson2JsonView());
    }

    @Override
 

    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.favorPathExtension(true)
                .ignoreAcceptHeader(true)
                .parameterName("mediaType")
                .defaultContentType(MediaType.TEXT_HTML)
                .mediaType("html"
 
, MediaType.TEXT_HTML)
                .mediaType("json", MediaType.APPLICATION_JSON);
    }

    @Bean(name = "multipartResolver")
    // 檔案上傳bean
    public CommonsMultipartResolver commonsMultipartResolver() {
        return new CommonsMultipartResolver();
    }
}

　　基於java-based方式的spring mvc配置，需要建立一個配置類並實現WebMvcConfigurer 介面，WebMvcConfigurerAdapter 抽象類是對WebMvcConfigurer 介面的簡單抽象（增加了一些預設實現），所以上面配置程式碼選擇直接繼承WebMvcConfigurerAdapter 。然後根據專案的需要實現介面中特定的方法，最後要注意的是，要在配置類上標註@EnableWebMvc。
　　到這裡可能有人會問，我怎麼知道實現哪些方法？具體該怎麼配？它們之間的處理流程是怎樣的？好的，別急，我們一步步來。
　　首先第一步，我們需要知道WebMvcConfigurer 介面都提供了哪些回撥方法？

WebMvcConfigurer

package org.springframework.web.servlet.config.annotation;
/**
 * 篇幅原因，我們先只介紹Spring mvc常用的一些方法
 */
public interface WebMvcConfigurer {

    void addFormatters(FormatterRegistry registry);

    void configureMessageConverters(List<HttpMessageConverter<?>> converters);

    void extendMessageConverters(List<HttpMessageConverter<?>> converters);

    Validator getValidator();

    /* 配置內容裁決的一些選項*/
    void configureContentNegotiation(ContentNegotiationConfigurer configurer);

    void configureAsyncSupport(AsyncSupportConfigurer configurer);

    /* @since 4.0.3 */
    void configurePathMatch(PathMatchConfigurer configurer);

    /*引數解析*/
    void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers);

    /*返回值解析*/
    void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers);

    /*異常處理*/
    void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers);

    void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers);

    void addInterceptors(InterceptorRegistry registry);

    MessageCodesResolver getMessageCodesResolver();

    void addViewControllers(ViewControllerRegistry registry);

    /**
     * 這裡配置檢視解析器
     */
    void configureViewResolvers(ViewResolverRegistry registry);

    /**
     *靜態資源處理
     */
    void addResourceHandlers(ResourceHandlerRegistry registry);

    void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);

    void addCorsMappings(CorsRegistry registry);
}

下面我們開始著重講解以下幾個常用的方法：

void configureViewResolvers(ViewResolverRegistry registry);
void configureContentNegotiation(ContentNegotiationConfigurer configurer);
void addViewControllers(ViewControllerRegistry registry);
void addResourceHandlers(ResourceHandlerRegistry registry);
void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);

1. configureViewResolvers(ViewResolverRegistry registry)

　　從方法名稱我們就能看出這個方法是用來配置檢視解析器的，該方法的引數ViewResolverRegistry 是一個註冊器，用來註冊你想自定義的檢視解析器等。ViewResolverRegistry 常用的幾個方法：

１)．enableContentNegotiation

/** 啟用內容裁決檢視解析器*/
public void enableContentNegotiation(View... defaultViews) {
        initContentNegotiatingViewResolver(defaultViews);
    }

　　該方法會建立一個內容裁決解析器ContentNegotiatingViewResolver ，該解析器不進行具體檢視的解析，而是管理你註冊的所有檢視解析器，所有的檢視會先經過它進行解析，然後由它來決定具體使用哪個解析器進行解析。具體的對映規則是根據請求的media types來決定的。

2). 　UrlBasedViewResolverRegistration

    public UrlBasedViewResolverRegistration jsp(String prefix, String suffix) {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix(prefix);
        resolver.setSuffix(suffix);
        this.viewResolvers.add(resolver);
        return new UrlBasedViewResolverRegistration(resolver);
    }

　　該方法會註冊一個內部資源檢視解析器InternalResourceViewResolver 顯然訪問的所有jsp都是它進行解析的。該方法引數用來指定路徑的字首和檔案字尾，如：　　

    registry.jsp("/WEB-INF/jsp/", ".jsp");

　　對於以上配置，假如返回的檢視名稱是example，它會返回/WEB-INF/jsp/example.jsp給前端，找不到則報404。
　　

3). 　beanName

    public void beanName() {
        BeanNameViewResolver resolver = new BeanNameViewResolver();
        this.viewResolvers.add(resolver);
    }

　　該方法會註冊一個BeanNameViewResolver 檢視解析器，這個解析器是幹嘛的呢？它主要是將檢視名稱解析成對應的bean。什麼意思呢？假如返回的檢視名稱是example，它會到spring容器中找有沒有一個叫example的bean，並且這個bean是View.class型別的？如果有，返回這個bean。
　　

4). 　viewResolver

    public void viewResolver(ViewResolver viewResolver) {
        if (viewResolver instanceof ContentNegotiatingViewResolver) {
            throw new BeanInitializationException(
                    "addViewResolver cannot be used to configure a ContentNegotiatingViewResolver. Please use the method enableContentNegotiation instead.");
        }
        this.viewResolvers.add(viewResolver);
    }

　　這個方法想必看名字就知道了，它就是用來註冊各種各樣的檢視解析器的，包括自己定義的。
　　

2. configureContentNegotiation(ContentNegotiationConfigurer configurer)

　　上面一節我們講了configureViewResolvers 方法，假如在該方法中我們啟用了內容裁決解析器，那麼configureContentNegotiation(ContentNegotiationConfigurer configurer) 這個方法是專門用來配置內容裁決的一些引數的。這個比較簡單，我們直接通過一個例子看：
　　

   public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
       /* 是否通過請求Url的副檔名來決定media type */
        configurer.favorPathExtension(true)  
                 /* 不檢查Accept請求頭 */
                .ignoreAcceptHeader(true)
                .parameterName("mediaType")
                 /* 設定預設的media yype */
                .defaultContentType(MediaType.TEXT_HTML)
                 /* 請求以.html結尾的會被當成MediaType.TEXT_HTML*/
                .mediaType("html", MediaType.TEXT_HTML)
                /* 請求以.json結尾的會被當成MediaType.APPLICATION_JSON*/
                .mediaType("json", MediaType.APPLICATION_JSON);
    }

　到這裡我們就可以舉個例子來進一步熟悉下我們上面講的知識了，假如我們MVC的配置如下：

    @EnableWebMvc
    @Configuration
    public class MvcConfig extends WebMvcConfigurerAdapter {

        @Override
        public void configureViewResolvers(ViewResolverRegistry registry) {
            registry.jsp("/WEB-INF/jsp/", ".jsp");
            registry.enableContentNegotiation(new MappingJackson2JsonView());
        }

        @Override
        public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
            configurer.favorPathExtension(true)
                    .ignoreAcceptHeader(true)
                    .parameterName("mediaType")
                    .defaultContentType(MediaType.TEXT_HTML)
                    .mediaType("html", MediaType.TEXT_HTML)
                    .mediaType("json", MediaType.APPLICATION_JSON);
        }
    }

　　controller的程式碼如下：

    @Controller
    public class ExampleController {
         @RequestMapping("/example1")
         public ModelAndView example1() {
            Map<String, String> map = new HashMap();
            map.put("1", "a");
            map.put("2", "b");
            return new ModelAndView("example1", map);
        }
    }

　　在WEB-INF/jsp目錄下建立一個example1.jsp檔案，內容隨意。現在啟動tomcat，在瀏覽器輸入以下連結：http://localhost:8080/example1.json，瀏覽器返回如下：
　　
在瀏覽器輸入http://localhost:8080/example1 或者http://localhost:8080/example1.html，返回如下：

　　顯然，兩次使用了不同的檢視解析器，那麼底層到底發生了什麼？在配置裡我們註冊了兩個檢視解析器：ContentNegotiatingViewResolver 和 InternalResourceViewResolver，還有一個預設檢視：MappingJackson2JsonView。controller執行完畢之後返回一個ModelAndView，其中檢視的名稱為example1。返回首先會交給ContentNegotiatingViewResolver 進行檢視解析處理，而ContentNegotiatingViewResolver 會先把檢視名example1交給它持有的所有ViewResolver嘗試進行解析（本例項中只有InternalResourceViewResolver），然後根據請求的mediaType，再將example1.mediaType（這裡是example1.json 和example1.html）作為檢視名讓所有檢視解析器解析一遍，兩步解析完畢之後會獲得一堆候選的List<View> 再加上預設的MappingJackson2JsonView ，最後根據請求的media type從候選的List<View> 中選擇一個最佳的返回，至此檢視解析完畢。現在就可以理解上例中為何請求連結加上.json 和不.json 結果會不一樣。當加上.json 時，表示請求的media type 為MediaType.APPLICATION_JSON，而InternalResourceViewResolver 解析出來的檢視的ContentType與其不符，而與MappingJackson2JsonView 的ContentType相符，所以選擇了MappingJackson2JsonView 作為檢視返回。當不加.json 請求時，預設的media type 為MediaType.TEXT_HTML，所以就使用了InternalResourceViewResolver解析出來的檢視作為返回值了。我想看到這裡你已經大致可以自定義檢視了。

3. addViewControllers(ViewControllerRegistry registry)

　　此方法可以很方便的實現一個請求到檢視的對映，而無需書寫controller，例如：
　　

    @Override  
    public void addViewControllers(ViewControllerRegistry registry){  
        registry.addViewController("/login").setViewName("login");  
    } 

　　這是訪問${domain}/login時，會直接返回login頁面。

4. addResourceHandlers(ResourceHandlerRegistry registry)

　　此方法用來專門註冊一個Handler，來處理靜態資源的，例如：圖片，js，css等。舉例：
　　

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/resource/**").addResourceLocations("/WEB-INF/static/");
    }

　　當你請求http://localhost:8083/resource/1.png時，會把/WEB-INF/static/1.png返回。注意：這裡的靜態資源是放置在WEB-INF目錄下的。

5. configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)

　　用法：

    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

　　此時會註冊一個預設的Handler：DefaultServletHttpRequestHandler，這個Handler也是用來處理靜態檔案的，它會嘗試對映/*。當DispatcherServelt對映/時（/ 和/* 是有區別的），並且沒有找到合適的Handler來處理請求時，就會交給DefaultServletHttpRequestHandler 來處理。注意：這裡的靜態資源是放置在web根目錄下，而非WEB-INF 下。
　　可能這裡的描述有點不好懂（我自己也這麼覺得），所以簡單舉個例子，例如：在webroot目錄下有一個圖片：1.png 我們知道Servelt規範中web根目錄（webroot）下的檔案可以直接訪問的，但是由於DispatcherServlet配置了對映路徑是：/ ，它幾乎把所有的請求都攔截了，從而導致1.png 訪問不到，這時註冊一個DefaultServletHttpRequestHandler 就可以解決這個問題。其實可以理解為DispatcherServlet破壞了Servlet的一個特性（根目錄下的檔案可以直接訪問），DefaultServletHttpRequestHandler是幫助迴歸這個特性的。

題外話

　 問：　/和/*　有什麼區別？
　 答： /會攔截除了jsp以外的所有url，/* 會攔截所有url，包括jsp。例如：在webroot下面有一個test.jsp,當DispatcherServlet 配置對映/ 時，瀏覽器輸入：http://localhost:8083/test.jsp 這個jsp是可以直接訪問的，並且不經過DispatcherServlet ，而當DispatcherServlet 配置對映/* 時，這個請求就會被DispatcherServlet 攔截。