[JAVA]Filter 응용

Filter 응용

필터의 응용

사실 필터는 그 동안 많은 개발자들이 필요로 하는 기능이였으며, 다른 페이지로 이동하거나(forwarding) 다른 페이지를 포함하는(include)방법을 사용하여 서블릿 체인 형태로 필터링을 구현하는 경우가 많았다. 이러한 필터링을 적용할 수 있는 분야에는 다음과 같은 것들이 있습니다.

데이터 변환(다운로드 파일의 압축 및 데이터 암호화 등) 

XSL/T를 이용한 XML 문서 변경 

사용자 인증

자원 접근에 대한 로깅 등 이 외에도 많은 활용 방법들이 존재할 수 있겠지만 여기서 제시한 네 가지 정도가 가장 많이 사용되지 않을까 생각됩니다. 특히, 데이터 변환이나 XSL/T는 필터를 적용하기에 가장 알맞는 구조를 갖고 있습니다. 데이터 변환의 경우 데이터 압축 필터와 암호화 필터를 체인으로 만들어 암호화한 데이터를 다시 압충하는 등의 다양한 방식이 존재할 수 있습니다. 또한 XSL/T를 사용 할 경우 최종 자원은 XML 문서를 생성하고, 그 문서를 다양한 포맷으로 변환해주는 필터가 존재할 수 있습니다. 예를 들어, 서블릿/JSP는 사용자가 요청한 정보를 XML로 출력하고 필터는 XSL/T를 사용하여 자원의 출력 결과를 다양한 기기(웹브라우저, 모바일 폰 등)에 맞게 변형할 수도 있을 것입니다.

이 글에서는 사용자 인증 필터, XSL/T 필터에 대해서 살펴볼 것이다. 이 두가지 필터는 필터를 통한 흐름 제어 및 응답 데이터의 변경 방법등을 보여주고 있기 때문에, 이 두가지 형태의 필터가 어떤 식으로 구현되는지 이해한다면 그외의 모든 다른 종류의 필터도 어렵지 않게 구현할 수 있게 될 것입니다.

로그인 검사 필터

요즘 많은 웹 사이트들이 회원제로 운영되고 있으며 로그인을 한 이후에 컨텐츠에 접근할 수 있도록 제한한 곳도 많습니다. 특히 컨텐츠의 유료화 추세에 발맞추어 이처럼 사용자 인증이 필요한 사이트는 점차적으로 증가하고 있습니다. 심지어 무료 사이트 조차도 사용자가 인증을 거친 이후에 컨텐츠에 접근할 수 있도록 하고 있습니다. 이처럼 사용자 인증이 웹 사이트의 필수 요소로 등장하면서 개발자들은 각각의 JSP/서블릿 등의 코드에 사용자가 로그인을 했는지의 여부를 판단하기 위한 코드를 삽입하고 있습니다. 여기서 각각의 JSP/서블릿은 같은 코드 블럭을 갖게 되며 이는 회원 인증이 변할 경우 모든 페이지를 변경해주어야 한다는 문제를 일으키게 됩니다.

이러한 문제는 로그인을 검사하는 필터를 사용함으로써 말끔하게 해소할 수 있습니다. 클라이언트의 요청은 서블릿/JSP에 전달되기 전에 먼저 필터를 통과하게 됩니다. 따라서, 필터에서 조건에 따라 알맞게 흐름을 제어할 수 있다는 것을 의미합니다. 먼저 소스 코드부터 작성해면, 어떤 형태로 구현했는지 집중적으로 관찰하기 바랍니다.

import javax.servlet.*;

import javax.servlet.http.*;

public class LoginCheckFilter implements Filter{

public void init(FilterConfig filterConfig) throws ServletException{

}

public void doFilter(ServletRequest request,ServletResponse response,

FilterChain chain)throws java.io.IOException, ServletException {

if (LoginChecker.isLogin((HttpServletRequest)request)) {

// 로그인을 했다면 다음 필터를 실행한다.

chain.doFilter(request, response);

}else {

// 로그인을 하지 않았을 경우 로그인 페이지로 이동한다.

((HttpServletResponse)response).sendRedirect(LOGIN_URL);

}

}

public void destroy() {

}

private static String LOGIN_URL = "/login.jsp";

}

로그인 여부를 검사하는 필터는 위와 같이 매우 간단합니다. 여기서 LoginChecker.isLogin() 메소드는 파라미터로 전달받은 HttpServletRequest를 사용하여 로그인 여부를 판단해주는 일종의 보조 클래스이다. 회원이 로그인을 했을 때 LoginChecker.isLogin()메소드가 true를 리턴한다고 가정할 경우, 위 코드와 같이 로그인을 하면 필터 체인의 다음 필터로 이동하고 로그인을 하지 않은 상태로 판단되면 response를 사용하여 다른 페이지로 이동하면 됩니다. 로그인을 하지 않았을 때 이동하는 페이지는 일반적으로 로그인 폼을 보여주는 페이지가 될 것입니다.

