Enterprise Java Technologies Tech Tips

2004년 3월 5일

Enterprise Java Technologies Tech Tips에 오신 여러분을 환영합니다. Java 2 Platform, Enterprise Edition (J2EE)에 기반한 enterprise Java technologies 와 APIs의 사용에 관한 최신 정보를 얻어 가시기 바랍니다. 이 글에서는 Java 2 SDK, Standard Edition, v 1.4와 Java 2 SDK, Enterprise Edition, v 1.3.1 (Reference Implementation)를 사용합니다.

이번 호에서는,

커스텀 태그 파일
JSP 페이지에서 엔터프라이즈 빈 사용하기

를 다루게 됩니다.

저자 Mark Johnson

예제의 샘플 아카이브를 다운로드 받으세요. 컨텍스트 루트는 ttfeb2004이고 샘플코드의 사용법은 index.html welcome file 에서 보실 수 있습니다. 이 코드의 사용에 관한 권한이나 정보는 license terms를 참고하시기 바랍니다.

커스텀 태그 파일

JavaServer Pages (JSP pages)의 커스텀 태그는 HTML 태그와 유사하다. 하지만 커스텀 태그는 태그와 관련된 핸들러 클래스에 의해 런타임시에 텍스트 형식의 출력값으로 대체된다. 지난 테크팁인 Using Custom Tags에서 이와 같은 클래스의 생성방법에 대해 이야기했다. 이번달의 첫번째 팁은 커스텀 태그를 구현하는 더 새롭고 쉬운 방법을 설명한다.

JSP 2.0이전에는 커스텀 태그를 생성하려면 자바 태그 핸들러 클래스로 구현하는 것이 유일한 방법이었다. 또한 핸들러 클래스 개발자는 태그를 웹 컨테이너에게 설명하는 역할을 하는 TLD파일을 생성해야만 했다. 커스텀 태그의 힘은 강력하지만 이를 이용하려면 프로그래밍 스킬이 요구되고 JSP 페이지가 어떻게 HTML로 변환하는지를 확실하게 알고 있어야 한다.

JSP 2.0 태그 파일의 새로운 기능은 비개발자도 재사용이 가능한 커스텀 태그를 작성할 수 있게 할 뿐만 아니라 프로그래머도 더 쉽게 작업할 수 있도록 도와준다. JavaServer Pages Standard Tag Library (JSTL) 과 expression language (EL)으로 이루어진 JSP 2.0 구문을 이용하면, 자바 코드를 작성할 필요없이 커스텀 태그를 생성할 수 있다.

태그 파일은 JSP 페이지에서 재사용이 가능한 컴포넌트이다. 이를 사용하면 다음과 같은 이점이 있다.

Scriptlets을 숨기거나 제거하는데 사용될 수 있다.
자르기와 붙이기가 아닌, 레퍼런스로를 이용하여 코드를 재사용가능하도록 만든다.
JSP 페이지를 작성하기 쉽고, 매우 논리적이며, 유지하기 쉽도록 만든다.
비개발자에 의해 작성될 수 있다.
태그 파일의 구성은 자바가 아닌 HTML에 더 가깝다. 따라서 JSP 페이지는 단일 언어로 작성된 것처럼 보인다.
태그 파일은 하이 레벨 컴포넌트를 형성하기 때문에 생산성을 높이고 개발속도를 빠르게 한다.
커스텀 태그에 의해 사용되는 TLD파일은 흔히 자동적으로 생성된다.
현존하는 페이지를 리팩토링하기 위해 사용될 수 있다. 코드의 공통 부분은 애플리케이션 뷰간에 공유되는 태그 파일로 통합될 수 있다.

태그 파일이 커스텀 태그 핸들러 클래스를 완벽하게 대체하지는 못한다. 태그 파일은 재사용이 가능한 컨텐츠를 관련된 레이아웃과 프리젠테이션으로 캡슐화할 때 적합하다. 반면 커스텀 태그는 JSP페이지에서 애플리케이션 로직(logic)을 재사용할 때 더 효과적이다. 가령, 페이지 헤더와 풋터(꼬리말)는 태그 파일을 위한 최적의 애플리케이션이다. 이와 비교해서 JSTL의 커스텀 태그는 자바 언어 핸들러 클래스로서 구현된다.

