📗 웹서비스 프로그래밍 11장 리스너와 필터

CHAP.11 리스너와 필터

1. 리스너

리스너란?

• 리스너(Listener)
  • 컨테이너에서 발생하는 이벤트를 모니터링하다가 특정 이벤트가 발생하면 실행되는 특수한 서블릿, EventListner라고도 함
  • 웹 어플리케이션 실행에 필요한 정보를 제공하거나 톰캣 시작/종료와 같은 특정 상황에 자동으로 동작하는 프로그램을 구현할 때 사용
  • 리스너는 일반적인 형태의 서블릿이 아니라 특정 이벤트에 따라 동작하는 인터페이스를 구현한 클래스
  • 리스너가 동작하기 위한 이벤트의 종류와 그에 따른 프로그램 API를 알아야 함
• 리스너의 동작구조
  • 기본적으로 생명 주기 변화와 Scope Object에서 관리하는 속성의 변화를 모니터링 하고 해당 이멘트가 발생하면 실행되는 구조

  Servlet과 JSP에서는 Page, Request, Sesscion, Application의 4가지 스코프가 있다.

  • ex) ServletContext: 웹 어플리케이션 단위로 생성되는 객체로, 보통 톰캣의 시작과 종료와 일치하기 때문에 해당 시점에 실행을 원하는 프로그램이 있다면 리스너로 구현 가능
• 리스너의 대표적인 유형
  • 초기화 매개변수와의 연동
    • 톰캣이 시작될 때 ‘web.xml’의 ServletContext 초기화 매개변수를 읽어 그에 따라 특정 객체를 초기화 한 후 서블릿이나 JSP에 제공
  • 예제 프로그램 등을 배포 할 때 샘플 데이터 제공
    • DB가 필요한 경우 미리 DB와 연결을 만들어 두거나, 테이블을 생성하고 샘플 데이터를 로딩하는 등의 작업을 자동으로 수행하여 추가적인 작업 없이 프로그램 실행
  • 복잡한 환경 설정 제공
    • 프로그램 실행에 필요한 여러 정보(DB, 다른 서비스 연동 정보, 관리자 계정 정보 등 프로그램 외부에서 변하는 정보를 주입하는 형태)가 고정되어 있지 않고, 운영하는 서버 상황에 따라 변경되어야 하는 경우, 이를 파일로 읽어와 JSP 및 서블릿 등에 제공
  • 특정 이벤트에 동작하는 기능 구현
    • 웹 어플리케이션을 실행할 때 함께 동작해야 하는 외부 프로그램이나 서비스의 동작 유무를 확인하고 자동으로 실행

• 리스너의 종류

  유형	설명	리스터 인터페이스
  ServletContext 생명주기 변화	대표적인 리스너 이벤트로, ServletContext의 생성과 소멸 시점에 동작 보통 톰캣의 시작 및 종료 시점과 일치한다	javax.servelt.Servelt.ContextListener
  ServletContext 속성 변화	ServletContext의 속성이 추가되거나 변경되는 상황에 동작한다	javax.servlet.ServletContextAttributeListner
  Session 생명주기 변화	Session의 생성과 소멸 등 변화에 따라 동작한다	javax.servlet.http.HttpSessionListener
  Session 속성 변화	Session의 속성이 추가되거나 변경되는 상황에 동작한다	javax.servlet.http.HttpSessionAttributeListener

리스너 규현

• 리스너 구현 방법
  • 어노테이션을 이용해 리스너임을 명시한 후, 오버라이딩 된 메서드 중에서 필요한 부분의 코드 작성

  // 리스너 클래스임을 컨테이너에 전달
  @WebListener 
  public class ListenerExam implements ServletContectListener{
    // ServletContext 시작
    public void contextIniitialized(servletContextEvent sce){
      sce.getServletContext().log("ServletContext 시작됨!!");
    }
    ...
  }
  

2. 필터

필터란?

