整合营销服务商

电脑端+手机端+微信端=数据同步管理

免费咨询热线：

JSP 自定义标签

自定义标签是用户定义的JSP语言元素。当JSP页面包含一个自定义标签时将被转化为servlet，标签转化为对被 称为tag handler的对象的操作，即当servlet执行时Web container调用那些操作。

JSP标签扩展可以让你创建新的标签并且可以直接插入到一个JSP页面。 JSP 2.0规范中引入Simple Tag Handlers来编写这些自定义标记。

你可以继承SimpleTagSupport类并重写的doTag()方法来开发一个最简单的自定义标签。

创建"Hello"标签

接下来，我们想创建一个自定义标签叫作<ex:Hello>，标签格式为：

<ex:Hello />

要创建自定义的JSP标签，你首先必须创建处理标签的Java类。所以，让我们创建一个HelloTag类，如下所示：

package com.runoob;

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.runoob.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.runoob;

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.runoob.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.runoob;

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.runoob.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>

.....

如果你使用了两个属性，修改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>

.....

如您还有不明白的可以在下面与我留言或是与我探讨QQ群308855039，我们一起飞！

然JSTL提供了很多丰富的标签，但是在某些情况下，这些标签还是不能够满足我们的业务需求，所以sun公司也提供了自定义标签的功能，可以根据实际业务需求创建相应的标签。自定义标签在一些很老的项目中会经常见到，因为那个时候基本上是基于Servlet和JSP进行项目的开发，为了应对自身的项目需求，每个公司都会自己创建自己的标签库，从而简化开发，提高开发效率。

自定义JSTL标签只需要下面几个步骤即可：

  1. 第一步：创建一个类，继承自SimpleTagSupport类。
  2. 第二步：重写doTag()方法，在这个方法中实现自定义标签的处理逻辑。
  3. 第三步：在WEB-INF目录下面，创建对应标签的tld描述文件。
  4. 第四步：在JSP页面中，通过<%@taglib%>指令自定义标签即可。

1.1、继承SimpleTagSupport

创建一个CustomTag类，继承自SimpleTagSupport类，重写doTag()方法。

package com.gitcode.tag;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.JspFragment;
import javax.servlet.jsp.tagext.SimpleTagSupport;
import java.io.IOException;
import java.io.StringWriter;

/**
 * 自定义JSTL标签
 */
public class CustomTag extends SimpleTagSupport {
    /**
     * 自定义标签属性
     */
    private String content;
    /**
     * 标签体内容
     */
    private StringWriter body = new StringWriter();

    public void setContent(String content) {
        this.content = content;
    }

    @Override
    public void doTag() throws JspException, IOException {
        // 1、获取输出流对象
        JspWriter writer = this.getJspContext().getOut();
        if (content == null) {
            // 属性等于空，则直接获取标签之间的body内容
            JspFragment jspBody = this.getJspBody();
            // 调用方法
            jspBody.invoke(body);
            // 输出内容
            writer.println(body.toString());
        } else {
            // 如果属性名称不为空，则输出属性名称的内容
            writer.println(content);
        }
    }
}

1.2、创建tld描述文件

在WEB-INF目录下，我们创建一个tld目录，用于保存我们自定义JSTL标签的tld描述文件，tld描述文件中，需要编写如下内容：

<?xml version="1.0" encoding="UTF-8" ?>

<taglib xmlns="http://java.sun.com/xml/ns/j2ee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
        version="2.0">

    <tlib-version>1.1</tlib-version>
    <short-name>custom_tag</short-name>

    <tag>
        <description>自定义JSTL标签的描述内容</description>
        <name>custom_tag</name>
        <tag-class>com.gitcode.tag.CustomTag</tag-class>
        <!-- 标签之间的内容是脚本 -->
        <body-content>scriptless</body-content>
        <attribute>
            <description>属性的描述内容</description>
            <name>content</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
</taglib>

如下图所示：

1.3、使用自定义标签

新建一个custom.jsp页面，使用<%@taglib%>指令引入自定义标签，如下所示：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%-- 引入标签库 --%>
<%@ taglib prefix="custom_tag" uri="WEB-INF/tld/custom_tag.tld" %>
<html>
<head>
    <title>JSTL标签库之自定义标签</title>
