JSP カスタムタグ

カスタムタグはユーザー定義のJSP言語要素です。JSPページにカスタムタグが含まれると、サーブレットに変換され、タグはタグハンドラーと呼ばれるオブジェクトに対する操作に変換されます。つまり、サーブレット実行時にWebコンテナがそれらの操作を呼び出します。

JSPタグ拡張は、新しいタグを作成し、JSPページに直接挿入することを可能にします。JSP 2.0仕様では、これらのカスタムタグを作成するためにSimple Tag Handlersが導入されました。

SimpleTagSupportクラスを継承し、doTag()メソッドをオーバーライドすることで、最も簡単なカスタムタグを開発できます。


「Hello」タグの作成

次に、<ex:Hello>というカスタムタグを作成したいと思います。タグの形式は次のとおりです:

<ex:Hello />

カスタムJSPタグを作成するには、まずタグを処理するJavaクラスを作成する必要があります。それでは、HelloTagクラスを次のように作成しましょう。

package com.サンプル;

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

public class HelloTag extends SimpleTagSupport {

  public void doTag() throws JspException, IOException {
    JspWriter out = getJspContext().getOut();
    out.println("Hello Custom Tag!");
  }
}

次のコードはdoTag()メソッドをオーバーライドしています。このメソッドでは、getJspContext()メソッドを使用して現在のJspContextオブジェクトを取得し、"Hello Custom Tag!"をJspWriterオブジェクトに渡しています。

上記のクラスをコンパイルし、環境変数CLASSPATHのディレクトリにコピーします。最後に、次のタグライブラリを作成します:<Tomcatインストールディレクトリ>webapps\ROOT\WEB-INF\custom.tld

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>2.0</jsp-version>
  <short-name>Example TLD</short-name>
  <tag>
    <name>Hello</name>
    <tag-class>com.サンプル.HelloTag</tag-class>
    <body-content>empty</body-content>
  </tag>
</taglib>

次に、JSPファイルでHelloタグを使用できます:

<%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
<html>
  <head>
    <title>A sample custom tag</title>
  </head>
  <body>
    <ex:Hello/>
  </body>
</html>

上記プログラムの出力結果は次のとおりです:

Hello Custom Tag!

タグ本体へのアクセス

標準タグライブラリのようにタグ内にメッセージコンテンツを含めることができます。例として、カスタムのHelloにコンテンツを含める場合、形式は次のとおりです:

<ex:Hello>
   This is message body
</ex:Hello>

タグ処理クラスファイルを次のように変更できます:

package com.サンプル;

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

public class HelloTag extends SimpleTagSupport {

   StringWriter sw = new StringWriter();
   public void doTag()
      throws JspException, IOException
    {
       getJspBody().invoke(sw);
       getJspContext().getOut().println(sw.toString());
    }

}

次に、TLDファイルを次のように変更する必要があります:

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>2.0</jsp-version>
  <short-name>Example TLD with Body</short-name>
  <tag>
    <name>Hello</name>
    <tag-class>com.サンプル.HelloTag</tag-class>
    <body-content>scriptless</body-content>
  </tag>
</taglib>

これで、変更後のタグをJSPで次のように使用できます:

<%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
<html>
  <head>
    <title>A sample custom tag</title>
  </head>
  <body>
    <ex:Hello>
        This is message body
    </ex:Hello>
  </body>
</html>

上記プログラムの出力結果は次のとおりです:

This is message body

カスタムタグの属性

カスタムタグにはさまざまな属性を設定できます。属性を受け取るには、カスタムタグクラスがsetterメソッドを実装する必要があります。JavaBeanのsetterメソッドは次のとおりです:

package com.サンプル;

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

public class HelloTag extends SimpleTagSupport {

   private String message;

   public void setMessage(String msg) {
      this.message = msg;
   }

   StringWriter sw = new StringWriter();

   public void doTag()
      throws JspException, IOException
    {
       if (message != null) {
          /* 从属性中使用消息 */
          JspWriter out = getJspContext().getOut();
          out.println( message );
       }
       else {
          /* 从内容体中使用消息 */
          getJspBody().invoke(sw);
          getJspContext().getOut().println(sw.toString());
       }
   }

}

属性の名前は"message"なので、setterメソッドはsetMessage()です。次に、TLDファイルの<attribute>要素を使用してこの属性を追加しましょう。

<taglib>
  <tlib-version>1.0</tlib-version>
  <jsp-version>2.0</jsp-version>
  <short-name>Example TLD with Body</short-name>
  <tag>
    <name>Hello</name>
    <tag-class>com.サンプル.HelloTag</tag-class>
    <body-content>scriptless</body-content>
    <attribute>
       <name>message</name>
    </attribute>
  </tag>
</taglib>

これで、JSPファイルでmessage属性を次のように使用できます:

<%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
<html>
  <head>
    <title>A sample custom tag</title>
  </head>
  <body>
    <ex:Hello message="This is custom tag" />
  </body>
</html>

上記サンプルの出力結果は次のとおりです:

This is custom tag

他にも次の属性を含めることができます:

属性説明
name属性の名前を定義します。各タグの属性名は一意でなければなりません。
required属性が必須かオプションかを指定します。falseに設定するとオプションになります。
rtexprvalue実行時式においてタグ属性が有効かどうかを宣言します。
typeその属性のJavaクラスタイプを定義します。デフォルトではString
description説明情報
fragmentこの属性が宣言されている場合、属性値は~と見なされます。JspFragment。

関連する属性の指定例は次のとおりです:

.....
    <attribute>
      <name>attribute_name</name>
      <required>false</required>
      <type>java.util.Date</type>
      <fragment>false</fragment>
    </attribute>
.....

2つの属性を使用する場合は、TLDファイルを次のように変更します:

.....
    <attribute>
      <name>attribute_name1</name>
      <required>false</required>
      <type>java.util.Boolean</type>
      <fragment>false</fragment>
    </attribute>
    <attribute>
      <name>attribute_name2</name>
      <required>true</required>
      <type>java.util.Date</type>
    </attribute>
.....
その他の拡張