• 필터(Filter)
  • 서블릿 필터(Servlet Filter)라고도 하며, 리스너와 마찬가지로 웹 어플리케이션을 지원하기 위한 특수한 형태의 서블릿
  • 클라이언트 요청에 따라 서블릿이나 JSP가 실행되기 전에 response 혹은 request 객체의 조작이나 추가적인 처리
  • 필터는 기본적으로 특정 요청에만 동작하며, 여러개의 필터가 정해진 순서에 따라 배치될 수 있는데 클라이언트 요청 처리 이전에 먼저 실행됨
• 필터의 대표적 활용 분야
  • 인증(Authentication)
    • 어플리케이션 구조와 상관없이 기존 소스를 최대한 수정하지 않고 인증 기능을 수행하도록 할 수 있음
  • 로깅/감사(Logging and Auditing)
    • 특정 페이지 또는 기능에 대해 사용 현황을 모니터링 하고 로그로 관리할 필요가 있을 때 필터를 통해 해당 요청을 수행하기 전 로깅 처리
  • 국제화(Localization)
    • 다국어 처리는 프레임워크 등에서 제공하는 국제화 방법을 처리하거나, 필터를 이용하여 특정 페이지에 들어갈 메시지 등을 해당 언어로 변환하여 전달
  • 한글 인코딩 처리(Encoding)
    • 필터를 통해 한번에 한글 인코딩 처리하는 방법

필터의 구조와 동작 과정

• 필터의 구조
  • 리스너와 유사한 구조로, 필터는 톰캣 서버를 시작할 때 필터 구현 클래스의 어노테이션을 참조하여 javax.servlet.Filter인터페이스를 구현한 클래스 초기화
  • 필터는 여러개 존재 할 수 있으며, 각각의 필터는 init() 메서드를 통해 초기화
    1. init()
    • 필터 초기화 시 한번만 실행, 사용자 요청에 따라 서블릿이나 JSP가 호출될 때 어노테이션으로 설정된 필터 매핑 정보를 참조해 특정 서블릿이나 JSP에 대해 서로 다른 필터 적용 가능
      1. doFilter()
    • 해당 필터가 적용되었을 때 수행할 작업을 구현하는 메인 메소드
      1. destroy()
    • 필터가 종료될 때 수행할 내용 구현
• 필터의 동작 구조
  • 각 필터의 doFilter() 메서드의 내용이 수행되며, ServletRequest와 ServletResponse의 내용을 가로채 필요한 작업을 수행하고 다음 필터를 전달하거나, 요청한 서블릿으로 이동

필터 구현

• 필터 구현
  • @WebFilter 어노테이션을 사용해 필터임을 알리고 서블릿과 유사하게 필터 요청을 위한 url 매핑 정보를 인자로 추가
  • 자동 생성되는 오버라이딩 메소드는 필요한 부분만 구현
    • 필터 자체의 생명주기 메서드가 포함되어 있고, 실제로 필터가 동작할 때는 doFilter() 메서드 호출

    // 필터임을 알림
    @WebFilter("/EncodingFilter")
    public class EncodingFilter implements Filter{
      ...
      public void doFilter(ServletRequest request, ServelResponse response, FilterChain chain) 
      throws IOexception, ServletException{
        ...
        chain.doFilter(request,response);
      }
    }
    

• 여러 개의 필터를 순서대로 적용하기
  • 여러개의 필터를 차례대로 적용하려면 어노테이션 만으로는 불가능
    • 어노테이션에 의한 필터 실행은 특정 url 매핑 조건에 따라 이루어지는 것으로 실행 순서를 조정 할 수 없음
  • 필터의 실행 순서를 지정하기 위해서는 web.xml 파일에 필터를 등록
    • 필터 서블릿의 @WebFilter에는 url 매핑 대신 filterName 속성이 들어가야 함

  @WebFilter(filterName="filterOne")
  public class FirstFilter implements Filter{
    ...
  }
  

