#21 Servlet Context Listener

# Servlet Context Listener

웹 컨테이너에서 웹 앱이 시작되거나 종료되는 시점에 특정 서블릿을 실행하고 싶은 경우 사용할 수 있다.

javax.servlet.ServletContextListener 인터페이스를 구현하면 되고, web.xml에 등록해서 사용한다.

 

---

# Servlet Context Listener

웹 어플리케이션이 시작되거나 종료될 때 호출할 메서드를 정의한 인터페이스.

참고로 <listener> 태그가 여러 개면 등록한 순서대로 넣은 스택구조로 실행, 종료된다. (먼저 시작 -> 나중 종료)

- public void contextInitialized(ServletContextEvent sce) : 웹어플리케이션을 초기화할 때 호출

- public void contextDestroyed(ServletContextEvent sce) : 웹 어플리케이션을 종료할 때 호출.

 

웹 어플리케이션이 시작되고, 종료될 때 특정한 기능을 수행하기 위해서는 아래와 같이 하면 된다.

 1. javax.servlet.ServletContextListener 인터페이스를 구현한 클래스를 작성한다.

 2. web.xml 파일에 1번에서 작성한 클래스를 등록한다.

참고로 속성값을 코드와 분리하기 위해 Java코드에 사용할 파라메타를 <context-param>으로 등록할 수 있다. 자바코드에서는 prop = getInitParameter("가져올 param 태그 이름")를 사용하면 된다.

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
	 http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
 version="3.1">
 
 	<listener>
 		<listener-class>jdbc.DoDBCPInitListener</listener-class>
 	</listener>
 	
 	<context-param>
 		<param-name>connectionPoolConfiguration</param-name>
 		<param-value>
 			jdbcdriver=com.mysql.jdbc.Driver
 			jdbcUrl=jdbc:mysql://localhost:3306/test?characterEncoding=utf8
 			dbUser=testuser
 			dbPass=test123
 		</param-value>
 	</context-param>
 </web-app>

public class DoDBCPInitListener implements ServletContextListener{
	
	@Override
	public void contextInitialized(ServletContextEvent sce) {
		String poolConfig = sce.getServletContext()
                                        .getInitParameter("connectionPoolConfiguration");
		
        // web.xml에서 받아온 정보를 prop 객체로 만든다.
        Properties prop = new Properties();
		try {
			prop.load(new StringReader(poolConfig));
		} catch (Exception e) {
			throw new RuntimeException(e);
		}
        
        // 이렇게 생성된 prop 객체를 통해 값들을 받아 올 수 있다.
        String jdbcUrl = prop.getProperty("jdbcUrl");
        String username = prop.getProperty("dbUser");
        String pw = prop.getProperty("dbPass");
	}
}

 

---

 

# Servlet Context Listener를 이용한 DBCP Init 코드

public class DoDBCPInitListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        String poolConfig = sce.getServletContext().getInitParameter("connectionPoolConfiguration");
        Properties prop = new Properties();
        try {
            prop.load(new StringReader(poolConfig));
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        loadJDBCDriver(prop);
        initConnectionPool(prop);
    }

    private void initConnectionPool(Properties prop) {
        try {
            String jdbcUrl = prop.getProperty("jdbcUrl");
            String username = prop.getProperty("dbUser");
            String pw = prop.getProperty("dbPass");

            ConnectionFactory connFactory = new DriverManagerConnectionFactory(jdbcUrl, username, pw);

            PoolableConnectionFactory poolableConnFactory = new PoolableConnectionFactory(connFactory, null);
            poolableConnFactory.setValidationQuery("select 1");

            GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
            poolConfig.setTimeBetweenEvictionRunsMillis(1000L * 60L * 5L);
            poolConfig.setTestWhileIdle(true);
            poolConfig.setMinIdle(4);
            poolConfig.setMaxTotal(50);

            GenericObjectPool<PoolableConnection> connectionPool = new GenericObjectPool<>(poolableConnFactory, poolConfig);

            poolableConnFactory.setPool(connectionPool);

            Class.forName("org.apache.commons.dbcp2.PoolingDriver");
            PoolingDriver driver = (PoolingDriver) DriverManager.getDriver("jdbc:apache:commons:dbcp:");
            String poolName = prop.getProperty("poolName");
            driver.registerPool(poolName, connectionPool);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }

    }

    private void loadJDBCDriver(Properties prop) {
        String driverClass = prop.getProperty("jdbcdriver");
        try {
            Class.forName(driverClass);
        } catch (ClassNotFoundException e) {
            throw new RuntimeException("fail to load JDBC Driver", e);
        }
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {

    }
}

 

---

# @WebListener 를 이용한 리스너 등록

서블릿 스펙3.0부터 제공하는 @어노테이션을 이용하면, web.xml를 수정하지 않고도 간단하게 매핑할 수 있다.

import javax.servlet.annotation.WebListener;

@WebListener
public class TestListener implements ServletContextListener {
	...//내용
}