JSP Etiquetas personalizadas

Las etiquetas personalizadas de JSP son elementos del lenguaje JSP definidos por el usuario. Cuando una página JSP contiene una etiqueta personalizada, se convierte en un servlet; la etiqueta se convierte en operaciones sobre un objeto llamado tag handler, es decir, cuando el servlet se ejecuta, el contenedor web invoca esas operaciones.

La extensión de etiquetas JSP te permite crear nuevas etiquetas e insertarlas directamente en una página JSP. La especificación JSP 2.0 introdujo los Simple Tag Handlers para escribir estas etiquetas personalizadas.

Puedes heredar la clase SimpleTagSupport y sobrescribir el método doTag() para desarrollar una etiqueta personalizada muy sencilla.


Crear la etiqueta "Hello"

A continuación, queremos crear una etiqueta personalizada llamada <ex:Hello>, con el siguiente formato:

<ex:Hello />

Para crear una etiqueta JSP personalizada, primero debes crear una clase Java que maneje la etiqueta. Entonces, creemos una clase HelloTag, como se muestra a continuación:

package com.ejemplo;

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!");
  }
}

El siguiente código sobrescribe el método doTag(), que usa el método getJspContext() para obtener el objeto JspContext actual y pasa "Hello Custom Tag!" al objeto JspWriter.

Compila la clase anterior y cópiala en el directorio de la variable de entorno CLASSPATH. Finalmente, crea la siguiente biblioteca de etiquetas: <directorio de instalación de 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.ejemplo.HelloTag</tag-class>
    <body-content>empty</body-content>
  </tag>
</taglib>

A continuación, podemos usar la etiqueta Hello en el archivo JSP:

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

El resultado de salida del programa anterior es:

Hello Custom Tag!

Acceder al cuerpo de la etiqueta

Puedes incluir contenido de mensaje dentro de la etiqueta, como en la biblioteca de etiquetas estándar. Por ejemplo, si queremos incluir contenido en nuestra etiqueta Hello personalizada, el formato es el siguiente:

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

Podemos modificar el archivo de la clase de manejo de etiquetas, con el siguiente código:

package com.ejemplo;

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());
    }

}

A continuación, debemos modificar el archivo TLD, como se muestra a continuación:

<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.ejemplo.HelloTag</tag-class>
    <body-content>scriptless</body-content>
  </tag>
</taglib>

Ahora podemos usar la etiqueta modificada en JSP, como se muestra a continuación:

<%@ 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>

El resultado de salida del programa anterior es el siguiente:

This is message body

Atributos de etiquetas personalizadas

Puedes establecer varios atributos en las etiquetas personalizadas; para recibir atributos, la clase de la etiqueta personalizada debe implementar métodos setter. Los métodos setter en JavaBean son como se muestra a continuación:

package com.ejemplo;

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());
       }
   }

}

El nombre del atributo es "message", así que el método setter es setMessage(). Ahora agreguemos este atributo usando el elemento <attribute> en el archivo 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.ejemplo.HelloTag</tag-class>
    <body-content>scriptless</body-content>
    <attribute>
       <name>message</name>
    </attribute>
  </tag>
</taglib>

Ahora podemos usar el atributo message en el archivo JSP, como se muestra a continuación:

<%@ 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>

El resultado de salida del ejemplo anterior es:

This is custom tag

También puedes incluir los siguientes atributos:

AtributoDescripción
nameDefine el nombre del atributo. El nombre del atributo de cada etiqueta debe ser único.
requiredEspecifica si el atributo es obligatorio u opcional; si se establece en false, es opcional.
rtexprvalueDeclara si el atributo de la etiqueta es válido cuando se evalúa una expresión en tiempo de ejecución.
typeDefine el tipo de clase Java del atributo. Por defecto se especifica comoString
descriptionInformación de descripción
fragmentSi se declara este atributo, el valor del atributo se tratará como unJspFragment。

Los siguientes son ejemplos de atributos relacionados especificados:

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

Si usas dos atributos, modifica el archivo TLD como se muestra a continuación:

.....
    <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>
.....
Otras extensiones