ServletContextListener로 DB 커넥션, DAO 공유 객체 관리하기

ServletContextListener로 DB 커넥션, DAO 공유 객체 관리하기

필요할때마다 매번 인스턴스를 생성하면 많은 garbage가 발생하고 실행 시간이 길어질 수 있다. 여러 서블릿이 사용하는 객체는 어플리케이션이 시작할 때 준비해둬서 서로 공유하는 것이 메모리 관리나 실행 속도 측면에서 좋다.

 

🚨 실제 어플리케이션을 싱글 DB 커넥션으로 구현하면 안된다!

본 포스팅의 중심 내용은 ServletContextListener 인터페이스를 이용해 어플리케이션이 시작될 때 필요한 준비작업을 하는 방법이다.

 

Listener

톰캣같은 서블릿 컨테이너는 웹 어플리케이션의 상태를 모니터링할 수 있도록 어플리케이션의 시작부터 종료까지 주요한 이벤트에 대해 알림 기능을 제공한다. 이벤트에 따라 정해진 Listener 인터페이스를 구현해서 DD파일(web.xml)에 등록하면 특정 이벤트가 발생했을 때 원하는 작업을 수행하도록 할 수 있다.

 

분류	이벤트	Listener 인터페이스
웹 어플리케이션	시작, 종료	javax.servlet.ServletContextListener
	ServletContext에 값 추가, 제거, 대체	javax.servlet.ServletContextAttributeListener
세션	생성, 소멸	javax.servlet.http.HttpSessionListener
	활성, 비활성	javax.servlet.http.HttpSessionActivationListener
	HttpSession에 값 추가, 제거, 대체	javax.servlet.http.HttpSessionAttributeListener
요청	요청, 응답	javax.servlet.ServletRequestListener
	ServletRequest에 값 추가, 제거, 대체	javax.servlet.ServletRequestAttributeListener

표 - 웹 어플리케이션의 주요 이벤트와 Listener 인터페이스

 

ServletContextListener의 활용

이 중 웹 어플리케이션의 시작, 종료 시 발생하는 이벤트를 활용해서 객체를 준비한 뒤 ServletContext에 저장해서 공유 객체로 사용할 수 있다.

 

이전에 서블릿을 따로 만들어서 <load-on-startup> 태그 설정으로 DB 커넥션 객체를 공유하는 방법에 대해 다루었는데 그 보다 더 좋은 방법은 이렇게 서블릿 컨테이너가 발생시키는 이벤트를 이용하는것이다.

 

웹 어플리케이션이 시작되면 서블릿 컨테이너는 ServletContextListener의 구현체에 대해 contextInitialized()를 호출하고 어플리케이션이 종료되면 contextDestroyed()를 호출한다.

 

따라서 ServletContextListener를 활용해서 DB 커넥션과 DAO의 공유 객체로 만들려면 SerlvetContextListener의 구현체를 만들고 contextInitialized() 메소드에 객체를 생성, contextDestroyed()에 자원을 해제하도록 구현하면 된다.

 

1. ServletContextListener 구현

listeners 패키지에 ContextLoaderListener 클래스를 생성한다.

 

※ 스프링 프레임워크에서도 같은 역할의 같은 이름을 가진 클래스가 존재한다.

 

ContextLoaderListener.java

public class ContextLoaderListener implements ServletContextListener {
    Connection conn;
 
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        ServletContext sc = sce.getServletContext();
 
        try {
            // Connection 준비
            Class.forName(sc.getInitParameter("driver"));
            conn = DriverManager.getConnection(
                    sc.getInitParameter("url"),
                    sc.getInitParameter("username"),
                    sc.getInitParameter("password")
            );
 
            // Dao 준비
            StudentDao studentDao = new StudentDao();
            studentDao.setConnection(conn);
 
            // Dao 저장
            sc.setAttribute("studentDao", studentDao);
        } catch (ClassNotFoundException | SQLException e) {
            e.printStackTrace();
        }
    }
 
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        // Connection 해제
        try {
            conn.close();
        } catch (SQLException e) { }
    }
}

 

2. 리스너 배치

리스너 배치는 어노테이션을 지정하는 방법과 DD파일(web.xml)에 리스너 선언부를 작성하는 방법이 있다.

 

1) 어노테이션

클래스 선언 위에 @WebListener 어노테이션을 붙인다.

 

@WebListener
public class ContextLoaderListener implements ServletContextListener {
    Connection conn;
 
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        ServletContext sc = sce.getServletContext();

 

2) web.xml

web.xml의 <web-app> 태그 안에 작성한다.

참고로 Servlet 2.4 이하에서는 <filter-mapping> → <listener> → <serlvet> 순서로 작성해야한다.

Servlet 2.5부터는 순서에 상관 없다.

 

web.xml

<!-- 리스너 선언 -->
<listener>
    <listener-class>com.atoz_develop.spms.listeners.ContextLoaderListener</listener-class>
</listener>

 

3. 기존 서블릿 변경

DAO 객체를 직접 생성하는 대신 ServletContext에 저장된 DAO 객체를 꺼내 쓰도록 변경한다.

 

기존 코드

@WebServlet("/student/list")
public class StudentListServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        try {
            ServletContext sc = this.getServletContext();
            Connection conn = (Connection) sc.getAttribute("conn");
 
            StudentDao studentDao = new StudentDao();
            studentDao.setConnection(conn);
 
            req.setAttribute("students", studentDao.selectList());
 
            resp.setContentType("text/html; charset=UTF-8");
            RequestDispatcher rd = req.getRequestDispatcher(
                    "/student/StudentList.jsp"
            );
            rd.include(req, resp);
        } catch (SQLException e) {
            req.setAttribute("error", e);
            RequestDispatcher rd = req.getRequestDispatcher("/Error.jsp");
            rd.forward(req, resp);
        }
    }
}

 

변경 코드

@WebServlet("/student/list")
public class StudentListServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        try {
            ServletContext sc = this.getServletContext();
            req.setAttribute("students", ((StudentDao) sc.getAttribute("studentDao")).selectList());
 
            resp.setContentType("text/html; charset=UTF-8");
            RequestDispatcher rd = req.getRequestDispatcher(
                    "/student/StudentList.jsp"
            );
            rd.include(req, resp);
        } catch (SQLException e) {
            req.setAttribute("error", e);
            RequestDispatcher rd = req.getRequestDispatcher("/Error.jsp");
            rd.forward(req, resp);
        }
    }
}

 

제대로 구현 했다면 코드 변경 후에도 동일하게 정상 실행되는 것을 확인할 수 있다.

 

이렇게 ServletContext에 저장돼있는 객체를 재사용하면 객체를 생성할 필요가 없기 때문에 실행 속도가 빨라지고 garbage가 발생하지 않는다.