SpringBoot---WebMvcConfigurer详解

目录

 

1. 简介

2. WebMvcConfigurer接口

2.1 addInterceptors:拦截器

2.2 addViewControllers:页面跳转

2.3 addResourceHandlers:静态资源

2.4 configureDefaultServletHandling:默认静态资源处理器

2.5 configureViewResolvers:视图解析器

2.6 configureContentNegotiation:配置内容裁决的一些参数

2.7 addCorsMappings:跨域

2.8 configureMessageConverters:信息转换器


1. 简介

WebMvcConfigurer配置类其实是Spring内部的一种配置方式,采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制,可以自定义一些Handler,Interceptor,ViewResolver,MessageConverter。基于java-based方式的spring mvc配置,需要创建一个配置类并实现WebMvcConfigurer 接口;

在Spring Boot 1.5版本都是靠重写WebMvcConfigurerAdapter的方法来添加自定义拦截器,消息转换器等。SpringBoot 2.0 后,该类被标记为@Deprecated(弃用)。官方推荐直接实现WebMvcConfigurer或者直接继承WebMvcConfigurationSupport,方式一实现WebMvcConfigurer接口(推荐),方式二继承WebMvcConfigurationSupport类,具体实现可看这篇文章。https://blog.csdn.net/fmwind/article/details/82832758

2. WebMvcConfigurer接口


   
   
  1. public interface WebMvcConfigurer {
  2. void configurePathMatch (PathMatchConfigurer var1);
  3. void configureContentNegotiation (ContentNegotiationConfigurer var1);
  4. void configureAsyncSupport (AsyncSupportConfigurer var1);
  5. void configureDefaultServletHandling (DefaultServletHandlerConfigurer var1);
  6. void addFormatters (FormatterRegistry var1);
  7. void addInterceptors (InterceptorRegistry var1);
  8. void addResourceHandlers (ResourceHandlerRegistry var1);
  9. void addCorsMappings (CorsRegistry var1);
  10. void addViewControllers (ViewControllerRegistry var1);
  11. void configureViewResolvers (ViewResolverRegistry var1);
  12. void addArgumentResolvers (List<HandlerMethodArgumentResolver> var1);
  13. void addReturnValueHandlers (List<HandlerMethodReturnValueHandler> var1);
  14. void configureMessageConverters (List<HttpMessageConverter<?>> var1);
  15. void extendMessageConverters (List<HttpMessageConverter<?>> var1);
  16. void configureHandlerExceptionResolvers (List<HandlerExceptionResolver> var1);
  17. void extendHandlerExceptionResolvers (List<HandlerExceptionResolver> var1);
  18. Validator getValidator ();
  19. MessageCodesResolver getMessageCodesResolver ();
  20. }

常用的方法:


   
   
  1. /* 拦截器配置 */
  2. void addInterceptors (InterceptorRegistry var1);
  3. /* 视图跳转控制器 */
  4. void addViewControllers (ViewControllerRegistry registry);
  5. /**
  6. *静态资源处理
  7. **/
  8. void addResourceHandlers (ResourceHandlerRegistry registry);
  9. /* 默认静态资源处理器 */
  10. void configureDefaultServletHandling (DefaultServletHandlerConfigurer configurer);
  11. /**
  12. * 这里配置视图解析器
  13. **/
  14. void configureViewResolvers (ViewResolverRegistry registry);
  15. /* 配置内容裁决的一些选项*/
  16. void configureContentNegotiation (ContentNegotiationConfigurer configurer);
  17. /** 解决跨域问题 **/
  18. public void addCorsMappings (CorsRegistry registry) ;

2.1 addInterceptors:拦截器

  • addInterceptor:需要一个实现HandlerInterceptor接口的拦截器实例
  • addPathPatterns:用于设置拦截器的过滤路径规则;addPathPatterns("/**")对所有请求都拦截
  • excludePathPatterns:用于设置不需要拦截的过滤规则
  • 拦截器主要用途:进行用户登录状态的拦截,日志的拦截等。

   
   
  1. @Override
  2. public void addInterceptors (InterceptorRegistry registry) {
  3. super.addInterceptors(registry);
  4. registry.addInterceptor( new TestInterceptor()).addPathPatterns( "/**").excludePathPatterns( "/emp/toLogin", "/emp/login", "/js/**", "/css/**", "/images/**");
  5. }

2.2 addViewControllers:页面跳转

以前写SpringMVC的时候,如果需要访问一个页面,必须要写Controller类,然后再写一个方法跳转到页面,感觉好麻烦,其实重写WebMvcConfigurer中的addViewControllers方法即可达到效果了


   
   
  1. @Override
  2. public void addViewControllers (ViewControllerRegistry registry) {
  3. registry.addViewController( "/toLogin").setViewName( "login");
  4. }

值的指出的是,在这里重写addViewControllers方法,并不会覆盖WebMvcAutoConfiguration(Springboot自动配置)中的addViewControllers(在此方法中,Spring Boot将“/”映射至index.html),这也就意味着自己的配置和Spring Boot的自动配置同时有效,这也是我们推荐添加自己的MVC配置的方式。

 