태그 파일의 특징

태그 파일은 사실 태그 핸들러 클래스로 번역/컴파일된다. 태그 핸들러와 태그 핸들러 클래스의 단 한가지 다른 점은 태그 핸들러는 JSP 구문으로 쓰여지고 태그 핸들러 클래스는 자바 언어로 작성된다는 점이다.

JSP 2.0-compliant 컨테이너는 웹 아카이브 디렉토리인 WEB-INF/tags내에서 태그 파일을 찾게 된다. 태그 파일은 WEB-INF/lib의 JAR 파일안에 묶일 수도 있다. JSP 페이지를 구현할 때 웹 컨테이너가 태그 파일과 관련된 태그를 마주치게 되면, 태그 파일의 JSP컨텐츠 출력값은 계산되어서 응답 스트림에 포함되게 된다. 태그 파일은 애트리뷰트를 정의할 수 있고 JSP 2.0 expression language (EL)에 대한 접근이 가능하다. 또한 태그 파일은 실행이 완료된 후에도 존재하는 EL 변수들을 생성할 수 있다.

태그 파일은 애트리뷰트 지시어를 이용해서 애트리뷰트를 선언하게 된다. 다음은 이 팁의 샘플코드로부터 발췌한 예제이다. 태그 파일은 단일 애트리뷰트 지시어로 시작한다.

   <%@ attribute name="format" required="false" %>

날짜를 생성하는 태그는 위의 라인을 이용해서 컨테이너에게 가능한 "format" 애트리뷰트를 찾으라고 명령한다. 필수 애트리뷰트일 경우에는 지시어의 "required" 애트리뷰트가 "true"로 설정된다. 이 지시어들은 전개시에 웹 컨테이너가 고유의 TLD 파일을 생성하도록 해준다.

태그는 애트리뷰트를 통해서 입력값을 받는다. 태그 파일에 의해 생성되는 출력 텍스트이외에도 태그는 EL변수를 생성함으로써 데이터를 "output" 할 수 있다. 태그 파일은 다음과 같이 값을 태그 파일이 호출되었던 페이지에 값을 리턴할 수도 있다.

   <%@ variable name-given="filesincluded" scope="AT_END" %>

"name-given"은 태그가 수행된 후, 페이지내에 설정되는 변수의 이름을 제공한다. "AT_END"는 태그 파일이 완성되면 변수가 설정된다는 것을 말한다.

태그 파일 예제

이번 샘플 코드는 지난 2002/9월의 테크팁 "Using Custom Tags"에서 작성했던 커스텀 태그를 재구현하는 태그 파일을 포함하고 있다. 오리지널 태그는 다음 세 가지 중 한가지 방법으로 서버에 날짜의 포맷을 지정한다.

만약 포맷이 설정되지 않았거나 비어있다면, 태그는 디폴트 포맷으로 날짜를 프린트한다.
포맷 파라미터가 $사인으로 시작되면, 태그는 스트링의 나머지 부분을 환경 엔트리의 이름으로 사용한다. 태그는 지명된 환경 엔트리를 찾아서 그것의 값을 포맷으로 사용하게 된다.
java.text.SimpleDateFormat과 호환되는 "format" 파라미터가 포맷 스트링을 포함하고 있다면, 스트링은 날짜의 포맷을 지정하는데 쓰이게 된다.

태그 파일에 의해 지정된 태그는 약간 다르게 작동한다. 포맷 파라미터가 $으로 시작하면, 태그는 환경 엔트리 대신 서블릿 컨텍스트 초기화 파라미터를 찾는다. (JSTL 1.0의 expression language는 환경 엔트리를 액세스할 수 있는 빌트 인 서포트를 포함하지 않았다.)

샘플 태그 파일인 date.tag는 파일이 요구하는 애트리뷰트를 정의하는 몇몇 지시어로 시작한다. 또한 이 태그가 사용하는 다른 태그 라이브러리를 위한 namespaces를 식별해내기도 한다.

   <%@ attribute name="format" required="false" %>
   <%@ taglib uri=
     "http://java.sun.com/jsp/jstl/core" prefix="c" %>
   <%@ taglib uri=
     "http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
   <%@ taglib uri=
     "http://java.sun.com/jsp/jstl/functions" 
     prefix="fn" %>

