소설같은JSP2부  7장 Custom Tag & JavaMail  03 태그 핸들러 클래스  

 

7.3 태그 핸들러 클래스(Tag Handler Class)

 

태그 핸들러 클래스는 위에서 말했듯이 커스텀 태그의 동작을 정의하고 있는 클래스입니다. 즉 JSP 페이지에서 태그가 나타날 때, 그 태그가 어떤 일을 할 것인지를 정의하여 놓은 것입니다. 태그 핸들러는 javax.servlet.jsp.tagext.Tag나 javax.servlet.jsp.tagext.BodyTag 인터페이스를 구현해서 만들어집니다. 또한 위의 인터페이스를 이미 구현한 TagSupport나 BodyTagSupport 클래스를 상속해서 만들기도 합니다.

 

 

그림 7-3 Tag Handler의 클래스들

 

n        Tag 인터페이스

Tag 인터페이스는 JSP 페이지와 태그 핸들러 사이를 연결하는 기본적인 프로토콜과 메서드를 정의합니다. 이것은 단순하고 기본적인 커스텀 태그를 구현하기 위해 만들어졌으며, 커스텀 태그의 Body 부분은 건드리지 않는 것을 원칙으로 합니다. 즉, Tag 인터페이스는 태그에 Body 부분이 없거나, Body 부분을 그대로 나타내는 경우에 사용될 수 있습니다. Tag 인터페이스는 태그 핸들러의 주기를 정의하며, 태그가 시작하고 끝날 때 호출되는 메서드들을 정의하는데 사용됩니다.

 

n        BodyTag 인터페이스

BodyTag는 Tag 인터페이스를 상속한 인터페이스로 태그의 몸체를 다룰 수 있는 메서드를 제공합니다. Tag 인터페이스가 제공하는 메서드 외에 부가적인 메서드를 제공합니다.

 

n        TagSupport 클래스

TagSupport는 Tag 인터페이스를 구현하는 클래스로, 새로운 태그 핸들러를 생성하는 기본이 되는 클래스입니다. Tag 인터페이스의 메서드 외에 setter,/getter 메서드 등, 태그를 다룰 때 유용하게 쓰일 수 있는 메서드들을 제공하고 있습니다.

 

n        BodyTagSupport 클래스

BodyTagSupport는 TagSupport 클래스를 상속 받고 BodyTag 인터페이스를 구현한 클래스입니다. 이 클래스도 역시 상속 받고 구현된 것 이외에 getBodyContent 메서드등, 여러가지 유용한 메서드들을 가지고 있습니다. 많은 태그 핸들러들이 BodyTagSupport 클래스를 상속 받아서 몇 가지 소수의 메서드만 재정의해 쓰는 방식으로 만들어 집니다.

 

n        BodyContent 클래스

BodyContent는 JspWriter 클래스를 상속 받는 추상 클래스로서, 태그의 바디부분을 처리한 것을 캡슐화하고 있는 클래스입니다. 즉, BodyContent의 내용은 Body 부분 처리의 결과로, 그것을 핸들러가 이용할 수 있습니다. 따라서 BodyContent는 그 내용을 스트링으로 변환하거나, 읽거나, 지울 수 있는 메서드를 가지고 있습니다.

 

태그 핸들러 클래스는 클래스 파일들이나 빈 파일이 있는 곳에 위치시키면 됩니다. 톰캣을 사용할 때는 classes 폴더 아래에 패키지 형태로 만들어서 관리해야 한다는 것을 명심하시기 바랍니다.

 

지금까지 위에서 살펴본 것을 바탕으로 간단한 태그 핸들러를 만들어 보겠습니다. 이것은 지정된 태그가 실행될 때 단순히 “Hello Tag”라는 문자열만 출력해 주도록 하는 태그 핸들러입니다.

 

HelloTag.java

간단한 태그 핸들러

package tags;
import java.io.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

public class HelloTag implements Tag {
  PageContext pageContext;
  Tag parent;

  public int doStartTag() throws JspException{
    try{
      JspWriter out = pageContext.getOut();
      out.write("Hello Tag!!!");
    }catch(IOException e){}
    return SKIP_BODY;
  }
  public int doEndTag() throws JspException{
    return EVAL_PAGE;
  }
  public void release(){}
  public void setPageContext(PageContext pg){
    pageContext = pg;
  }
  public void setParent(Tag p){
    parent = p;
  }
  public Tag getParent(){
    return parent;
  }
}

C:\jakarta\webapps\MySample\WEB-INF\classes\tags>javac HelloTag.java

 

이 예제는 Tag 인터페이스를 상속 받아 간단한 태그 핸들러 클래스를 만들고 있습니다. 물론 Tag 인터페이스를 구현한 TagSupport 클래스를 이용하면 더 손쉽게 태그 핸들러를 제작할 수 있겠지만, 여기서는 내부의 원리를 보여주고자 하여 Tag 인터페이스를 구현해서 인터페이스의 메서드들을 모두 재정의하여 놓았습니다.

 