2.3 addResourceHandlers:静态资源

比如,我们想自定义静态资源映射目录的话,只需重写addResourceHandlers方法即可。

注:如果继承WebMvcConfigurationSupport类实现配置时必须要重写该方法,具体见其它文章


   
   
  1. @Configuration
  2. public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer {
  3. /**
  4. * 配置静态访问资源
  5. * @param registry
  6. */
  7. @Override
  8. public void addResourceHandlers (ResourceHandlerRegistry registry) {
  9. registry.addResourceHandler( "/my/**").addResourceLocations( "classpath:/my/");
  10. }
  11. }
  • addResoureHandler:指的是对外暴露的访问路径
  • addResourceLocations:指的是内部文件放置的目录

2.4 configureDefaultServletHandling:默认静态资源处理器


   
   
  1. @Override
  2. public void configureDefaultServletHandling (DefaultServletHandlerConfigurer configurer) {
  3. configurer.enable();
  4. configurer.enable( "defaultServletName");
  5. }

此时会注册一个默认的Handler:DefaultServletHttpRequestHandler,这个Handler也是用来处理静态文件的,它会尝试映射/。当DispatcherServelt映射/时(/ 和/ 是有区别的),并且没有找到合适的Handler来处理请求时,就会交给DefaultServletHttpRequestHandler 来处理。注意:这里的静态资源是放置在web根目录下,而非WEB-INF 下。
  可能这里的描述有点不好懂(我自己也这么觉得),所以简单举个例子,例如:在webroot目录下有一个图片:1.png 我们知道Servelt规范中web根目录(webroot)下的文件可以直接访问的,但是由于DispatcherServlet配置了映射路径是:/ ,它几乎把所有的请求都拦截了,从而导致1.png 访问不到,这时注册一个DefaultServletHttpRequestHandler 就可以解决这个问题。其实可以理解为DispatcherServlet破坏了Servlet的一个特性(根目录下的文件可以直接访问),DefaultServletHttpRequestHandler是帮助回归这个特性的。

 

2.5 configureViewResolvers:视图解析器

这个方法是用来配置视图解析器的,该方法的参数ViewResolverRegistry 是一个注册器,用来注册你想自定义的视图解析器等。ViewResolverRegistry 常用的几个方法:https://blog.csdn.net/fmwind/article/details/81235401


   
   
  1. /**
  2. * 配置请求视图映射
  3. * @return
  4. */
  5. @Bean
  6. public InternalResourceViewResolver resourceViewResolver ()
  7. {
  8. InternalResourceViewResolver internalResourceViewResolver = new InternalResourceViewResolver();
  9. //请求视图文件的前缀地址
  10. internalResourceViewResolver.setPrefix( "/WEB-INF/jsp/");
  11. //请求视图文件的后缀
  12. internalResourceViewResolver.setSuffix( ".jsp");
  13. return internalResourceViewResolver;
  14. }
  15. /**
  16. * 视图配置
  17. * @param registry
  18. */
  19. @Override
  20. public void configureViewResolvers (ViewResolverRegistry registry) {
  21. super.configureViewResolvers(registry);
  22. registry.viewResolver(resourceViewResolver());
  23. /*registry.jsp("/WEB-INF/jsp/",".jsp");*/
  24. }

2.6 configureContentNegotiation:配置内容裁决的一些参数

2.7 addCorsMappings:跨域


   
   
  1. @Override
  2. public void addCorsMappings (CorsRegistry registry) {
  3. super.addCorsMappings(registry);
  4. registry.addMapping( "/cors/**")
  5. .allowedHeaders( "*")
  6. .allowedMethods( "POST", "GET")
  7. .allowedOrigins( "*");
  8. }

2.8 configureMessageConverters:信息转换器


   
   
  1. /**
  2. * 消息内容转换配置
  3. * 配置fastJson返回json转换
  4. * @param converters
  5. */
  6. @Override
  7. public void configureMessageConverters (List<HttpMessageConverter<?>> converters) {
  8. //调用父类的配置
  9. super.configureMessageConverters(converters);
  10. //创建fastJson消息转换器
  11. FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
  12. //创建配置类
  13. FastJsonConfig fastJsonConfig = new FastJsonConfig();
  14. //修改配置返回内容的过滤
  15. fastJsonConfig.setSerializerFeatures(
  16. SerializerFeature.DisableCircularReferenceDetect,
  17. SerializerFeature.WriteMapNullValue,
  18. SerializerFeature.WriteNullStringAsEmpty
  19. );
  20. fastConverter.setFastJsonConfig(fastJsonConfig);
  21. //将fastjson添加到视图消息转换器列表内
  22. converters.add(fastConverter);
  23. }

参考:https://blog.csdn.net/fmwind/article/details/81235401

参考:https://blog.csdn.net/weixin_43453386/article/details/83623242#1addInterceptors_32

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值