날짜 태그 파일의 다음 블록은 포맷 스트링을 결정하기 위해 <c:choose>태그를 사용한다. <c:choose>는 JSP페이지에서 if/then/else기능을 선택하기 위한 태그이다. 처음 "when"구문은 포맷이 null이거나 비어있을 때 EL변수 "format"을 디폴트 값으로 설정하기 위한 것이다.

   <c:choose>
     <%-- If format is blank, set default --%>
     <c:when test="${format == null or format == ''}">
       <c:set var="format" 
         value="EEEE, d MMMM yyyy 'at' kk:mm:ss z"/>
     </c:when>
   ...

"format"이 비어있는 상태가 아니라면, 그것은 "$"사인으로 시작하거나 또는 "$"으로 시작하지 않는다. 첫번째 경우에서, <choose> 태그의 <otherwise>절은 첫번째 "$"을 없애버리고 주어진 이름을 이용해서 "format" 변수의 값을 컨텍스트 파라미터의 컨텐츠로 대체하게 된다.

     <c:otherwise>
       <%-- Else if format starts with "$", 
           look up in context param,
           and set "format" to its value. --%>
       <c:if test="${fn:substring(format,0,1) == '$'}">
         <c:set var="format_name" 
           value="${fn:substringAfter(format,'$')}"/>
         <c:set var="format" 
           value="${initParam[format_name]}"/>
       </c:if>

       <%-- Otherwise leave it as it is --%>
     </c:otherwise>
   </c:choose>

코멘트에 적혀있듯이, "format"이 "$"로 시작하지 않으면, 그것의 값은 변하지 않는다.

페이지의 이 지점에서, EL "format"변수의 값은 날짜의 포맷을 지정하기 위해 사용될 스트링으로 설정된다. useBean라인은 현재 시간을 나타내는 Date객체를 생성하고 fmt:formatDate 메소드는 이 날짜를 주어진 "format"에 설정하게 된다.

   <%-- Now actually create and format the date --%>
   <jsp:useBean id="now" class="java.util.Date"/>
   <fmt:formatDate value="${now}" pattern="${format}"/>

이것으로 태그 파일이 완성되었다.

태그 파일을 이용하는 것은 더욱 간단하다. 샘플 페이지 DatePage.jsp 의 윗부분에 있는 지시어는 /WEB-INF/tags 디렉토리에 있는 모든 태그가 접두사 "mytags"를 이용해서 액세스 가능하다는 것을 말한다. 지시어는 다음과 같다.

    <%@ taglib tagdir="/WEB-INF/tags" prefix="mytags" %>

자, 이제 JSP 태그 파일을 다른 커스텀 태그처럼 간단하게 사용할 수 있다. 샘플 페이지 DatePage.jsp에서 발췌한 코드이다.

   The time and date at the server in the default format
      are <b><mytags:date/></b>.<br>
   The time zone at the server is 
      <b><mytags:date format="zzzz"/></b>.<br>
   The server date is 
      <b><mytags:date format="M/d/yyyy"/></b>.<br>
   The server time is 
      <b><mytags:date format="hh:mm:ss a"/></b>.<br>

각각의 는 태그 파일을 호출하는 결과를 낳고, 태그는 서버에 해당 시간과 날짜를 출력하게 된다.

이 예제는 JSP태그 파일을 간단히 소개하는 것에 그친다. 사실 JSP태그 파일은 여기서 언급한 것 이상의 많은 옵션을 갖고 있다. JSP태그 파일에 대한 자세한 정보는 J2EE 1.4 튜토리얼의 "Custom Tags in JSP Pages"장을 참고하기 바란다.

JSP 페이지에서 엔터프라이즈 빈 사용하기

