Swagger2+SpringBoot2拦截器不注册的问题

最新推荐文章于 2024-07-14 07:04:52 发布

原创最新推荐文章于 2024-07-14 07:04:52 发布 · 1.7k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#踩坑

SpringBoot2 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了SpringBoot2中Swagger2的拦截器未注册的问题及解决办法。由于SpringBoot2废弃了WebMvcConfigurerAdapter，需实现WebMvcConfigurationSupport。问题表现为在SwaggerConfig中配置的拦截器无效，无注册日志。解决方案是将addResourceHandlers和addInterceptors合并到同一个继承自WebMvcConfigurationSupport的类中。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

原文地址

注意：SpringBoot2废弃了WebMvcConfigurerAdapter ，请实现WebMvcConfigurationSupport，或者继承WebMvcConfigurer

原因

多个配置类继承WebMvcConfigurationSupport

现象

在SwaggerConfig中，配置SwaggerUI的路径，如下：
1.该类继承自：WebMvcConfigurationSupport 重写addResourceHandlers

@EnableSwagger2
@Configuration
public class SwaggerConfig extends WebMvcConfigurationSupport {
  public static final String DEFAULT_INCLUDE_PATTERN = "/api/.*";

  private static Logger log = LoggerFactory.getLogger(SwaggerConfig.class);
  @Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
     registry.addResourceHandler("swagger-ui.html")
            .addResourceLocations("classpath:/META-INF/resources/");

    registry.addResourceHandler("/webjars/**")
            .addResourceLocations("classpath:/META-INF/resources/webjars/");
  }

2.InterceptorConfig同样继承自WebMvcConfigurationSupport

@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {

  private Logger logger = LoggerFactory.getLogger(InterceptorConfig.class);


  @Override
  public void addInterceptors(InterceptorRegistry registry) {
	logger.info("拦截器注册");
	registry.addInterceptor(new ContextInitInterceptor());
	super.addInterceptors(registry);
  }
}

运行时，拦截器注册的日志，没有打印，拦截器没有任何效果。

解决办法

将addResourceHandlers和addInterceptors两个都继承自WebMvcConfigurationSupport合并到一个类中

建议将Swagger中的addResourceHandlers 合并到InterceptorConfig ，按照正常理解来说，这个属于静态资源配置。

改造后：

@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {

  private Logger logger = LoggerFactory.getLogger(InterceptorConfig.class);


  @Override
  public void addInterceptors(InterceptorRegistry registry) {
	logger.info("拦截器注册");
	registry.addInterceptor(new ContextInitInterceptor()).addPathPatterns("/api/**");
	super.addInterceptors(registry);
  }
  @Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
	registry.addResourceHandler("swagger-ui.html")
			.addResourceLocations("classpath:/META-INF/resources/");

	registry.addResourceHandler("/webjars/**")
			.addResourceLocations("classpath:/META-INF/resources/webjars/");
  }
}