</head>
<body>
    <h3>JSTL标签库之自定义标签</h3>
    <custom_tag:custom_tag content="content属性内容"></custom_tag:custom_tag>

    <h3>JSTL标签库之自定义标签</h3>
    <custom_tag:custom_tag>
        <ul>
            <li>第一行</li>
            <li>第二行</li>
            <li>第三行</li>
        </ul>
    </custom_tag:custom_tag>
</body>
</html>

运行结果如下所示：

需要注意的是，prefix属性值必须和custom_tag.tld描述文件中的<short-name>标签值保持一致，否则无法引用自定义标签。

以上，就是JSTL自定义标签的使用，创建自定义标签可以将公用的代码封装起来，后续要使用的时候，可以减少代码的开发，从而提高开发效率。

今天就到这里，未完待续~~

实现自定义标签时,有时需要对标签体的内容进行处理以后再向浏览器输出，比如将小写英文字母转化为大写，将HTML标签进行转义等。为了实现这样的功能,JSP规范中它义了一个BodyTag接口，它继承自IterationTag接口，并在IterationTag接口基础上新增了两个方法和一个静态常量，具体如下。

1. EVAL_BODY_BUFFERED常量

如果标签处理器类实现了BodyTag接口，它的doStartTag()方法除了可以返回SKIP_BODY和EVAL_BODY_INCLUDE常量之外，还可以返回EVAL_BODY_BUFFERED常量。当doStartTag()方法返回EVAL_BODY_BUFFERED常量时，JSP容器将会创建个javax.servlet.jsp.tagext.BodyContent对象，使用该对象来执行标签体。关于BodyContent类的用法，将在下面进行详细的讲解。

2. setBodyContent(BodyContent b)方法

当且仅当doStartTag()方法返回EVAL_BODY_BUFFERED常量时，JSP容器才会调用setBodyContent()方法，通过该方法将BodyContent对象传递给标签处理器类使用。

3. dolnitBody()方法

JSP容器在调用setBodyContent()方法后会调用doInitBody()方法来完成些初始化工作，该方法的调用在标签体执行之前。

其中，最重要的是setBodyContent()方法。为了帮助大家更好地理解BodyTag接口处理标签内容的方式，有必要对BodyContent类进行详细讲解。

BodyContent类是JspWriter类的子类，它在JspWriter的基础上增加了一个用于存储数据的缓冲区(确切地说缓冲区是在BodyContent的子类org.apache.jasper.runtime.BodyContentImple中定义的)，当调用BodyContent对象的方法写数据时，数据将被写人到BodyContent内部的缓冲区中。

明白了BodyContent类的这个特点，就不难理解JSP容器是如何利用BodyContent对象来处理标签体内容了。当标签处理器类的doStartTag()方法返回EVAL_BODY_BUFFERED常量时，JSP容器会创建一个BodyContent对象，然后调用该对象的write()方法将标签体的内容写人BodyContent对象的缓冲区中，开发者只要能够访问BodyContent缓冲区的内容，就能对标签体的内容进行处理。在BodyContent类中定义了一些用于访问缓冲区内容的方法，具体如下表所示。

BodyContent类的常用方法

方法声明

功能描述

String getString()

以字符串的形式返回BodyContent对象缓冲区中保存的数据

Reader getReader()

返回一个关联BodyContent对象缓冲区中数据的Reader对
象，通过Reader对象可以读取缓冲区中的数据

void clearBody()

用于清空BodyContent对象缓冲区中的内容

JspWriter getEnclosingWriter()

用于返回BodyContent对象中关联的JspWriter对象。当JSP容器创建BodyContent对象后，PageContext对象中的"out"属性不再指向JSP的隐式对象，而是指向新创建的BodyContent对象。同时，在BodyContent对象中会用一个JspWriter类型的成员变量enclosingWriter记住原来的隐式对象，getEnclosingWriter()方 法返回的就是原始的JSP隐式对象

writerOut(Writer out)