2004/1/26일 테크팁은 JSP 2.0 Expression Language (EL)에 대해서 다뤘다. 이 팁의 예제 중 하나는 JavaBean이 EL변수를 이용해서 이름으로 액세스 가능하게 되는 방법을 설명했다. JavaBean 속성은 또한 단순 EL 표현으로도 액세스가 가능한데, 이 기능은 Enterprise JavaBeans components (enterprise beans)을 JSP 페이지 내에서 매우 쉽게 사용할 수 있도록 해준다. 적절한 스코프에서 지명된 애트리뷰트내의 애플리케이션 뷰에 의해 요구되는 엔터프라이즈 빈즈를 단순히 가져다 놓자. 그리고 JSP 페이지가 EL expressions으로 쓰인 이름에 의해 애트리뷰트를 액세스할 수 있도록 하자. 예제를 통해 이 기법을 이해해 보도록 하겠다.

샘플 코드

이 글의 샘플 코드는 크레딧 카드 인증 애플리케이션이다. 크레딧 카드 회사는 크레딧 카드 넘버의 유효함을 체크하기 위해 쓰이는 여러 가지 규칙을 갖고 있다. 크레딧 카드 넘버의 상태는 유효하거나 잔고부족이거나, 만료 혹은 취소된 상태일 수 있다. 유효함을 체크하는 목적은 인증이 되기 전에 데이터 엔트리 에러를 잡는 것이다.

다음과 같은 경우에 크레딧 카드 넘버는 유효하다.

크레딧 카드의 타입에 맞는 접두사를 갖는다.
크레딧 카드 넘버가 올바른 디지털 넘버를 갖는다.
크레딧 카드 넘버가 checksum 테스트를 패스했다.
카드가 만료된 상태가 아니다.

샘플 애플리케이션은 3개의 컴포넌트를 사용한다.

크레딧 카드 데이터를 나타내고 확인하는 stateful 세션 빈인CreditCardLocal
세션 스코프내에 있는 빈의 객체를 생성하는 서블릿인 Feb2004Servlet. 따라서 개개의 유저는 하나의 인스턴스를 얻게 된다.
데이터를 수집하고 인증 결과를 프린트하는 JSP페이지인 ValidateCard.jsp

코드의 작동 원리는 다음과 같다. index.jsp 입력페이지의 링크는 서블릿을 가르키고 서블릿은 세션 빈 핸들을 생성하여 그것을 세션 컨텍스트에 둔다. 그리고나서 서블릿은 카드 넘버 입력값과 인증을 다루는 URL jsp/ValidateCard.jsp로 요청을 보낸다. 이 입력페이지는 사용자가 데이터 입력을 마친 이후에 재호출된다. 사실 실제 애플리케이션에서는 구매 과정에서 카드가 올바르게 유효인증이 되었다면 자동적으로 다음 단계로 넘어가게 된다.

서블릿의 코드는 간단하다. 코드는 CreditCardLocal타입의 stateful 세션 빈을 생성하고 이를 "creditCard" 밑의 HttpSession애트리뷰트내에 위치시킨다. 만약 서블릿이 호출되었을 때 이와 같은 변수가 이미 존재하고 있다면, 서블릿은 존재하던 인스턴스를 제거하게 된다.

   
   CreditCardLocal creditCard = (CreditCardLocal)
      req.getSession().getAttribute("creditCard");

   // Remove it if it exists--we're starting over.
   if (creditCard != null) {
      try {
         creditCard.remove();
      } catch (Exception e) {
         System.err.println(
           "Exception removing credit card: " + e);
      }
      System.err.println("INFO: Removed previous card.");
   }

   // Create new enterprise bean reference in session scope
   try {
      InitialContext ctx = new InitialContext();
      CreditCardLocalHome cclh =
         (CreditCardLocalHome)ctx.lookup(
            "java:comp/env/ejb/CreditCard");

      String cardName = req.getParameter("cardName");
      String cardType = req.getParameter("cardType");
      String cardNumber = req.getParameter("cardNumber");
      String cardDate = req.getParameter("cardDate");

      creditCard = cclh.create(
         cardName, cardNumber, cardType, cardDate);
      
      req.getSession().setAttribute(
         "creditCard", creditCard);
      
   } catch (Exception e) {
      throw new ServletException(e);
   }
   
   RequestDispatcher rd = req.getRequestDispatcher(
      "/jsp/ValidateCard.jsp");
   rd.forward(req, res);

