Java Web笔记 - 客户化JSP标签库自定义标签 | Servlet&JSP,Tag

1、客户化JSP标签库：

客户化JSP标签技术是在JSP1.1版本中出现的，支持用户在JSP文件中自定义标签，从而使JSP代码更加简洁。

这些可重用的标签能处理复杂的逻辑运算和事务，或者定义JSP网页的输出内容和格式。

2、实现自定义标签的相关API：

Servlet容器编译JSP网页时，如果遇到自定义标签，就会调用这个标签的处理类。

标签处理类必须扩展以下两个类之一：

javax.servlet.jsp.tagext.TagSupport javax.servlet.jsp.tagext.BodyTagSupport

public class TagSupport
extends Object
implements IterationTag, Serializable

A base class for defining new tag handlers implementing Tag.

几个重要的方法：

setValue
public void setValue(String k,
Object o)

Associate a value with a String key.

Parameters:
k - The key String.
o - The value to associate.

在标签处理类中设置key/value

getValue
public Object getValue(String k)

Get a the value associated with a key.

Parameters:
k - The string key.

Returns:
The value associated with the key, or null.

在标签处理类中根据参数key返回匹配的value

removeValue
public void removeValue(String k)

Remove a value associated with a key.

Parameters:
k - The string key.

在标签处理类中删除key/value

setPageContext
public void setPageContext(PageContext pageContext)

Set the page context.

Specified by:
setPageContext in interface Tag

Parameters:
pageContext - The PageContext.

See Also:
Tag.setPageContext(javax.servlet.jsp.PageContext)

设置PageContext对象，该方法由Servlet容器在调用doStartTag或doEndTag方法前调用

setParent
public void setParent(Tag t)

Set the nesting tag of this tag.

Specified by:
setParent in interface Tag

Parameters:
t - The parent Tag.

See Also:
Tag.doEndTag()

当Servlet容器遇到自定义标签的结束标志，就会调用doEndTag方法。

doEndTag返回一个整数值，用来决定程序后续流程，有两个可选值：

**Tag.SKIP_PAGE：**立刻停止执行网页，网页上未被处理的静态内容和JSP程序均被忽略，任何已有的输出内容立刻返回到客户的浏览器上。 **Tag.EVAL_PAGE：**按照正常的流程继续执行JSP页面。

两个重要的属性：

pageContext
protected PageContext pageContext
The PageContext.

代表Web应用中的javax.servlet.jsp.PageContext对象

PageContext对象提供了访问ServletContext，Request和Session的方法。

parent：代表嵌套了当前标签的上层标签的处理类

JSP容器在调用doStartTag或doEndTag方法前，先调用setPageContext和setParent方法，设置pageContext和parent。

在doStartTag或doEndTag方法中可以通过getParent方法获取上层标签的处理类。在TagSupport类中定义了protected类型的pageContext成员变量，因此在标签处理类中可以直接访问pageContext变量。

PageContext的两个访问Web应用的共享数据的方法：

public void setAttribute(String name, Object value, int scope)
public void getAttribute(String name , int scope)

public class BodyTagSupport
extends TagSupport
implements BodyTag
A base class for defining tag handlers implementing BodyTag.

3、自定义标签属性：

在标签处理类中应该将这个属性作为成员变量，并提供setter和getter方法。

4、创建客户化JSP标签的步骤：

创建标签的处理类

public class MyTag extends TagSupport {

@Override
public int doStartTag() throws JspException {
    try {
        this.pageContext.getOut().println("这是标签的起始处理输出结果");
    } catch (IOException e) {
        e.printStackTrace();
    }
    return this.EVAL_BODY_INCLUDE;
}

@Override
public int doEndTag() throws JspException {
    try {
        this.pageContext.getOut().println("这是标签的结束处理输出结果");
    } catch (IOException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();
    }
    return this.EVAL_PAGE;
}

}

创建标签库描述文件

标签库描述文件后缀名是：.tld

必须保存在WEB-INF目录下。

1.0

1.1

myTag

/myTag

<tag>
    <name>myTag</name>
    <tag-class>com.itzhai.tag.MyTag</tag-class>
    <body-content>empty</body-content>
</tag>

在JSP文件中引入标签库

<%@ taglib uri="/myTag" prefix="pre" %>

使用标签

pre:myTag/

5、创建一个带有属性的自定义标签：

创建标签的处理类

public class MyTag2 extends TagSupport {

private String name;
public String getName() {
    return name;
}
public void setName(String name) {
    this.name = name;
}
@Override
public int doEndTag() throws JspException {

    try {
        this.pageContext.getOut().println(name);
    } catch (IOException e) {
        e.printStackTrace();
    }
    return this.EVAL_PAGE;
}

}

创建标签库描述文件

1.0

1.1

myTag

/myTag

<tag>
    <name>myTag</name>
    <tag-class>com.itzhai.tag.MyTag</tag-class>
    <body-content>empty</body-content>
</tag>

<tag>
    <name>myTag2</name>
    <tag-class>com.itzhai.tag.MyTag2</tag-class>
    <body-content>empty</body-content>
    <attribute>
        <name>name</name>
        <required>true</required>
    </attribute>
</tag>

使用自定义标签：

<%@ taglib uri="/myTag" prefix="pre" %>
<pre:myTag2 name="user1"/>