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

 

서블릿 컨테이너 초기화란? (tistory.com)

서블릿 컨테이너 초기화란?

WAS 를 실행하는 시점에 필요한 초기화 작업들이 있는데 예전에는 이를 web.xml을 이용해서 초기화했지만, 지금은 서블릿 스펙에서 자바 코드를 사용한 초기화도 지원하고 있다. 

 

 

ServletContainerInitializer

: 서블릿은 ServletContainerInitializer 인터페이스를 제공해서 서블릿 컨테이너 초기화 기능을 제공하고, onStartup() 실행 시점에 이 메서드를 호출해서 필요한 기능들을 초기화 하거나 등록할 수 있다. 

 

 

저번 글에서는 서블릿을 @WebServlet 어노테이션을 사용해서 등록했었는데 이번에는 서블릿 컨테이너 초기화 시점에 프로그래밍 방식으로 직접 등록해준다. 

 

HelloServlet

public class HelloServlet extends HttpServlet
{
   @Override
   protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException
   {
      System.out.println("HelloServlet.service");
      resp.getWriter().println("hello servlet!!");
   }
}

HelloServlet을 만들고 이 서블릿을 등록하고, 실행하면 로그로는 "HelloServlet.service"가 출력되고 http 응답으로 "hello servlet!!"이 출력된다. 

 

 

<애플리케이션 초기화>

서블릿 컨테이너는 좀 더 유연한 초기화 기능을 지원하는데 이를 애플리케이션 초기화라고 한다. 

 

AppInit 

public interface AppInit
{
   void onStartup(ServletContext servletContext);
}

-> 애플리케이션 초기화를 진행하기 위해서는 내용과 형식은 상관없이 인터페이스를 먼저 만들어야 한다. 

 

 

AppInitV1Servlet

public class AppInitV1Servlet implements AppInit
{
   @Override
   public void onStartup(ServletContext servletContext)
   {
      System.out.println("AppInitV1Servlet.onStartup");
      
      // 순수 서블릿 코드 등록
      ServletRegistration.Dynamic helloServlet = servletContext.addServlet("helloServlet", new HelloServlet());
      helloServlet.addMapping("/hello-servlet");
   }
}

-> 그리고 AppInit 인터페이스를 구현해 실제 동작하는 코드이다. 

여기서 이제 프로그래밍 방식으로 위에서 만들었던 HelloServlet 을 서블릿 컨테이너에 등록한다. 

/hello-servlet을  호출하면 HelloServlet이 실행되도록 등록했다. 

 

 

❗ 서블릿을 등록하는 2가지 방법 중 프로그래밍 방식을 사용하는 이유는 ? 

서블릿을 등록하는 방법에는 위에서도 말했듯이 @WebServlet을 사용하는 방식과 프로그래밍 방식이 있다. 

 

먼저 @WebServlet을 사용하면 애노테이션 하나로 서블릿을 편리하게 등록할 수 있지만.. 유연하게 변경은 어렵다는 단점이 있다. 

예를 들어 /hello-servlet을 경로를 /test 경로로 변경하려면 코드를 직접 변경해야 바꿀 수 있다. 

 

근데 프로그래밍 방식은 애노테이션에 비하면 코딩을 더 많이 해야하고 불편하지만 유연하게 변경이 가능하다. 

예를 들면 /hello-servlet 경로를 상황에 따라 바꿔서 외부 설정을 읽어서 등록할 수 도 있고, 서블릿 자체도 조건에 따라 if 문으로 등록하거나 뺄 수도 있다. 

 

 

 

<애플리케이션 초기화 과정>

 

MyContainerInitV2

@HandlesTypes(AppInit.class)
public class MyContainerInitV2 implements ServletContainerInitializer
{
   
   @Override
   public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException
   {
      System.out.println("MyContainerInitV2.onStartup");
      System.out.println("MyContainerInitV2 c =" + c);
      System.out.println("MyContainerInitV2 ctx = " + ctx);
      
      // class hello.container.AppInitV1Servlet
      for (Class<?> appInitClass : c)
      {
         try
         {
            // new AppInitV1Servlet() 과 같은 코드
            AppInit appInit = (AppInit) appInitClass.getDeclaredConstructor().newInstance();
            appInit.onStartup(ctx);
         }
         catch (Exception e)
         {
            throw new RuntimeException(e);
         }
         
      }
      
   }
}

1️⃣ @HandleTypes 애노테이션에 애플리케이션 초기화 인터페이스를 지정한다. 

 

2️⃣ 서블릿 컨테이너 초기화 ServletContainerInitializer 는 파라미터로 넘어온 Set<Class<?>> c 에 애플리케이션 초기화 인터페이스 구현체들을 모두 찾아서 클래스 정보로 전달한다. 

-> @HandleTypes로 AppInit 인터페이스를 전달했으므로 이를 구현한 AppInitV1Servlet 정보가 전달된다.

(참고로 객체의 인스턴스가 아니라 클래스 정보를 전달하기 때문에 실행하기 위해서는 객체를 생성해서 사용해야 한다.)

 

3️⃣ appInitClass.getDeclaredConstructor().newInstance() 

-> 리플렉션을 사용해서 객체를 생성한다. ( 이 코드는 new AppInitV1Servlet() 과 같다고 생각해도 된다. )

 

4️⃣ appInit.onStartup(ctx); 

애플리케이션 초기화 코드를 직접 실행해서 서블릿 컨테이너 정보가 담긴 ctx도 함께 전달한다. 

 

 

 

<MyContainerInitV2 등록>

마지막으로 MyContainerInitV2를 실행하려면 서블릿 컨테이너에 알려줘야 하기 때문에 

resources/META-INF/services/jakarta.servlet.ServletContainerInitializer 

에 등록해준다. 

hello.container.MyContainerInitV2

 

<Tomcat 실행>

그리고 WAS를 실행해보면 

저번 글에서 등록했던 MyContainerInitV1과 이번에 등록한 MyContainerInitV2가 실행되어 서블릿 컨테이너가 초기화 된 것을 확인할 수 있다. 

 

http://localhost:9080/hello-servlet

HelloServlet이 등록되어 /hello-servlet으로 요청하면 로그로 해당 내용이 찍히고, 응답도 온 것을 확인할 수 있다. 

 

 

<초기화 순서>

1️⃣ 먼저 서블릿 컨테이너 초기화 실행 후, 2️⃣ 애플리케이션 초기화를 실행한다. 

 

 

 

❗ 애플리케이션 초기화를 하는 이유? 

강의를 들으면서도  서블릿 컨테이너 초기화만 있으면 되는 것 같은데  굳이 왜 애플리케이션 초기화가 필요한지에 대해서 좀 궁금한 참이었는데 딱 궁금한 내용에 대해서 언급해주셔서 작성해둔다. 

 

- 편리함 

생각해보면 서블릿 컨테이너를 초기화하려면 ServletContainerInitializer 인터페이스를 구현한 코드를 만들어서, resources/META-INF/services/jakarta.servlet.ServletContainerInitializer  여기에 해당 코드를 직접 지정해줘야 하는데, 

애플리케이션 초기화는 그냥 특정 인터페이스를 만들고 그냥 구현하면 된다. 

 

- 의존성 

애플리케이션 초기화는 서블릿 컨테이너에 상관없이 원하는 모양으로 인터페이스를 만들 수 있어서 애플리케이션 초기화 코드가 서블릿 컨테이너에 대한 의존을 줄일 수 있다.