[서블릿/JSP] 리스너

리스너?

단어의 뜻으로 보자면 듣는사람, 즉 청취자이다. 프로그래밍에서 리스너란 웹 애플리케이션의 특정 이벤트를 감지하고(== 모니터링, 감시) 처리하는 데 사용되는 컴포넌트(메서드 or 함수)이다. 주로 애플리케이션의 상태 변화에 따라 필요한 작업을 수행하거나 애플리케이션의 수명 주기와 관련된 이벤트를 처리하는 데 유용하다. 

서블릿을 상속받은 클래스인데, 서블릿을 상속받은 클래스는 filter, listener 이렇게 두 가지가 있다.

 

---

리스너의 종류

이벤트 소스	이벤트 리스너	발생 이벤트 객체	설명
ServletContext	ServletContextListener	ServletContextEvent	웹어플리케이션의 시작, 종료 이벤트에 대한 이벤트 리스너다. 핸들러 메서드에서는 ServletContext에 대한 참조를 얻을 수 있다.
	ServletContextAttributeListener	ServletContextAttributeEvent	ServletContext에 attribute를 추가하거나 제거, 수정됐을 때에 대한 이벤트 리스너다. 핸들러 메서드에서는 추가하거나 제거, 수정된 attribute 정보를 얻을 수 있다.
HttpSession	HttpSessionListener	HttpSessionEvent	HTTP 세션의 시작, 종료 이벤트에 대한 이벤트 리스너다. 핸들러 메서드에서는 현재 세션 객체를 얻을 수 있다.
	HttpSessionAttributeListener	HttpSessionBindingEvent	HttpSession에 attribute를 추가하거나 제거, 수정됐을 때에 대한 이벤트 리스너다. 핸들러 메서드에서는 추가하거나 제거, 수정된 attribute 정보를 얻을 수 있다.
ServletRequest	ServletRequestListener	ServletRequestEvent	클라이언트로부터의 요청으로 인한 ServletRequest 생성과 응답 이후 ServletRequest 제거시에 대한 이벤트 리스너다. 핸들러 메서드에서는 요청에 관련된 정보와 ServletContext에 대한 참조를 얻을 수 있다.
	ServletRequestAttributeListener	ServletRequestAttributeEvent	ServletRequest에 attribute를 추가하거나 제거, 수정됐을 때에 대한 이벤트 리스너입니다. 핸들러 메서드에서는 추가하거나 제거, 수정된 attribute 정보를 얻을 수 있다.

이 외에도 HttpSessionActivationListener,  HttpSessionBindingListener, AsyncListener 등이 있다.

출처: https://dololak.tistory.com/616 [코끼리를 냉장고에 넣는 방법:티스토리]

---

 

그 중에 나는 ServletContextEvent에 대해 좀 더 깊게 알아보려고 한다.

 

서블릿 컨텍스트 리스너 (ServletContextListener)

목적: 서블릿 컨텍스트의 생명주기를 관리, 웹 애플리케이션이 시작될 때 생성되고 종료될 때 소멸됨

주요 메서드:

• contextInitialized(ServletContextEvent sce): 서블릿 컨텍스트가 생성될 때 호출됨, 초기화 작업을 수행함
• contextDestroyed(ServletContextEvent sce): 서블릿 컨텍스트가 소멸될 때 호출됨, 자원 해제 작업을 수행함

---

이클립스에서 리스너 파일을 만들어보자.

서블릿을 상속받은 클래스다보니 서블릿과 함께 묶여있는 것을 볼 수 있다.

클래스 이름을 설정한 후, 아래와 같이 설정하면 된다.

 

package controller.common;

import java.util.ArrayList;

import jakarta.servlet.ServletContextEvent;
import jakarta.servlet.ServletContextListener;
import jakarta.servlet.annotation.WebListener;
import model.common.Crawling;
import model.dao.BoardDAO;
import model.dto.BoardDTO;

@WebListener
public class SampleListener implements ServletContextListener {
   
    public SampleListener() {
    }

    public void contextInitialized(ServletContextEvent sce)  { 
    	// 웹 서버 구동(실행)시 한번 수행될 코드 부분
    	System.out.println("로그 : 리스너에서 웹 서버 구동(실행) 을 감지함");
    	
    	// 샘플 데이터 DB에 저장하는 코드
    	ArrayList<BoardDTO> datas = Crawling.makeSample();
    	BoardDAO boardDAO = new BoardDAO();
    	/*
    	for(BoardDTO data : datas) {
    		boardDAO.insert(data);
    	}
    	*/
    }
    

    public void contextDestroyed(ServletContextEvent sce)  { 
    	// 웹 서버 종료시 한번 수행될 코드 부분
    	
    	// EX) DB 연결 해제
    }
	
}

 

 

위와 같이 로그를 찍어보고, 코드를 실행하면, 

(콘솔창에)로그가 찍히는 것을  볼 수 있다.

 

여기서 추가로 어노테이션 사용하는것과 xml 작성하는것은 동일한데, 

서블릿 new는 xml 설정이 들어갈 수 밖에 없는데 에러방지만 하고  요즘에는 @WebListener  어노테이션으로 직접 설정하는게 훨씬 더 보편적이기 때문에, 어노테이션을사용하였다.