[Spring Boot] Actuator 와 Swagger 3.0.0 충돌

이상협·2023년 6월 22일
0

🎈발생했던 문제

최근 진행하고 있는 프로젝트에서 적정 thread pool 수준을 찾으려고 모니터링 오픈소스 프로그램을 붙이려고 했다.
그 과정에서 Actuator와 Prometheus를 build.gradle에 모듈 추가를 하자 에러가 발생하는 것이다.
확인해보니 Swagger(Springfox)3.0.0버전과의 충돌로 인한 문제였다.

  • Actuator와 Swagger의 역할 충돌
  • Spring MVC 2.6.x 버전 이상부터는 기본값을 Ant-based path matcher -> PathPattern-based matcher로 변경하여 SpringMVC가 Ant-based path matcher를 사용한다고 가정하는 Springfox에서 이를 인식하지 못해 발생하는 버그

🎈해결 방법

빈을 하나 등록하면 끝나는 문제이다.

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;

import java.lang.reflect.Field;
import java.util.List;
import java.util.stream.Collectors;

@Configuration
public class Config {

    @Bean
    public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
        return new BeanPostProcessor() {
            @Override
            public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
                if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
                    customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
                }
                return bean;
            }

            private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
                List<T> copy = mappings.stream()
                        .filter(mapping -> mapping.getPatternParser() == null)
                        .collect(Collectors.toList());
                mappings.clear();
                mappings.addAll(copy);
            }

            @SuppressWarnings("unchecked")
            private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
                try {
                    Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
                    field.setAccessible(true);
                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
                } catch (IllegalArgumentException | IllegalAccessException e) {
                    throw new IllegalStateException(e);
                }
            }
        };
    }
}

🎈참고

0개의 댓글