@EnableWebMvc 는 조심해서 사용하자

💡 이번 포스팅에서는 스프링 부트에서 resourceHandler에 대해 겪었던 이슈에 대해서 정리해 보도록 하겠습니다. 

 

상황은 이렇습니다.

 

스프링 부트 + 타임리프로 개발을 잘 하고 있다가, 톰캣 AJP 설정을 해야 해서 @Configuration과 @EnableWebMvc를 사용하여 설정을 한 후에 갑자기 정적 Web Resource들이 모두 404 Not Found 에러가 발생하기 시작했습니다.

 

아래는 문제의 코드입니다.

 

@Configuration
@EnableWebMvc
@RequiredArgsConstructor
public class SpringServletConfig implements WebMvcConfigurer {

    private final TomcatAjpProperties tomcatAjpProperties;

    @Bean
    public ServletWebServerFactory servletContainer() throws UnknownHostException {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory() {
        };

        if (tomcatAjpProperties.enabled()) {
            Connector ajpConnector = new Connector(tomcatAjpProperties.protocol());
            ajpConnector.setPort(tomcatAjpProperties.port());
            ajpConnector.setSecure(tomcatAjpProperties.secure());
            ajpConnector.setAllowTrace(tomcatAjpProperties.allowTrace());
            ajpConnector.setScheme(tomcatAjpProperties.scheme());
            ((AbstractAjpProtocol<?>) ajpConnector.getProtocolHandler()).setSecretRequired(false);
            ((AbstractAjpProtocol<?>) ajpConnector.getProtocolHandler()).setAddress(InetAddress.getByName("0.0.0.0"));
            tomcat.addAdditionalTomcatConnectors(ajpConnector);
        }

        return tomcat;
    }

}

 

이제까지 학습했던 내용으로는 정적 리소스에 대한 설정은 스프링 부트가 기본으로 설정해 주며, WebProperties에 정적 리소스에 대한 경로가 설정되어 있다고 알고 있었습니다.

 

 

하지만 이번 이슈에 대한 범인이자 오늘 정리할 내용인 @EnableWebMvc 가 사용되면 제가 알고 있던 내용이 틀려지게 됩니다.

 

먼저 MVC 설정은 아래와 같이 2가지 방식으로 설정할 수 있습니다. 

1. @Configuration + WebMvcConfigurer 
2. @Configuration + @EnableWebMvc + WebMvcConfigurer 

 

이번 이슈에 대해 이해하려면 위 2가지 방식의 차이를 알아야 하며, 이제 2가지 방식의 차이를 정리해 보겠습니다.

스프링 공식 문서에 가보면 아래와 같이 설명하고 있습니다.

 

스프링 부트에서 제공하는 사용자 지정 설정을 유지하면서 인터셉터, 포매터, 뷰 컨트롤러 등을 만들고 싶다면 @EnableWebMvc 애노테이션 없이 @Configuration + WebMvcConfigurer를 사용해야 한다고 합니다.

 

반대로 스프링 부트에서 제공하는 사용자 지정 없이 모든 설정을 제어하려면 @EnableWebMvc 애노테이션을 사용하면 된다고 합니다.

 

이와 관련해서 백기선 님의 인프런 Q&A에서도 동일하게 설명하고 있습니다.

 

출처: https://www.inflearn.com/questions/33417/enablewebmvc-%EC%97%86%EC%9D%B4%EB%A1%9C-%EC%97%85%EB%8D%B0%EC%9D%B4%ED%8A%B8

 

 

실제 코드를 보면 @EnableWebMvc 애노테이션을 사용하면 WebMvcAutoConfiguration이 등록되지 않는 것을 확인할 수 있습니다.

 

@EnableWebMvc 적용

 

@EnableWebMvc 적용 X

@EnableWebMvc 애노테이션을 사용하지 않으면 WebMvcAutoConfiguration이 동작하여 기본 정적 리소스에 대한 resourceHandler가 동작하게 됩니다.

 

 

그래서 제가 처음에 알고 있던 내용은 @EnableWebMvc 애노테이션이 적용되지 않은 스프링 부트가 자동으로 설정해 주었을 때 올바른 내용이 되고, @EnableWebMvc가 사용되면 스프링 부트 자동 설정이 적용되지 않기 때문에 틀린 내용이 됐던 것입니다.

 

오늘 포스팅 이슈는 resourceHandler 부분이었지만 이 외에도 View Resolver 등 스프링 부트 자동 설정에 의해 등록되는 Bean들이 있으니 이 부분은 WebMvcConfigurer이 어떤 Bean들을 자동으로 등록하는지 확인해보면 좋을 것 같습니다.

 

 

정리하면

스프링 부트 자동 설정을 유지하면서 추가로 설정하고 싶은 경우에는 @Configuration + WebMvcConfigurer

스프링 부트 자동 설정 대신 직접 모든 것을 설정하고 싶은 경우에는 @Configuration + @EnableWebMvc + WebMvcConfigurer

를 사용하면 됩니다.

 

 

참고 자료

• https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.servlet.spring-mvc.auto-configuration
• https://www.inflearn.com/questions/33417/enablewebmvc-%EC%97%86%EC%9D%B4%EB%A1%9C-%EC%97%85%EB%8D%B0%EC%9D%B4%ED%8A%B8
• https://gocandoit.tistory.com/m/30
• https://w97ww.tistory.com/82
• https://mangkyu.tistory.com/176