JSP Benutzerdefinierte Tags
Benutzerdefinierte Tags sind vom Benutzer definierte JSP-Sprachelemente. Wenn eine JSP-Seite ein benutzerdefiniertes Tag enthält, wird sie in ein Servlet umgewandelt, und das Tag wird in Operationen auf ein Objekt namens Tag-Handler umgewandelt, d. h., wenn das Servlet ausgeführt wird, ruft der Web-Container diese Operationen auf.
JSP-Tag-Erweiterungen ermöglichen es Ihnen, neue Tags zu erstellen, die direkt in eine JSP-Seite eingefügt werden können. Die JSP-2.0-Spezifikation führte Simple Tag Handlers ein, um diese benutzerdefinierten Tags zu schreiben.
Sie können die SimpleTagSupport-Klasse erweitern und die doTag()-Methode überschreiben, um ein einfaches benutzerdefiniertes Tag zu entwickeln.
Erstellen des "Hello"-Tags
Als Nächstes möchten wir ein benutzerdefiniertes Tag namens <ex:Hello> erstellen, mit folgendem Tag-Format:
<ex:Hello />
Um ein benutzerdefiniertes JSP-Tag zu erstellen, müssen Sie zuerst eine Java-Klasse erstellen, die das Tag verarbeitet. Erstellen wir also eine HelloTag-Klasse wie folgt:
package com.example;
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!");
}
}
Der folgende Code überschreibt die doTag()-Methode, die die getJspContext()-Methode verwendet, um das aktuelle JspContext-Objekt abzurufen, und übergibt "Hello Custom Tag!" an das JspWriter-Objekt.
Kompilieren Sie die obige Klasse und kopieren Sie sie in das Verzeichnis in der Umgebungsvariablen CLASSPATH. Erstellen Sie schließlich die folgende Tag-Bibliothek: <Tomcat-Installationsverzeichnis>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.example.HelloTag</tag-class>
<body-content>empty</body-content>
</tag>
</taglib>
Als Nächstes können wir das Hello-Tag in einer JSP-Datei verwenden:
<%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
<html>
<head>
<title>A sample custom tag</title>
</head>
<body>
<ex:Hello/>
</body>
</html>
Das obige Programm gibt das folgende Ergebnis aus:
Hello Custom Tag!
Zugriff auf den Tag-Body
Sie können Nachrichteninhalt in einem Tag einschließen, genau wie in der Standard-Tag-Bibliothek. Wenn wir beispielsweise Inhalt in unser benutzerdefiniertes Hello-Tag aufnehmen möchten, lautet das Format wie folgt:
<ex:Hello> This is message body </ex:Hello>
Wir können die Klassendatei des Tag-Handlers ändern; der Code lautet wie folgt:
package com.example;
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());
}
}
Als Nächstes müssen wir die TLD-Datei wie unten gezeigt ändern:
<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.example.HelloTag</tag-class>
<body-content>scriptless</body-content>
</tag>
</taglib>
Jetzt können wir das geänderte Tag in JSP wie unten gezeigt verwenden:
<%@ 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>
Das obige Programm gibt das folgende Ergebnis aus:
This is message body
Benutzerdefinierte Tag-Attribute
Sie können verschiedene Attribute für benutzerdefinierte Tags festlegen. Um Attribute zu empfangen, muss die benutzerdefinierte Tag-Klasse Setter-Methoden implementieren. Die Setter-Methoden in JavaBean lauten wie folgt:
package com.example;
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());
}
}
}
Der Attributname ist "message", daher ist die Setter-Methode setMessage(). Fügen wir nun dieses Attribut mit dem <attribute>-Element zur TLD-Datei hinzu:
<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.example.HelloTag</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>message</name>
</attribute>
</tag>
</taglib>
Jetzt können wir das message-Attribut in einer JSP-Datei wie folgt verwenden:
<%@ 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>
Das obige Beispiel gibt das folgende Ergebnis aus:
This is custom tag
Sie können auch die folgenden Attribute angeben:
| Attribute | Beschreibung |
|---|---|
| name | Definiert den Namen des Attributs. Der Attributname jedes Tags muss eindeutig sein. |
| required | Gibt an, ob das Attribut erforderlich oder optional ist. Wenn es auf false gesetzt ist, ist es optional. |
| rtexprvalue | Gibt an, ob das Tag-Attribut gültig ist, wenn Laufzeitausdrücke ausgewertet werden. |
| type | Definiert den Java-Klassentyp des Attributs. Der Standardwert ist angegeben alsString |
| description | Beschreibungsinformationen |
| fragment | Wenn dieses Attribut deklariert ist, wird der Attributwert als einJspFragment behandelt。 |
Das Folgende ist ein Beispiel für die Angabe zugehöriger Attribute:
.....
<attribute>
<name>attribute_name</name>
<required>false</required>
<type>java.util.Date</type>
<fragment>false</fragment>
</attribute>
.....
Wenn Sie zwei Attribute verwenden, ändern Sie die TLD-Datei wie unten gezeigt:
.....
<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>
.....
Andere Erweiterungen