spring boot 攔截器之WebMvcConfigurerAdapter

版權聲明：本文為博主原創文章，未經博主允許不得轉載。

 

目錄(?)[+]

 

上一篇我們講到了攔截器，我們也簡單的講解到了WebMvcConfigurerAdapter這個攔截器。本篇我們來對WebMvcConfigurerAdapter稍稍的擴展講解一下。

首先我們來看一下WebMvcConfigurerAdapter 源碼

package org.springframework.web.servlet.config.annotation; import java.util.List; import org.springframework.format.FormatterRegistry; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.validation.MessageCodesResolver; import org.springframework.validation.Validator; import org.springframework.web.method.support.HandlerMethodArgumentResolver; import org.springframework.web.method.support.HandlerMethodReturnValueHandler; import org.springframework.web.servlet.HandlerExceptionResolver; public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer { @Override public void configurePathMatch(PathMatchConfigurer configurer) { } @Override public void configureContentNegotiation(ContentNegotiationConfigurer configurer) { } @Override public void configureAsyncSupport(AsyncSupportConfigurer configurer) { } @Override public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { } @Override public void addFormatters(FormatterRegistry registry) { } @Override public void addInterceptors(InterceptorRegistry registry) { } @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { } @Override public void addCorsMappings(CorsRegistry registry) { } @Override public void addViewControllers(ViewControllerRegistry registry) { } @Override public void configureViewResolvers(ViewResolverRegistry registry) { } /*參數解析*/ @Override public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) { } /*返回值解析*/ @Override public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) { } @Override public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { } @Override public void extendMessageConverters(List<HttpMessageConverter<?>> converters) { } /*異常處理解析器*/ @Override public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) { } @Override public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) { } @Override public Validator getValidator() { return null; } @Override public MessageCodesResolver getMessageCodesResolver() { return null; } }

可以看到WebMvcConfigurerAdapter是一個實現了webMvcConfig接口的抽象類，但是里面沒有具體的實現，接下來我們着重找幾個方法講解一下：

 /** * 這里配置視圖解析器 **/ 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 MyWebMvcConfigurerAdapte 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("/test") public ModelAndView test() { Map<String, String> map = new HashMap(); map.put("哈哈", "哈哈哈哈"); map.put("呵呵", "呵呵呵呵"); return new ModelAndView("test", map); } }

 

在WEB-INF/jsp目錄下創建一個test.jsp文件，內容隨意。現在啟動tomcat，在瀏覽器輸入以下鏈接：http://localhost:8080/test.json，瀏覽器內容返回如下：

{
    "哈哈":"哈哈哈哈",
    "呵呵":"呵呵呵呵"
}

在瀏覽器輸入http://localhost:8080/test 或者http://localhost:8080/test.html，內容返回如下：

this is test.jsp

　 
顯然，兩次使用了不同的視圖解析器，那么底層到底發生了什么？在配置里我們注冊了兩個視圖解析器：ContentNegotiatingViewResolver 和 InternalResourceViewResolver，還有一個默認視圖：MappingJackson2JsonView。controller執行完畢之后返回一個ModelAndView，其中視圖的名稱為example1。

1.返回首先會交給ContentNegotiatingViewResolver 進行視圖解析處理，而ContentNegotiatingViewResolver 會先把視圖名example1交給它持有的所有ViewResolver嘗試進行解析（本實例中只有InternalResourceViewResolver），
2.根據請求的mediaType，再將example1.mediaType（這里是example1.json 和example1.html）作為視圖名讓所有視圖解析器解析一遍，兩步解析完畢之后會獲得一堆候選的List<View> 再加上默認的MappingJackson2JsonView ，
3.根據請求的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("forward:/index.html"); } 

　　這是訪問${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(); configurer.enable("defaultServletName"); }

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

 

 

 

來源:http://blog.csdn.net/wujiaqi0921/article/details/78324722