• web.xml에 필터를 등록하는 코드의 예시
  • web.xml이 잘못되면 서버가 정상적으로 동작하지 않을 수 있으므로 주의 필요

  <!-- <filter/> 요소는 웹 어플리케이션이 자바 필터와 매개변수를 설정하는데 사용 -->
  <filter>
    <!-- 필터 이름 설정 -->
    <filter-name>...</filter-name> 
    <!-- 자바 클래스 이름 설정 -->
    <filter-class>...</filter-class>
    <!-- 매개변수와 값을 설정 -->
    [<init-param>
      <param-name>...</param-name>
      <param-value>...</param-value>
    </init-param>]
  </filter>
  <filter-mapping>
    <!-- 필터 이름을 설정 -->
    <filter-name>...</filter-name>
    <!-- URL 패턴을 설정 -->
    <url-pattern>...</url-pattern>
  </filter-mapping>
  

web.xml파일의 필터 구성

• <init-param></init-param>
  • 설정된 매개변수와 값을 자바 or JSP 코드에서 접근

  String value = getServletConfig().getInitParameter("매개변수이름");
  

  • [<filter/>요소 사용 예시: 필터이름 myFilter와 클래스 이름 LoggingFilter 설정]

  <filter>
    <filter-name>myFilter</filter-name>
    <filter-class>ch12.com.filter.LoggingFilter</filter-class>
  </filter>
  

  • [<filter/>요소 사용 예: param과 값 admin 설정]

  <filter>
    <filter-name>Myfilter</filter-name>
    <filter-class>ch12.com.filter.LoggingFilter</filter-class>
    <init-param>
      <param-name>param</param-name>
      <param-value>admin</param-value>
    </init-param>
  </filter>
  