위 코드를 보면 알겠지만 클라이언트의 요청이 반드시 필터 체인의 모든 필터를 통과해야 하는 것은 아니며, 어떤 필터든지 간에 다음 필터로 이동하지 않고 중간에 체인을 끝낼 수 있도록 되어 있습니다. 사용자 인증 필터는 바로 그러한 특징을 이용한 것입니다. 사용자 인증 필터는 거의 대부분의 회원 서비스에서 사용될 것이며 다음과 같이 web.xml을 설정하여 사용자 인증 필터를 적용하면 될 것입니다.

<filter>

<filter-name>LoginChecker</filter-name>

<filter-class>LoginCheckFilter</filter-class>

</filter>

 

<filter-mapping>

     <filter-name>LoginChecker</filter-name>

<url-pattern>/board/*</url-pattern>

</filter-mapping>

인증 필터를 사용함으로써 얻게 되는 장점은 서블릿/JSP와 닽은 치종 자원에서 일일이 로그인 여부를 판단하지 않아도 된다는 점 입니다. 이는 서블릿과 JSP는 클라이언트의 요청에 알맞는 작업만을 수행하는 역할을 맡게 되고 사용자 인증을 검사하는 역할은 맡지 않아도 된다는 것을 의미합니다. 즉, 역할에 안맞게 객체가 분리되는 것 입니다.

XSL/T

필터가 나옴으로써 객체 지향적으로 변화된 부분이 있다면 바로 XML과 관련된 부분일 것 입니다. 필터가 생김으로써 서블릿과 JSP는 더 이상 XSL/T를 이용하여 XML 문서를 HTML이나 WML과 같은 다른 통신 표준으로 변경해 줄 필요가 없게 되었습니다. 이제 XSL/T를 이용한 변환 작업은 이제 필터가 맡게 되었으며 서블릿과 JSP는 XML 문서를 생성하는 것 이외에 다른 작업은 할 필요가 없게 되었습니다.

XSL/T 필터는 응답 데이터를 변경해주는 필터이다. 즉, 서블릿/JSP가 생성한 XML 문서를 XSL/T를 이용하여 완전히 새로운 형태로 재구성하는 것이 XSL/T 필터의 역할이다. 서블릿/JSP의 응답 결과인 XML 문서를 완전히 새로운 형태로 변경해주기 위해서는 서블릿/JSP가 출력한 XML 데이터를 클라이언트(웹브라우저)에 곧바로 전송해서는 안된다. 대신, 서블릿/JSP가 출력한 데이터를 임의의 버퍼에 저장한 후, 그 버퍼에 저장된 XML 데이터를 XSL/T를 사용하여 변환해야만 한다. 이를 위해 먼저 버퍼의 역할을 할 출력 스트림을 작성해야 하며, 또한 그 출력 스트림은 서블릿과 JSP에서 주로 사용되는 PrintWriter 타입이어야만 한다. 다음은 이 예제에서 서블릿/JSP가 출력하는 데이터를 저장해둘 버퍼의 역할을 하는 ReponseBufferWriter 클래스이다.

class ReponseBufferWriter extends PrintWriter {

public ReponseBufferWriter() {

super(new StringWriter(4096))

}

public String toString(){

return ((String Writer)super.out).toString();

}

} 

특별히 어렵지는 않으며, ResponseBufferWriter는 print(), println(), write() 등의 메소드를 통해서 전달된 데이터를 StringWriter에 저장하는 기능을 합니다. toString() 메소드는 StringWriter에 저장된 데이터를 String 타입으로 변환해주는 역할을 합니다.

출력 버퍼를 만들었으니 그 다음으로 해야 할 일은 최종 자원인 서블릿과 JSP가 ResponseBufferWirter를 출력 스트림으로 사용하도록 하는 응답 래퍼 클래스를 작성하는 것 입니다. 이 예제에서 사용할 응답 래퍼 클래스는 다음과 같습니다.

class XSLTResponseWrapper extends HttpServletResponseWrapper {

     

private ReponseBufferWriter buffer = null;

     

     public XSLTResponseWrapper(HttpServletResponse response) {

         super(response);

         buffer = new ReponseBufferWriter();

     }

     

     public PrintWriter getWriter() throws java.io.IOException {

         return buffer;

     }

     

     public void setContentType(String contentType) {

         // do nothing

     }

     

     public String getBufferedString() {

         return buffer.toString();

     }

}

위 코드를 보면 XSLTResponseWrapper 클래스가 복잡하지 않다는 것을 알 수 있습니다. XSLTResponseWrapper 클래스의 getWriter() 메소드는 실제 클라이언트로의 응답에 해당하는 스크림을 리턴하는 대신 앞에서 작성한 ResponseBufferWriter를 리턴합니다. 이렇게 함으로써 ServletResponse의 getWriter() 메소드를 호출하는 서블릿/JSP는 클라이언트로의 응답 스트림이 아닌 ResponseBufferWriter를 출력 스트림으로 사용하게 됩니다. 또 하나 주의해야 할 부분이 바로 setContentType() 메소드가 아무 기능도 하지 않는다는 점인데, 이 이유에 대해서는 뒤에서 설명하도록 하겠습니다.

이제 XML 데이터를 임시로 저장할 Writer도 구현하였고 또한 응답 래퍼도 구현 하였습니다. 이제 마지막으로 남은 것은 필터를 구현하는 것 뿐입니다. 필터는 다음과 같은 4 단계로 작업을 처리 합니다.

1.응답 래퍼(XSLTResponseWrapper)를 생성한다. 

2.생성한 응답 패퍼를 체인의 다음 필터에 전달한다. 

3.래퍼로부터 서블릿/JSP가 출력한 데이터를 읽어와 XSL/T를 사용하여 HTML로 변환한다. 

4.변환된 결과인 HTML을 실제 응답 스트림에 출력한다. 

이 과정을 구현한 것이 바로 XSLTFilter 클래스이다.

import javax.servlet.*;

import javax.servlet.http.*;

import java.io.*;

  

import javax.xml.transform.TransformerFactory;

import javax.xml.transform.Transformer;

import javax.xml.transform.stream.StreamSource;

import javax.xml.transform.stream.StreamResult;

  

public class XSLTFilter implements Filter {

     

public void init(FilterConfig filterConfig) throws ServletException {

     }

     

     public void doFilter(ServletRequest request,ServletResponse response,

          FilterChain chain) throws java.io.IOException, ServletException {

         response.setContentType("text/html; charset=euc-kr");

         PrintWriter writer = response.getWriter();

        

XSLTResponseWrapper responseWrapper = new XSLTResponseWrapper((HttpServletResponse)response);

        chain.doFilter(request, responseWrapper);        

        // XSL/T 변환

        try {

           TransformerFactory factory = TransformerFactory.newInstance();

           Reader xslReader = new BufferedReader(new FileReader("c:/book.xsl"));

           StreamSource xslSource = new StreamSource(xslReader);

           

           Transformer transformer = factory.newTransformer(xslSource);           

           String xmlDocument = responseWrapper.getBufferedString();

           Reader xmlReader = new StringReader(xmlDocument);

           StreamSource xmlSource = new StreamSource(xmlReader);

           

           StringWriter buffer = new StringWriter(4096);

           

           transformer.transform( xmlSource, new StreamResult(buffer) );           

           writer.print(buffer.toString());

        } catch(Exception ex) {

           throw new ServletException(ex);

        }

        

        writer.flush();

        writer.close();

     }

     

     public void destroy() {

     }

}

XSLTFilter 클래스의 doFilter() 메소드를 차근 차근 분석해보도록 하자. doFilter() 메소드가 가장 먼저 하는 것은 응답의 컨텐츠 타입을 text/html로 지정하는 것이다. 물론, 한글을 사용하기 때문에 뒤에 charset도 추가해주었다. 여기서 response 객체는 클라이언트에 대한 응답을 나타내며, 클라이언트는 결과 데이터를 HTML 문서로 인식하게 된다. 앞에서 XSLTResponseWrapper의 setContentType() 메소드에서 아무것도 하지 않았었는데, 그 이유는 XSLTFilter의 doFilter() 메소드에서 지정한 컨텐츠 타입을 변경할 수 없도록 하기 위함이다.

그 다음에는 래퍼 클래스를 생성한다. 래퍼 클래스는 XSLTResponseWrapper이며, 생성된 래퍼 클래스는 chain.doFilter()를 통해서 다음 필터에 전달된다. 필터 체인의 실행이 완료되면 XSLTResponseWrapper 객체에는 서블릿이나 JSP가 출력한 XML 응답 데이터가 저장되며, 그 데이터는 responseWrapper.getBufferedString() 메소드를 통해서 구할 수 있게 된다. 이렇게 해서 구한 XML 데이터는 JAXP 1.1에서 제공하는 Transformer의 transform() 메소드를 통해서(즉, XSL/T를 통해서) HTML 형식으로 변환된다.

이제 XSL/T 필터와 관련된 모든 클래스의 구현은 끝이 났다. 이제 남은 것은 XSL/T에서 사용할 XSL 문서를 작성하고 XML 문서를 생성해주는 JSP/서블릿을 프로그래밍하고 그리고 web.xml 파일을 통해서 XSLTFilter를 필터로 등록하는 것이다. 먼저 web.xml 파일을 필터를 사용하여 지정해보자.

   <filter>

      <filter-name>XSLT</filter-name>

      <filter-class>XSLTFilter</filter-class>

   </filter>

   

   <filter-mapping>

      <filter-name>XSLT</filter-name>

      <url-pattern>/xml/*</url-pattern>

   </filter-mapping>

이제 /xml/로 들어오는 모든 요청은 XSLTFilter를 토?서 처리된다. 이제 XML 문서를 생성해주는 JSP 페이지를 작성해보자. 여기서는 테스트를 위해서 다음과 같이 간단한 JSP 페이지를 사용하였다. (이 JSP를 book.jsp라 하자.)

  <?xml version="1.0" encoding="euc-kr" ?>  

  <%@ page contentType="text/xml; charset=euc-kr" %>

  

  <list>

     

     <book>

        <title>JavaCan.com의 JSP Professional</title>

        <author>이동훈, 최범균</author>

        <price>24,000</price>

     </book>

     

     <book>

        <title>JavaCan.com의 Victory Java</title>

        <author>이동훈, 최범균</author>

        <price>30,000</price>

     </book>

     

  </list>

위 JSP 페이지는 보다시피 XML 문서를 생성해낸다. 이 XML 문서를 HTML로 변환해주기 위해 사용되는 XSL은 다음과 같다. (여기서는 XSL에 대한 내용은 설명하지 않겠다.)

 <?xml version="1.0" encoding="euc-kr" ?>

  

  <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">

    <xsl:output method = "html" indent="yes" encoding="euc-kr" />

  

    <xsl:template match="list">

    <html>

    <head><title>책 목록</title></head>

    <body>

      현재 등록되어 있는 책의 목록은 다음과 같습니다.

      <ul>

      <xsl:for-each select="book">

        <li><b><xsl:value-of select="title" /></b>

            (<xsl:value-of select="price" /> 원)

            <br />

            <i><xsl:value-of select="author" /></i>

        </li>

      </xsl:for-each>

      </ul>

    </body>

    </html>

    </xsl:template>

    

  </xsl:stylesheet>

book.jsp를 웹어플리케이션의 /xml 하위디렉토리에 복사한 후 웹브라우저에서 book.jsp를 요청한 결과의 소스 코드를 보면 다음과 같이 XML이 아닌 XSLTFilter 필터를 통해서 변경된 결과가 오는 것을 확인할 수 있을 것이다.

  <html>

  <head>

  <META http-equiv="Content-Type" content="text/html; charset=euc-kr">

  <title>책 목록</title>

  </head>

  <body>

       현재 등록되어 있는 책의 목록은 다음과 같습니다.

       <ul>

  <li>

  <b>JavaCan.com의 JSP Professional</b>

             (24,000 원)

             <br>

  <i>이동훈, 최범균</i>

  </li>

  <li>

  <b>JavaCan.com의 Victory Java</b>

             (30,000 원)

             <br>

  <i>이동훈, 최범균</i>

  </li>

  </ul>

  </body>

  </html>

결론

여기서 살펴본 필터의 예제는 매우 간단하게 구현되는 것들이었지만, 아마 필터를 구현하는 데 있어서 가장 기본적인 형태를 갖는 예제가 아닐까 생각된다. 이번 필터 예제를 통해서 여러분들은 필터의 쓰임새가 많겠구나 하고 생각했을 것이다. 어쩌면 벌써부터 압축 필터나 이미지 생성 필터 등을 생각하고 있을지도 모르겠다. 하지만 필터의 응용을 생각하기 이전에 다음과 같은 점을 염두해두었으면 한다.

?필터는 재사용이 가능해야 한다. 즉, 필터들은 객체 지향적으로 설계되고 구현되어야 한다. 

?필터를 통과하지 않아도 JSP/서블릿/기타 자원은 알맞은 결과를 출력해야 한다. 

?필터간에 커플링(coulpling; 결합도)이 존재해서는 안 된다. 

이러한 것들을 염두하고서 필터를 설계하고 구현한다면, 그 필터는 여러분이 개발하게 될 웹 어플리케이션 곳곳에서 사용될 것이며 그만큼 여러분의 웹 어플리케이션은 역할별로 알맞게 분리된 구조를 갖게 될 것이다.