JSP自定义标签库

最新推荐文章于 2022-07-08 08:37:09 发布

转载最新推荐文章于 2022-07-08 08:37:09 发布 · 3.8k 阅读

文章标签：

#jsp #include #java #encoding #数据库 #class

学习专栏收录该内容

61 篇文章

订阅专栏

本文详细介绍了如何实现自定义JSP标签库，包括Tag、IterationTag及BodyTag等接口的具体实现方式，并通过示例代码展示了HelloTag标签的创建过程。

用发和标准标签库一样.唯一不同的是,自定义标签需要自己实现哈哈!

自定义标签库分为传统标签,简单标签,和标签文件.三者区别在于一个比一个简单.实现细节大致相同.实现原理也大致相同.下面简单说说实现过程.

Tag接口:普通标签体接口.继承与JspTag.

把pageContext传给自己实现的标签类.
设置标签的属性.(标签体被镶套,则调用setParent方法设置父标签)
执行doStartTag方法.然后根据这个方法的返回值判断程序的走向
- EVAL_BODY_INCLUDE :把标签体输出到流中.
- SKIP_BODY:忽略标签体
执行doEndTag方法.返回两种值 EVAL_PAGE 和 SKIP_PAGE 表示执行剩下的jsp代码还是忽略剩下的jsp代码.
容器缓存标签实例.遇到同样的标签,则重复使用缓存的标签体.释放标签体.调用release()方法.

IterationTag接口:用于循环实现的接口,这个接口继承于Tag接口.新增了一个方法doAfterBody()和一个返回值的常量EVAL_BODY_AGAIN.

把pageContext传给自己实现的标签类.
设置标签的属性.(标签体被镶套,则调用setParent方法设置父标签)
执行doStartTag方法.然后根据这个方法的返回值判断程序的走向.
- EVAL_BODY_INCLUDE :执行标签体
- SKIP_BODY:忽略标签体
如果上一部返回EVAL_BODY_INCLUDE,那么执行这一步.调用的方法是doAfterBody().返回:(注意,不管返回是什么,这个标签已经执行了一次.类似于do..while循环)
- EVAL_BODY_AGAIN:表示重复执行标签体.
- SKIP_BODY:不执行标签体.进入下一步.
容器缓存标签实例.遇到同样的标签,则重复使用缓存的标签体释放标签体.调用release()方法.

BodyTag接口:继承于IterationTag接口,新增两个方法

setBodyContent():设置bodyContent属性.对于空标签,该方法不会被调用.如果doStartTag()方法返回为SKIP_BODY或者EVAL_BODY_INCLUDE也不会被调用
doInitBody():在setBodyContent()方法调用后,标签体第一次被执行之前,该方法调用.
EVAL_BODY_BUFFERED返回值.只有实现了BodyTag接口,并且在doStartTag()方法中才能返回该值.

执行流程:

把pageContext传给自己实现的标签类.
设置标签的属性.(标签体被镶套,则调用setParent方法设置父标签)
执行doStartTag方法.然后根据这个方法的返回值判断程序的走向.
- EVAL_BODY_INCLUDE :执行标签体.
- SKIP_BODY:忽略标签体
- EVAL_BODY_BUFFERED:标签体不为空,进入下一步.
调用setBodyContent(),如果第一次执行再调用doInitBody().
调用doAfterBody().
- EVAL_BODY_AGAIN:表示重复执行标签体
- SKIP_BODY:不执行标签体.进入下一步.
容器缓存标签实例.遇到同样的标签,则重复使用缓存的标签体.
释放标签体.调用release()方法.

api已经有抽象类大致实现了以上步骤,只需重写几个自己需要的方法即可.TagSupport实现了IterationTag接口,BodyTagSupport实现了BodyTag接口.

简单标签则SimpleTagSupport实现继承于JspTag的SimpleTag接口.只需重写doTag方法就可完成简单的功能.

想要使用自己写好的标签还需要定义tld标签描述文件,然后在jsp页面引用.

标签以jar包形式出现,则标签必须放到META-INF目录或其子目录下.如果标签直接部署在web程序中,则标签描述文件必须在WEB-INF目录或其子目录下.

标签文件以 .tag 文件形式出现.以<% %>形式来完成功能,并且不用部署,写好后直接在jsp页面引用即可.

一、Java文件：

package firsttag;

import java.io.IOException;

import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;

public class HelloTag implements Tag {
private PageContext pageContext;
private Tag parent;

public HelloTag() {
   super();
}

/**
* 
*设置标签的页面的上下文
*/

public void setPageContext(final PageContext pageContext) {
   this.pageContext = pageContext;
}

/**
* 
*设置上一级标签
*/

public void setParent(final Tag parent) {
   this.parent = parent;
}

/**
* 
*开始标签时的操作
*/

public int doStartTag() throws JspTagException {

   try {
    pageContext.getOut().println("Hello World!你好， 世界！<br/>");
   } catch (java.io.IOException e) {
    throw new JspTagException("IO Error: " + e.getMessage());
   }
   return SKIP_BODY; // 返回SKIP_BODY，表示不计算标签体
}

/**
* 
*结束标签时的操作
*/

public int doEndTag() throws JspTagException {

   try {
    pageContext.getOut().write("Hello Java World!你好，Java 世界！");
   } catch (IOException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
   }
   return EVAL_PAGE;
}

/**
* 
*release用于释放标签程序占用的资源，比如使用了数据库，那么应该关闭这个连接。
*/

public void release() {
}

public Tag getParent() {
   return parent;
}
}

二、tld文件：

<?xml version="1.0" encoding="ISO-8859-1" ?>
<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 web-jsptaglibrary_2_0.xsd"
version="2.0">
<tlib-version>1.0</tlib-version>
<jsp-version>2.0</jsp-version>
<description>this si....</description>
<short-name>myT</short-name>
<uri>http://leisure/taglib</uri>

<tag>
   <description>Extends TagSupport</description>
   <name>hello</name>
   <tag-class>firsttag.HelloTag</tag-class>
   <body-content>jsp</body-content>
</tag>

</taglib>

三、JSP文件：

<%@ taglib uri="/mytld.tld" prefix="mytag"%>
<%@ page contentType="text/html ; charset=gb2312"%>

<html>
<head>
   <title>first cumstomed tag</title>
</head>
<body>
   <p>
    以下的内容从Taglib中显示：
   </p>
    <mytag:hello/>
</body>
</html>