위의 마지막 2줄을 자세히 보자. 엔터프라이즈 빈 레퍼런스를 생성한 후에 서블릿은 입력과 유효인증을 다루는 ValidateCard.jsp 페이지에 요청을 보낸다.

이 페이지의 첫번째 부분은 페이지에 보내진 파라미터들을 엔터프라이즈 빈의 해당 속성에 카피하고 있다. <c:set> 태그가 주어진 이름의 엔터프라이즈 빈 속성에 액세스하기 위해 어떻게 "target" 과 "property"을 사용하고 있는지를 살펴보자.

   <!-- Copy parameters to creditCard properties -->
   <c:set target="${creditCard}" property="name"
          value="${param['cardName']}"/>
   <c:set target="${creditCard}" property="type"
          value="${param['cardType']}"/>
   <c:if test="${param.cardNumber != null and 
                                param.cardNumber != ''}">
     <c:set target="${creditCard}" property="number"
            value="${param.cardNumber}"/>
   </c:if>
   <c:set target="${creditCard}" 
          property="expirationDateStr"
          value="${param['cardDate']}"/>

요청된 파라미터가 설정되지 않았다면 ${param['cardName']}과 같은 expressions은 null값을 산출하고 따라서 해당 빈의 속성은 null로 설정된다.

ValidateCard.jsp페이지의 다음 부분은 사용자로부터 데이터를 수집하는 역할을 한다. 이 데이터는 사용자가 제출(submit)버튼을 클릭했을 때 동일한 페이지에 그대로 나타난다. 이 섹션의 코드는 몇 가지 재미있는 기능들을 포함하고 있다. 이 입력페이지는 항상 재호출되기 때문에 다음과 같이 정의된 각각의 입력값은 크레딧 카드의 입력값을 현재값으로 설정하는 애트리뷰트를 포함한다.

입력 페이지의 첫번째 섹션은 레이아웃과 로컬 배경색을 조절하기 위해 하나의 표를 사용하면서 입력페이지의 파라미터인 "cardName"을 위한 입력 요소를 정의하고 있다.

   <input type="text" name="cardName" size="32"
          value="${creditCard.name}"><br>

cardName의 값은 다음의 코드와 같이 EL expression ${creditCard.name}으로 설정된다.

   <%= ((CreditCardLocal)request.getSession().
      getAttribute("creditCard")).getName() %>

만약 이와 같은 폼이 전에 제출된 적이 있다면 cardName입력 박스안에 입력된 적이 있는 이름들이 나타나게 될 것이다.

다음으로 입력해야 할 것은 각각의 크레딧 카드 타입에 하나씩 할당된 라디오 버튼 세트이다. 크레딧 카드 객체는 CCInfo 타입의 "info" 속성을 갖는다. 이 객체는 모든 유효한 크레딧 카드 타입에 관한 정보를 담고 있는 java.util.HashMap이며, 이 맵의 키는 개개의 크레딧 카드를 나타내는 이름들이다. 가령 "mc"는 MasterCard를 말한다. 여기서 값은 카드를 설명하는 객체인 CCDesc타입이다. (더 자세한 정보는 코드 예제에 포맷된 소스 코드를 참고하기 바란다.) <c:forEach>루프문은 각각의 카드 타입을 위한 라디오 버튼을 생성하면서 유효한 크레딧 카드 타입의 리스트를 반복연산하게 된다.

   <p>
   <b>Type of card:</b><br>
   <c:forEach var="item" items="${creditCard.info}">
     <input type="radio" name="cardType" 
            value="${item.key}"
       ${(item.key eq creditCard.type) ? 'checked' : ''}>
       ${item.value.description}<br>
   </c:forEach>

생성되는 중인 버튼이 creditCard 객체에서 선택되었다면, ${(item.key eq creditCard.type) ? 'checked' : ''} expression은 "checked" 스트링을 산출한다. 이 루프문은 확장성의 형태로 눈에 보이지 않는 이점을 제공한다. 새로운 타입의 크레딧 카드를 추가하기 위해서는 CCDesc description의 타입을 CreditCard의 CCInfo로만 추가해주면 된다. 다음번에 ValidatePage.jsp가 실행될 때, 루프문은 새로운 타입의 카드를 찾아내어 리스트에 추가한다.

