JSP Balises personnalisées
Les balises personnalisées sont des éléments du langage JSP définis par l'utilisateur. Lorsqu'une page JSP contient une balise personnalisée, elle est transformée en servlet, et la balise est transformée en opérations sur un objet appelé gestionnaire de balise, c'est-à-dire que lorsque le servlet s'exécute, le conteneur Web invoque ces opérations.
Les extensions de balises JSP vous permettent de créer de nouvelles balises qui peuvent être insérées directement dans une page JSP. La spécification JSP 2.0 a introduit les Simple Tag Handlers pour écrire ces balises personnalisées.
Vous pouvez étendre la classe SimpleTagSupport et remplacer la méthode doTag() pour développer une balise personnalisée simple.
Création de la balise "Hello"
Ensuite, nous voulons créer une balise personnalisée appelée <ex:Hello>, avec le format de balise comme suit :
<ex:Hello />
Pour créer une balise JSP personnalisée, vous devez d'abord créer une classe Java qui gère la balise. Donc, créons une classe HelloTag comme suit :
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!");
}
}
Le code suivant remplace la méthode doTag(), qui utilise la méthode getJspContext() pour obtenir l'objet JspContext actuel et transmet "Hello Custom Tag!" à l'objet JspWriter.
Compilez la classe ci-dessus et copiez-la dans le répertoire de la variable d'environnement CLASSPATH. Enfin, créez la bibliothèque de balises suivante : <répertoire d'installation 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.example.HelloTag</tag-class>
<body-content>empty</body-content>
</tag>
</taglib>
Ensuite, nous pouvons utiliser la balise Hello dans un fichier JSP :
<%@ taglib prefix="ex" uri="WEB-INF/custom.tld"%>
<html>
<head>
<title>A sample custom tag</title>
</head>
<body>
<ex:Hello/>
</body>
</html>
Le programme ci-dessus produit le résultat suivant :
Hello Custom Tag!
Accès au corps de la balise
Vous pouvez inclure du contenu de message à l'intérieur d'une balise, tout comme dans la bibliothèque de balises standard. Par exemple, si nous voulons inclure du contenu dans notre balise Hello personnalisée, le format est le suivant :
<ex:Hello> This is message body </ex:Hello>
Nous pouvons modifier le fichier de classe du gestionnaire de balises, le code est le suivant :
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());
}
}
Ensuite, nous devons modifier le fichier TLD comme indiqué ci-dessous :
<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>
Maintenant, nous pouvons utiliser la balise modifiée dans JSP comme indiqué ci-dessous :
<%@ 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>
Le programme ci-dessus produit le résultat suivant :
This is message body
Attributs de balise personnalisée
Vous pouvez définir divers attributs sur des balises personnalisées. Pour recevoir des attributs, la classe de balise personnalisée doit implémenter des méthodes setter. Les méthodes setter dans JavaBean sont les suivantes :
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());
}
}
}
Le nom de l'attribut est "message", donc la méthode setter est setMessage(). Ajoutons maintenant cet attribut au fichier TLD à l'aide de l'élément <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.example.HelloTag</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>message</name>
</attribute>
</tag>
</taglib>
Maintenant, nous pouvons utiliser l'attribut message dans un fichier JSP comme suit :
<%@ 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>
L'exemple ci-dessus produit le résultat suivant :
This is custom tag
Vous pouvez également inclure les attributs suivants :
| Attribut | Description |
|---|---|
| name | Définit le nom de l'attribut. Le nom d'attribut de chaque balise doit être unique. |
| required | Spécifie si l'attribut est obligatoire ou facultatif. S'il est défini sur false, il est facultatif. |
| rtexprvalue | Déclare si l'attribut de balise est valide lors de l'évaluation d'expressions d'exécution. |
| type | Définit le type de classe Java de l'attribut. La valeur par défaut est spécifiée commeString |
| description | Informations de description |
| fragment | Si cet attribut est déclaré, la valeur de l'attribut sera traitée comme unJspFragment。 |
Voici un exemple de spécification d'attributs associés :
.....
<attribute>
<name>attribute_name</name>
<required>false</required>
<type>java.util.Date</type>
<fragment>false</fragment>
</attribute>
.....
Si vous utilisez deux attributs, modifiez le fichier TLD comme indiqué ci-dessous :
.....
<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>
.....
Autres extensions