WebMvcConfigurer配置類其實是Spring內部的一種配置方式,采用JavaBean的形式來代替傳統的xml配置文件形式進行針對框架個性化定制。基于java-based方式的spring mvc配置,需要創建一個配置類并實現WebMvcConfigurer 接口,WebMvcConfigurerAdapter 抽象類是對WebMvcConfigurer接口的簡單抽象(增加了一些默認實現),但在在SpringBoot2.0及Spring5.0中WebMvcConfigurerAdapter已被廢棄 。官方推薦直接實現WebMvcConfigurer或者直接繼承WebMvcConfigurationSupport,方式一實現WebMvcConfigurer接口(推薦),方式二繼承WebMvcConfigurationSupport類,具體實現可看這篇文章。https://www.jb51.net/article/174766.htm
創新互聯公司專注為客戶提供全方位的互聯網綜合服務,包含不限于網站制作、成都做網站、寧明網絡推廣、微信小程序開發、寧明網絡營銷、寧明企業策劃、寧明品牌公關、搜索引擎seo、人物專訪、企業宣傳片、企業代運營等,從售前售中售后,我們都將竭誠為您服務,您的肯定,是我們最大的嘉獎;創新互聯公司為所有大學生創業者提供寧明建站搭建服務,24小時服務熱線:13518219792,官方網址:vcdvsql.cn
// // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) // 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 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(); }
接下來我們著重找幾個方法講解一下:
/* 攔截器配置 */ void addInterceptors(InterceptorRegistry var1); /* 視圖跳轉控制器 */ void addViewControllers(ViewControllerRegistry registry); /** *靜態資源處理 **/ void addResourceHandlers(ResourceHandlerRegistry registry); /* 默認靜態資源處理器 */ void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer); /** * 這里配置視圖解析器 **/ void configureViewResolvers(ViewResolverRegistry registry); /* 配置內容裁決的一些選項*/ void configureContentNegotiation(ContentNegotiationConfigurer configurer);
1、addInterceptors(InterceptorRegistry registry)
此方法用來專門注冊一個Interceptor,如HandlerInterceptorAdapter
@Configuration public class MyWebMvcConfigurer implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").excludePathPatterns("/emp/toLogin","/emp/login","/js/**","/css/**","/images/**"); } }
addPathPatterns("/**")對所有請求都攔截,但是排除了/toLogin和/login請求的攔截。
當spring boot版本升級為2.x時,訪問靜態資源就會被HandlerInterceptor攔截,網上有很多處理辦法都是如下寫法
.excludePathPatterns("/index.html","/","/user/login","/static/**");
可惜本人在使用時一直不起作用,查看請求的路徑里并沒有/static/如圖:
于是我改成了"/js/**","/css/**","/images/**"這樣頁面內容就可以正常訪問了,我的項目結構如下:
2. 頁面跳轉addViewControllers
以前寫SpringMVC的時候,如果需要訪問一個頁面,必須要寫Controller類,然后再寫一個方法跳轉到頁面,感覺好麻煩,其實重寫WebMvcConfigurer中的addViewControllers方法即可達到效果了
/** * 以前要訪問一個頁面需要先創建個Controller控制類,再寫方法跳轉到頁面 * 在這里配置后就不需要那么麻煩了,直接訪問http://localhost:8080/toLogin就跳轉到login.jsp頁面了 * @param registry */ @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/toLogin").setViewName("login"); }
值的指出的是,在這里重寫addViewControllers方法,并不會覆蓋WebMvcAutoConfiguration中的addViewControllers(在此方法中,Spring Boot將“/”映射至index.html),這也就意味著我們自己的配置和Spring Boot的自動配置同時有效,這也是我們推薦添加自己的MVC配置的方式。
3. 自定義資源映射addResourceHandlers
比如,我們想自定義靜態資源映射目錄的話,只需重寫addResourceHandlers方法即可。
注:如果繼承WebMvcConfigurationSupport類實現配置時必須要重寫該方法,具體見其它文章
@Configuration public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer { /** * 配置靜態訪問資源 * @param registry */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/my/**").addResourceLocations("classpath:/my/"); } }
通過addResourceHandler添加映射路徑,然后通過addResourceLocations來指定路徑。我們訪問自定義my文件夾中的elephant.jpg 圖片的地址為 http://localhost:8080/my/elephant.jpg
如果你想指定外部的目錄也很簡單,直接addResourceLocations指定即可,代碼如下:
@Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/my/**").addResourceLocations("file:E:/my/"); }
addResourceLocations指的是文件放置的目錄,addResoureHandler指的是對外暴露的訪問路徑
4. 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是幫助回歸這個特性的。
5、configureViewResolvers(ViewResolverRegistry registry)
從方法名稱我們就能看出這個方法是用來配置視圖解析器的,該方法的參數ViewResolverRegistry 是一個注冊器,用來注冊你想自定義的視圖解析器等。ViewResolverRegistry 常用的幾個方法:
1).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); }
這個方法想必看名字就知道了,它就是用來注冊各種各樣的視圖解析器的,包括自己定義的。
6. 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解析出來的視圖作為返回值了。我想看到這里你已經大致可以自定義視圖了。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持創新互聯。
名稱欄目:SpringBoot配置接口WebMvcConfigurer的實現
文章來源:http://vcdvsql.cn/article36/pdecpg.html
成都網站建設公司_創新互聯,為您提供域名注冊、標簽優化、網站營銷、自適應網站、做網站、品牌網站制作
聲明:本網站發布的內容(圖片、視頻和文字)以用戶投稿、用戶轉載內容為主,如果涉及侵權請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網站立場,如需處理請聯系客服。電話:028-86922220;郵箱:631063699@qq.com。內容未經允許不得轉載,或轉載時需注明來源: 創新互聯