다음 2개의 입력값은 크레딧 카드 넘버와 만기 날짜를 포함한다.

   <b>Card number:</b>
   <input type="text" name="cardNumber" size="24"
      value="${creditCard.number}"><p>
   <b>Expiration date (mm/yyyy):</b>
   <input type="text" name="cardDate" size="10" 
      value="${creditCard.expirationDateStr}">

위의 값들이 해당하는 엔터프라이즈 빈의 속성 값들로 설정되었다는 것을 다시 한번 주목하자.

폼의 세번째 부분은 에러 메시지를 보여주거나, 조건에 맞다면 카드가 유효하다는 것을 나타내는 메시지를 보여주게 된다. 이 섹션은 두개의 태그 <c:when> 과 <c:otherwise>를 포함한다. 첫번째 태그는 카드 넘버가 null이면 에러 메시지가 프린트되는 것을 막는다.

   <c:choose>

     <c:when
      test=
       "${creditCard.number == null || creditCard.number == ''}">
       <!-- No number, so no need to complain 
         that it's not valid -->
     </c:when>

두번째 <c:when>태그는 카드가 유효할 경우 성공 메시지를 출력한다.

   <c:when test="${creditCard.valid}">
      The following card is valid:<br>
      <table border="0">
      <tr><th align="left">Name:</th>
        <td>${creditCard.name}</td>
      </tr>
      <!-- and so on... -->
   </c:when>

이 지점에서, 실제 애플리케이션은 아마도 사용자의 브라우저를 빌링 주소 정보를 수집하는 폼으로 전송하게 될 것이다. <c:if> 를 위한 테스트는 boolean이라는 것을 기억하자. 따라서 expression ${creditCard.valid}는 반드시 boolean 타입이어야 한다. 이 속성을 위해 사용되는 접근 메소드는 CreditCardLocal.isValid()이다. 왜냐하면 boolean타입의 속성을 접근하기 위한 메소드는 "get" 대신에 "is"를 사용하기 때문이다. 마지막 태그인 <c:otherwise>는 카드가 유효하지 않을 경우를 위한 것이다.

   <c:otherwise>
      <hr>
      <font color="red">This number is not valid.</font>
      <br>
      <i>Problem</i>: ${creditCard.validityMessage}<br>
      Please correct the problem and try again.
   </c:otherwise>
  </c:choose>

CreditCardLocal.getValidityMessage 는 카드가 유효하지 않은 이유를 사용자에게 친숙한 에러 메시지로 리턴한다.

이 예제의 유용한 팁은 엔터프라이즈 빈 인터페이스가 애플리케이션의 세션 혹은 다른 컨텍스트안에 저장될 수 있고, JSP EL expressions로 작성된 이름으로 검색될 수 있다는 것이다. 애플리케이션 로직이 scriptlets에 구현되고 있지 않기 때문에 이 기법을 사용하면 캡슐화를 향상시킬 수 있다. 이는 또한 JSP페이지를 생성하고 이해하고 유지하는 것을 용이하게 해준다.

샘플 코드 실행하기

샘플 아카이브를 다운로드 받자. 애플리케이션의 컨텍스트 루트는 ttfeb2004이다. 다운로드된 ear 파일은 완성된 코드도 포함하고 있다.

애플리케이션 아카이브(ttfeb2004.ear)를 deploytool프로그램이나 어드민 콘솔을 이용해서 J2EE 1.4 Application Server 에 배포할 수 있다. 또한 다음과 같이 asadmin커맨드를 직접 입력해서 배포할 수도 있다.

   asadmin deploy install_dir/ttfeb2004.ear

install_dir를 war파일을 인스톨한 디렉토리로 대체하자.

애플리케이션은http://localhost:8000/ttfeb2004에서 액세스할 수 있다.

J2EE 1.4 Application Server보다 J2EE 1.4에 맞는 구현을 하고자 한다면 플랫폼에 애플리케이션을 배포하기 위해 J2EE 프로덕트의 배포 툴을 사용하자.

이 애플리케이션을 실행하면, 다음과 같은 페이지를 보게 된다.

커스텀 태그 파일

JSP 페이지에서 엔터프라이즈 빈 사용하기

샘플 코드 실행하기

Reader Feedback