用于将BodyContent对象中的内容写人到指定的输出流

在上表列举的所有方法中，其中getEnclosingWriter()方法最难理解，但是，只需要记住该方法的返回值为out即可。

除了BodyContent类外，在BodyTag接口还会涉及很多常量和方法，为了让大家更好地掌握标签处理器的执行流程，接下来通过一张图来描述，具体如下图所示。

标签处理器的执行流程

上图中清楚地描述了JSP容器执行标签处理器的过程。其中，release()方法之所以使用用虚线，是因为这个方法不会在标签处理器每次执行都被JSP容器调用，只有当标签处理器对象作为垃圾被回收之前它才会被调用。传统标签的处理器是单例的，只会被创建和销毁一次。

接下来，通过实现自定义标签，学习如何使用BodyTag接口将标签体中的小写英文字母转换为大写，具体步骤如下。

（1）编写标签处理器类ToUpperCase.java。

JSP规范中定义了一个类BodyTagSupport实现了BodyTag接口，为了简化程序的编写，标签处理器类ToUpperCase.java只需要继承BodyTagSupport类即可。ToUpperCase.java类的实现代码如下例所示。

package cn.itcast.chapter09.classisctag;
import java.io.IOException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class ToUpperCase extends BodyTagSupport {
    //定义doEndTag()方法
    public int doEndTag() throws JspException {
        //获取级冲区中数据
        String content = getBodyContent().getString();
        //将数据转为大写
        content = content.toUpperCase();
        try{
            //输出数据内容(两种方式均可)
            //pageContext.getout().write(content);
            bodyContent.getEnclosingWriter().write(content);
        } catch(IOException e){
            e.printStackTrace();
            return super.doEndTag();
        }
}

由于BodyTagSupport类中的doStartTag()方法默认返回EVAL_BODY_BUFFERED常量，JSP容器会在执行标签体之前创建BodyContent对象，然后将标签体内容通过setBodyContent()方法设置给BodyContent对象。因此在上面案例中的doEndTag()方法中可以直接使用getBodyContent()方法的getString()方法获得写人到BodyContent缓冲区中的内容，然后将其转换为大写，通过调用getEnclosingWriter()方法获取到out对象，将内容输出到浏览器中。

注意：不能直接使用doStartTag()方法的原因是，执行doStartTag()方法时，BodyContent对象中还没有缓存标签体的内容，因此通过getBodyContent()方法还无法获得标签的内容。

（2）注册标签处理器类。

在mytag.tld文件中增加一个Tag元素，对标签处理器类进行注册，注册信息如下所示。

<tag>
    <name>toUpperCase</name>
    <tag-class> cn.itcast.chapter09.classisctag.ToUpperCase</tag-class>
    <body-content>JSP</body-content>
</tag>

（3）编写JSP页面toUpperCase.jsp

在JSP页面中使用标签，在标签体中写人26个小写的英文字母，如下例所示。

<%@page language="java" pageEncoding="GBK"%>
<%@taglib uri= "http://www.itcast.cn" prefix="itcast"%>
<html>
    <head>
    <title>HelloWorld Tag</title>
</head>
<body>
    <itcast: toUpperCase>
        abcde fghij klmnopqrstuvwxyz
    </itcast:toUpperCase>
</body>
</html>

（4）启动Tomcat服务器，在浏览器地址栏中输人URL地址“http://localhost:8080/chapter09/toUpperCase.jsp”访问toUpperCase.jsp页面，从运行结果可以看出，自定义标签成功地将标签体中的小写英文字母转换为大写。


在线咨询
上一篇：CSS图像 hover 动画效果
下一篇：javascript 字符串大小写转换的方法

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。

推荐阅读
友情链接 东明县 沙河口区 本溪 灌云县 秦安县 津南区 网站制作
Copyright © 2002-2019 雨点网络设计有限公司 版权所有   冀ICP备11025394号
联系电话：   E-mail：279303980@qq.com  
主营业务：技术文章网站建设、网站定制、技术文章营销型网站建设、技术文章网站优化、技术文章微商城制作、三级分销系统开发
电话沟通
在线客服