springboot~WebMvcConfigurer詳解
1. 前言
WebMvcConfigurer配(pei)置(zhi)類其實(shi)是Spring內部(bu)的一(yi)種配(pei)置(zhi)方(fang)式,采(cai)用JavaBean的形(xing)式來代替傳(chuan)統的xml配(pei)置(zhi)文件形(xing)式進行(xing)針對框(kuang)架個性化定制,可(ke)以自定義一(yi)些Handler,Interceptor,ViewResolver,MessageConverter。基于java-based方(fang)式的spring mvc配(pei)置(zhi),需(xu)要創建一(yi)個配(pei)置(zhi)類并(bing)實(shi)現WebMvcConfigurer 接口;
在Spring Boot 1.5版本都是靠重(zhong)寫WebMvcConfigurerAdapter的方(fang)(fang)法(fa)來添(tian)加自定義攔截器,消息轉換器等。SpringBoot 2.0 后,該類(lei)被標記為@Deprecated(棄用)。官(guan)方(fang)(fang)推(tui)薦(jian)直接實(shi)現(xian)WebMvcConfigurer或者直接繼(ji)承WebMvcConfigurationSupport,方(fang)(fang)式一實(shi)現(xian)WebMvcConfigurer接口(推(tui)薦(jian)),方(fang)(fang)式二繼(ji)承WebMvcConfigurationSupport類(lei),具體實(shi)現(xian)可看(kan)這(zhe)篇(pian)文章。
沖突問題
SpringBoot添加Interceptor后addInterceptors方法不執行,攔截器不生效
原因其實很(hen)簡(jian)單,因為代碼(ma)中有【WebMvcConfigurationSupport】的繼承類(lei),SpringBoot會判(pan)斷,如果有【WebMvcConfigurationSupport】就不會加載(zai)【WebMvcConfigurer】。
2. WebMvcConfigurer接口說明
2.1:原碼
public interface WebMvcConfigurer {
void configurePathMatch(PathMatchConfigurer var1);
void configureContentNegotiation(ContentNegotiationConfigurer var1);
void configureAsyncSupport(AsyncSupportConfigurer var1);
void configureDefaultServletHandling(DefaultServletHandlerConfigurer var1);
void addFormatters(FormatterRegistry var1);
void addInterceptors(InterceptorRegistry var1);
void addResourceHandlers(ResourceHandlerRegistry var1);
void addCorsMappings(CorsRegistry var1);
void addViewControllers(ViewControllerRegistry var1);
void configureViewResolvers(ViewResolverRegistry var1);
void addArgumentResolvers(List<HandlerMethodArgumentResolver> var1);
void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> var1);
void configureMessageConverters(List<HttpMessageConverter<?>> var1);
void extendMessageConverters(List<HttpMessageConverter<?>> var1);
void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> var1);
void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> var1);
Validator getValidator();
MessageCodesResolver getMessageCodesResolver();
}
2.2:常用的方法:
/* 攔截器配置 */
void addInterceptors(InterceptorRegistry var1);
/* 視圖跳轉控制器 */
void addViewControllers(ViewControllerRegistry registry);
/**
*靜態資源處理
**/
void addResourceHandlers(ResourceHandlerRegistry registry);
/* 默認靜態資源處理器 */
void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);
/**
* 這里配置視圖解析器
**/
void configureViewResolvers(ViewResolverRegistry registry);
/* 配置內容裁決的一些選項*/
void configureContentNegotiation(ContentNegotiationConfigurer configurer);
/** 解決跨域問題 **/
public void addCorsMappings(CorsRegistry registry) ;
2.3 addInterceptors:攔截器
addInterceptor:需要一個實現HandlerInterceptor接口的攔截器實例
addPathPatterns:用于設置攔截器的過濾路徑規則;addPathPatterns("/**")對所有請求都攔截
excludePathPatterns:用于設置不需要攔截的過濾規則
攔(lan)截器(qi)主要用(yong)途:進(jin)行用(yong)戶登錄狀(zhuang)態的(de)攔(lan)截,日志的(de)攔(lan)截等(deng)。
@Override
public void addInterceptors(InterceptorRegistry registry) {
super.addInterceptors(registry);
registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**").excludePathPatterns("/emp/toLogin","/emp/login","/js/**","/css/**","/images/**");
}
2.4 addViewControllers:頁面跳轉, 比如登錄跳轉或錯誤頁面跳轉
以前寫SpringMVC的時候,如果需要訪問一個頁面,必須要寫Controller類,然后再寫一個方法跳轉到頁面,感覺好麻煩,其實重寫WebMvcConfigurer中的addViewControllers方法即可達到效果了
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/toLogin").setViewName("login");
registry.addViewController("/403").setViewName("/403");
registry.addViewController("/404").setViewName("/404");
}
值的(de)指出的(de)是,在(zai)這里(li)重寫(xie)addViewControllers方(fang)法,并不(bu)會覆(fu)蓋(gai)WebMvcAutoConfiguration(Springboot自(zi)動(dong)配(pei)(pei)置(zhi))中的(de)addViewControllers(在(zai)此(ci)方(fang)法中,Spring Boot將“/”映(ying)射至(zhi)index.html),這也就意味著自(zi)己(ji)的(de)配(pei)(pei)置(zhi)和Spring Boot的(de)自(zi)動(dong)配(pei)(pei)置(zhi)同(tong)時有效,這也是我們推薦添加自(zi)己(ji)的(de)MVC配(pei)(pei)置(zhi)的(de)方(fang)式。
2.5 addResourceHandlers:靜態資源
比如,我們想自定義靜態資源映射目錄的話,只需重寫addResourceHandlers方法即可。
注:如(ru)果繼承(cheng)WebMvcConfigurationSupport類實現配置時必須要重寫該方法,具體見其它文(wen)章(zhang)
@Configuration
public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer {
/**
* 配置靜態訪問資源
* @param registry
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**")
.addResourceLocations("classpath:/resources")
.addResourceLocations("classpath:/static")
.addResourceLocations("classpath:/templates")
.addResourceLocations("classpath:/cert")
.addResourceLocations("classpath:/ueditor")
.addResourceLocations("classpath:/shiro");
registry.addResourceHandler("swagger-ui.html").addResourceLocations(
"classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations(
"classpath:/META-INF/resources/webjars/");
registry.addResourceHandler("/workflow/**").addResourceLocations("classpath:/static/workflow/");
super.addResourceHandlers(registry);
}
}
addResoureHandler:指的是對外暴露的訪問路徑
addResourceLocations:指(zhi)的是內部文件放置的目(mu)錄(lu)
2.6 configureDefaultServletHandling:默認靜態資源處理器
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
configurer.enable("defaultServletName");
}
此時會注冊一個默認的Handler:DefaultServletHttpRequestHandler,這個Handler也是用來處理靜態文件的,它會嘗試映射/。當DispatcherServelt映射/時(/ 和/ 是有區別的),并且沒有找到合適的Handler來處理請求時,就會交給DefaultServletHttpRequestHandler 來處理。注意:這里的靜態資源是放置在web根目錄下,而非WEB-INF 下。
可能這里(li)的(de)描(miao)述有(you)(you)點不好(hao)懂(我自己也這么覺得),所(suo)以簡(jian)單(dan)舉個(ge)例子(zi),例如:在webroot目(mu)(mu)錄下有(you)(you)一個(ge)圖片(pian):1.png 我們知道(dao)Servelt規范(fan)中web根(gen)目(mu)(mu)錄(webroot)下的(de)文(wen)(wen)件(jian)可以直接(jie)訪(fang)(fang)問的(de),但是由于DispatcherServlet配置了(le)映射路徑是:/ ,它幾乎把所(suo)有(you)(you)的(de)請求都攔截了(le),從而(er)導(dao)致1.png 訪(fang)(fang)問不到,這時注冊一個(ge)DefaultServletHttpRequestHandler 就可以解決這個(ge)問題。其實可以理解為DispatcherServlet破(po)壞了(le)Servlet的(de)一個(ge)特(te)性(根(gen)目(mu)(mu)錄下的(de)文(wen)(wen)件(jian)可以直接(jie)訪(fang)(fang)問),DefaultServletHttpRequestHandler是幫助回歸這個(ge)特(te)性的(de)。