• <filter-mapping></filter-mapping>
  • 특정 리소스에 대해 어떤 필터를 사용할 지 설정하는 데 사용

  <filter-mapping>
    <filter-name>필터 이름</filter-name>
    <url-pattern>요청 URL 패턴</url-pattern>
  </filter-mapping>
  

  • [<filter-mapping/>요소 사용 예: URL 패턴을 /*로 설정]

  <filter-mapping>
    <filter-name>MyFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
  

  • [<filter-mapping/>요소 사용 예: URL 패턴을 /ch12/filter.jsp로 설정]

  <filter-mapping>
    <filter-name>MyFilter</filter-name>
    <url-pattern>/ch12/filter.jsp</url-pattern>
  </filter-mapping>
  

• 필터로 form 페이지에서 전송된 요청 파라미터 처리

• JSPBook/src/ch12/com/filter/AuthenFilter.java

public class AuthenFilter implements Filter{

  @Override
  public void init(FilterCOnfig filterConfing) throws ServletException{
    System.out.println("Filter01 초기화");
  }

  @Override
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
  throws IOException, ServletException{
    System.out.println("Filter01.jsp 수행...");
    String name = request.getParameter("name");

    if (name == null || name.equals("")){
      response.setCharacterEncoding("UTF-8");
      response.setContentType("text/html; charset=UTF-8");
      PrintWriter writer = response.getWriter();
      String message = "입력된 name 값은 null 입니다.";
      writer.println(message);
      return;
    }
    filterChain.doFilter(request,response);
  }

  @Override
  public void destroy(){
    System.out.println("Filter01 해제...");
  }
}

• JSPBook/WebContent/WEB-INF/web.xml

<web-app>
  ...
  <filter>
    <filter-name>Filter01</filter-name>
    <filter-class>ch12.com.filter.AuthenFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>Filter01</filter-name>
    <url-pattern>/ch12/filter01_process.jsp</url-pattern>
  </filter-mapping>
</web-app>

• JSPBook/WebContent/ch12/filter01.jsp

<%@ page contentType="text/html; charset=utf-8" %>
<html>
  <head>
    <title>Filter</title>
  </head>
  <body>
    <form method="post" action="filter01_process.jsp">
      <p>
        이름: <input type="text" name="name"/>
      </p>
      <input type="submit" value="전송"/>
    </form>
  </body>
</html>

3. 래퍼 클래스

래퍼 클래스란?

• 래퍼클래스(wrapper class) 란 글자 그대로 포장하는 역할을 하는 클래스
• 래퍼 클래스의 종류
  • 요청 객체를 포장하는 요청 래퍼 클래스
  • 응답 객체를 포장하는 응답 래퍼 클래스
• 두 종류의 래퍼 클래스는 각각 다음의 두 클래스를 상속하여 작성
  • javax.servlet.http.HttpServletRequestWrapper 클래스
  • javax.servlet.http.HttpServletResponseWrapper 클래스

요청 래퍼 클래스

• 요청 래퍼 클래스를 작성하는 방법
  • 요청 래퍼 클래스는 HttpServletRequestWrapper 클래스를 상속받아야 하므로 다음과 같은 골격을 만드는것으로 클래스 작성 시작

  public class MyRequestWrapper extends HttpServletRequestWrapper{
    ...
  }
  

• 요청 래퍼 클래스의 가장 기본적인 역할인 요청 객체를 포장하는 일은 생성자를 통해 수행
  • 요청 객체를 파라미터로 받는 생성자를 선언하고, 그 안에서 파라미터 값을 필드(field, 클래스의 맴버변수)에 저장

  public class MyrequestWrapper extends HttpServletREquestWrapper{
    private HttpServletRequest request;
    public MyRequestWrapper(HttpServletRequest request){
      this.request = request;
    }
  }
  

  • 요청 래퍼 클래스의 생성자 안에서는 반드시 HttpServletRequestWrapper 클래스의 생성자를 호출해야 하고, 요청 객체를 파라미터로 넘겨줘야 함

  public class MyRequestWrapper extends HttpServletRequestWrapper{
    private HttpServletRequest request;
    public MyRequestWrapper(HttpServletRequest request){
      super(request);
      this.request = request;
    }
  }
  

  • 요청 데이터를 변형하는 일은 웹 컴포넌트가 입력 데이터를 가져올때 호출하는 메서드와 똑같은 시그니처의 메서드를 만들어서 그 안에서 수행
    • 나중에 웹 컴포넌트는 입력 데이터를 가져오기 위해 이 메서드를 호출하고, 그 결과 변형된 데이터를 받게 됨

  public class MyRequestWrapper extends HttpServletRequestWrapper{
    ...
    public String getParameter(String name){
      // 이곳에 HTML 문서의 form 엘리먼트를 통해 입력된 데이터를 변형하는 코드
    }
  }
  

  • 요청 데이터를 변형하는 메서드는 웹 컴포넌트의 기대에 맞추어서 정의
    • ex) getParameter 메서드는 입력 데이터 이름을 파라미터로 받고, 그에 해당하는 데이터 값을 리턴

    public class MyRequestWrapper extends HttpServletRequestWrapper{
    ...
    public String getParameter(String name){
      // 이곳에 HTML 문서의 form 엘리먼트를 통해 입력된 데이터를 변형하는 코드
      String value = request.getParameter(name);
      String newValue = value.getUpperCase();
      return newValue;
    }
    }
    

  • 팔터 클래스의 doFilter 메서드 안에서는 요청 객체를 요청 래퍼 객체 바꾸는 일과, 그 요청 래퍼 객체를 가지고 chain.doFilter 메서드를 호출하는 작업 수행

  public class MyFilter implements Filter{
    ...
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)...{
      MyRequestWrapper requestWrapper = new MyRequestWrapper((HttpServletRequest) request);
      chain.doFilter(requestWrapper, response);
    }
  }
  

응답 래퍼 클래스

• 응답 래퍼 클래스를 작성하는 방법
  • 응답 래퍼 클래스는 다음과 같이 HttpServletResponseWrapper 클래스를 상속 하도록 함

  public class MyResponseWrapper extends HttpServletResponseWrapper{
    ...
  }
  

• 응답 래퍼 클래스도 요청 래퍼 클래스와 마찬가지로 생성자 안에서 슈퍼 클래스의 생성자를 호출하고, 응답 객체를 포장하는 일 수행

  public class MyResponseWrapper extends HttpServletResponseWrapper{
    HttpServletResponse response;
    public ParamUpperCaseResponseWrapper(HtppServletResponse response){
      super(response);
      this.response = response;
    }
  }
  

4. 리스너 종합 실습