SpringBoot项目配置HandlerInterceptorAdapter继承WebMvcConfigurationSupport导致自动化配置失效的解决方案

  • 相关背景描述
    Spring boot 版本:2.1.4.RELEASE
    项目开发过程中需要简单校验一下session的有效性,相关用户权限信息。我决定使用Spring mvc 的 HandlerInterceptorAdapter 拦截器在Spring boot 1.X版本中我们只需配置WebMvcConfigurerAdapter即可,Spring boot 2.x 开始,使用Spring 组件的版本都是5.x,WebMvcConfigurerAdapter在Spring5中已经被遗弃,查询资料发现需要使用新的WebMvcConfigurationSupport。使用WebMvcConfigurationSupport新的问题就来了,Spring mvc的自动配置就失效了,静态资源无法正常访问。我在本项目中还想继续使用Spring mvc 的自动配置,找出了解决方案。


  • 自定义拦截器代码

        public class MyHandlerInterceptorAdapter extends HandlerInterceptorAdapter {
          Logger log= LoggerFactory.getLogger(MyHandlerInterceptorAdapter.class);
    
          @Override
          public boolean preHandle(HttpServletRequest request,
                                   HttpServletResponse response, Object handler) throws Exception {
    
              log.info("==============执行顺序: 1、preHandle================");
              String requestUri = request.getRequestURI();
              String contextPath = request.getContextPath();
              String url = requestUri.substring(contextPath.length());
    
              log.info("requestUri:"+requestUri);
              log.info("contextPath:"+contextPath);
              log.info("url:"+url);
              Set<String> initUrl = FilterUrl.initUrl();
              if (initUrl.contains(url)) {
                  SysUser user =  (SysUser)request.getSession().getAttribute("USER_INFO");
                  if(user == null){
                      log.info("Interceptor:跳转到login页面!");
                      // /WEB-INF
                      // request.getRequestDispatcher("/sinylon.html").forward(request, response);
                      ObjectMapper mapper = new ObjectMapper();
                      Res res = new Res<>();
                      res.setRespCode(3);
                      res.setRespMsg("未登录/会话过期,请登录");
                      response.setContentType("text/json;charset=utf-8");
                      response.getWriter().print(mapper.writeValueAsString(res));
                      return false;
                  }else {
                      return true;
                  }
              }
    
              return true;
    
          }
      }
    

  • 使用WebMvcConfigurationSupport整合自定义拦截器代码
       @Configuration
       public class WebSecurityConfig extends WebMvcConfigurationSupport {
       @Bean
       public MyHandlerInterceptorAdapter getSecurityInterceptor() {
           return new MyHandlerInterceptorAdapter();
       }

       @Override
       public void addInterceptors(InterceptorRegistry registry) {

           registry.addInterceptor(getSecurityInterceptor()).addPathPatterns("/*");

           super.addInterceptors(registry);
           // 排除配置
           //addInterceptor.excludePathPatterns("/error");
           //addInterceptor.excludePathPatterns("/login**");

           // 拦截配置
          // addInterceptor.addPathPatterns("/**");
       }
   }

  • 启动程序,发现找不到静态资源,请求404

    image.png

打开浏览器,请求程序


image.png

控制台打印


image.png

由此发现静态资源无法正常访问,解决方案代码

   @Configuration
   public class WebSecurityConfig implements WebMvcConfigurer {

       @Bean
       public MyHandlerInterceptorAdapter getSecurityInterceptor() {
           return new MyHandlerInterceptorAdapter();
       }

       @Override
       public void addInterceptors(InterceptorRegistry registry) {
           registry.addInterceptor(getSecurityInterceptor());
       }
   }

将继承WebMvcConfigurationSupport改为实现WebMvcConfigurer重写添加拦截器的方法,重新启动程序


image.png

控制台日志与之前对比,现在打印出了静态资源位置,页面访问:


image.png

访问正常,控制台日志,静态资源正常访问


image.png

源码解析:


image.png

Spring boot 的 web 自动配置类WebMvcAutoConfiguration上有条件注解

 @ConditionalOnMissingBean({WebMvcConfigurationSupport.class})

这个注解的意思是在项目类路径中 缺少 WebMvcConfigurationSupport类型的bean时改自动配置类才会生效,所以继承 WebMvcConfigurationSupport 后需要自己再重写相应的方法。

spring 5.0后要使用Java8,而在Java8中接口是可以有default方法的,我们只需要在自定义配置类中直接实现 WebMvcConfigurer接口即可。

总结:

implements WebMvcConfigurer : 不会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
@EnableWebMvc + implements WebMvcConfigurer : 会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
extends WebMvcConfigurationSupport :会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置
extends DelegatingWebMvcConfiguration :会覆盖@EnableAutoConfiguration关于WebMvcAutoConfiguration的配置

参考连接:
相关博客,Spring boot梳理
相关博客,自动配置类分析

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351

推荐阅读更多精彩内容