위의 컴파일의 경로에서 보듯, 태그 핸들러 클래스는 classes 폴더아래에 tags라는 패키지 내에 있습니다. 이렇게 패키지 형태로 만들어서 관리하는 것이 편하고 또 위에서도 언급했듯이 톰캣에서는 이렇게 패키지 형태로 만들어 놓는 것이 원칙입니다.

 

그럼 소스를 설명 드리겠습니다. 아직 TLD와 JSP 페이지에 연결하지 않아 그 내용을 정확히 이해할 수는 없겠지만, 원리를 생각하며 보시기 바랍니다.

 

여기서 실질적인 작업을 하는 메서드는 doStartTag 메서드 입니다. 이 메서드는 태그가 시작할 때 호출되며, 여기서는 JspWriter 객체를 생성한 다음 “Hello Tag”란 문자열을 출력하여 줍니다. 그리고 SKIP_BODY란 상수를 반환하는데 이것은 Body즉, 태그 사이의 몸체부분은 처리하지 않는다는 뜻입니다.

 

n        public int doStartTag() throws JspException{

n         try{

n            JspWriter out = pageContext.getOut();

n            out.write("Hello Tag!!!");

n          }catch(IOException e){}

n          return SKIP_BODY;

n         }

 

나머지 메서드들은 기본적으로 위와 같이 구현된다는 것만 알아두시기 바랍니다. Tag 인터페이스를 구현하는 TagSupport 클래스에서는 위와 같은 것은 기본적으로 구현해 놓아서, TagSupport 클래스를 이용하여 태그 핸들러를 작성할 때는 doStartTag 메서드 하나만 정의해도 문제없이 작동합니다. 태그 핸들러에 관계되는 클래스의 메서드는 아래 설명해 놓은 API를 참고하시기 바랍니다.

 

 

Tag 인터페이스 주요 멤버필드, 메서드

public static final int SKIP_BODY : 바디의 내용을 무시합니다.

public static final int EVAL_BODY_INCLUDE : 바디내용을 처리합니다.

public static final int SKIP_PAGE : 현재 페이지에 대한 처리를 건너뜁니다.

public static final int EVAL_PAGE : 현재 페이지를 처리합니다.

 

public void setPageContext(PageContext pc) : 태그 핸들러의 pageContext속성을 설정합니다.

public void setParent(Tag t) : 태그 핸들러의 parent속성을 설정합니다.

public Tag getParent() : 태그핸들러의 parent를 리턴합니다.

public int doStartTag() throws JspException : 시작태그를 처리합니다.

public int doEndTag() throws JspException : 종료 태그를 처리합니다.

public void release() : 태그수행을 마치고 리소스등을 해제합니다.

 

BodyTag 인터페이스 주요 멤버필드, 메서드

public static final int EVAL_BODY_BUFFERED : 커스텀 태그의 바디부분을 처리하기 위한 새로운 버퍼생성의 요청을 나타낸다.

public void setBodyContent(BodyContent b) : doInitBody() 메서드가 호출되기 전에 호출되며, 출력을 위한 BodyContent 스트림을 설정한다.

public void doInitBody() throws JspException : 태그의 바디를 처리하기 전에 설정을 해 줄 때 사용한다.

 

TagSupport 클래스 주요 메서드

public static final Tag findAncestorWithClass(Tag from, java.lang.Class klass) : 주어진 인스턴스에 가장 가까운 클래스타입의 인스턴스를 찾습니다.

public java.lang.String getId() : 태그의 id 속성값을 리턴합니다.

public void getValue(java.lang.String k) : 주어진 이름의 값을 리턴합니다.

public void removeValue(java.lang.String k) : 주어진 이름의 값을 삭제합니다.

public void setParent(Tag t) : 부모의 태그를 설정합니다.

public viod setTagId(String id) : 태그의 id 속성을 설정합니다.

 

BodyTagSupport 클래스 주요 메서드

public int doAfterBody() throws JspException : 태그의 body부분 조작을 위한 메서드로 body작업을 마친 후 의 결과를 리턴해 줍니다.

public BodyContent getBodyContent() : BodyContent 객체를 리턴하여 줍니다.

public static final Tag findAncestorWithClass(Tag from, java.lang.Class klass) : 주어진 인스턴스에 가장 가까운 클래스타입의 인스턴스를 찾습니다.

public java.lang.String getId() : 태그의 id 속성값을 리턴합니다.

public void getValue(java.lang.String k) : 주어진 이름의 값을 리턴합니다.

public void removeValue(java.lang.String k) : 주어진 이름의 값을 삭제합니다.

public void setParent(Tag t) : 부모의 태그를 설정합니다.

public viod setTagId(String id) : 태그의 id 속성을 설정합니다.

 

BodyContent 추상 클래스 주요 메서드

public abstract java.io.Reader getReader() : 태그의 바디를 읽을수 있는 Reader객체를 리턴합니다.

public abstract java.lang.String getString() : 태그 바디 전체를 담은 스트링을 리턴합니다.

public void clearBody() : 태그의 바디내용을 지웁니다.

public JspWriter getEnclosingWriter() : JspWriter를 리턴해 줍니다.

 



jabook저자명함
제목:소설같은JSP2부
저자:최영관