스프링 MVC 서블릿 컨테이너 초기화 WebApplicationInitalizer

서블릿 컨테이너 초기화, 애플리케이션 초기화 (tistory.com)

서블릿 컨테이너 초기화, 애플리케이션 초기화

스프링 컨테이너 등록 (tistory.com)

스프링 컨테이너 등록

저번 글에서 보면 서블릿 컨테이너를 초기화하려면 먼저 ServletContainerInitializer 인터페이스를 구현하고 서블릿 컨테이너 초기화 코드를 만들고, 애플리케이션 초기화를 위해서 @HandleTypes 어노테이션을 적용하고, 그 다음 /META-INF/services/jakarta.servlet.ServletContainerInitializer 파일에 서블릿 컨테이너 초기화 클래스 경로를 등록해줬다. 

 

이 과정을 계속 한다는 것은 번거롭고 귀찮은 작업이다.. 

근데 스프링 MVC는 서블릿 컨테이너를 초기화 하는 작업을 이미 만들어서 제공하고 있다!! 

따라서 개발자들은 이 서블릿 컨테이너 초기화 과정은 하지 않아도 되고, 애플리케이션 초기화 코드만 작성해주면 된다 ㅎㅎ 

 

 

WebApplicationInitializer 

public interface WebApplicationInitializer {

   /**
    * Configure the given {@link ServletContext} with any servlets, filters, listeners
    * context-params and attributes necessary for initializing this web application. See
    * examples {@linkplain WebApplicationInitializer above}.
    * @param servletContext the {@code ServletContext} to initialize
    * @throws ServletException if any call against the given {@code ServletContext}
    * throws a {@code ServletException}
    */
   void onStartup(ServletContext servletContext) throws ServletException;

}

WebApplicationInitializer는 스프링이 지원하는 애플리케이션 초기화 코드로 이 인터페이스를 구현해 애플리케이션 초기화 코드를 작성해주면 된다. 

 

 

AppInitV3SpringMvc

public class AppInitV3SpringMvc implements WebApplicationInitializer
{
   
   @Override
   public void onStartup(ServletContext servletContext) throws ServletException
   {
      System.out.println("AppInitV3SpringMvc.onStartup");
      
      // 스프링 컨테이너 생성
      AnnotationConfigWebApplicationContext appContext = new AnnotationConfigWebApplicationContext();
      appContext.register(HelloConfig.class);
      
      // 스프링 MVC 디스패처 서블릿 생성, 스프링 컨테이너 연결
      DispatcherServlet dispatcher = new DispatcherServlet(appContext);
      
      // 디스패처 서블릿을 서블릿 컨테이너에 등록 (이름 주의!)
      ServletRegistration.Dynamic servlet = servletContext.addServlet("dispatcherV3", dispatcher);
      
      // 모든 요청이 디스패처 서블릿을 통하도록 설정
      servlet.addMapping("/");
   }
}

저번 글에서 애플리케이션 초기화 코드로 사용했던 걸 그대로 가져왔다. 

대신 여기서는 AppInit 인터페이스를 구현하는 것이 아닌 스프링이 제공하는 애플리케이션 초기화 인터페이스  WebApplicationInitializer를 구현한다. 

그리고 서블릿 컨테이너에 디스패처 서블릿을 등록할 때 이름을 이번엔 V3 으로 해주고, addMapping에서도 "/" 으로 지정해서 모든 요청이 해당 서블릿을 통하도록 했다. 

 

http://localhost:9080/hello-spring 으로 실행하면 이번엔 /hello-spring이 매핑된 컨트롤러 메서드가 호출된다.

 

❗ 지금 보면 디스패처 서블릿도 여러개고 스프링 컨테이너도 여러개인데.. .

보통은 스프링 컨테이너를 하나 만들고, 디스패처 서블릿도 하나만 만들고, 디스패처 서블릿의 경로 매핑도 /로 해서 하나의 디스패처 서블릿을 통해서 모든 것을 처리하도록 한다!! 

 

 

❓ 근데 어떻게 WebApplicationIntializer 만 구현하면 애플리케이션 초기화가 가능한가? 에 대해서는 스프링 라이브러리에 코드를 보면 된다. 

spring-web 라이브러리를 열어보면 서블릿 컨테이너 초기화를 위한 등록 파일을 확인할 수 있다!! 익숙한 그 경로의 파일이다. 

들어가보면 SpringServletContainerInitializer 서블릿 컨테이너 초기화 클래스가 등록되어 있는데 이 코드를 확인해보면 

@HandleTypes으로 WebApplicationInitailizer가 등록된 것을 확인할 수 있다. 

스프링이 이렇게 인터페이스를 제공해주면 우리는 이제 이 인터페이스를 구현해주기만 하면 된다!! 

 

 

 

스프링이라고 그냥 마법처럼 짠!하고 기능이 제공되는 것이 아니라 미리 우리가 저번 글에서 직접 만들었던 코드를 제공해주는 것이고, 

우리는 편하게 그걸 사용만 하면 되는 것이다. 

스프링 MVC가 서블릿 컨테이너 초기화 파일에 초기화 클래스를 등록해두고, WebApplicationInitializer 인터페이스를 애플리케이션 초기화 인터페이스로 지정해두고 이것을 생성해서 실행한다.