JSP自定义标签库
用发和标准标签库一样.唯一不同的是,自定义标签需要自己实现哈哈!
- 把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>
1.标签(Tag):
标签是一种XML元素，通过标签可以使JSP网页变得简洁并且易于维护，还可以方便地实现同一个JSP文件支持多种语言版本。由于标签是XML元素，所以它的名称和属性都是大小写敏感的。
2.标签库(Tag library):
由一系列功能相似、逻辑上互相联系的标签构成的集合称为标签库。
3.标签库描述文件(Tag Library Descriptor):
标签库描述文件是一个XML文件，这个文件提供了标签库中类和JSP中对标签引用的映射关系。它是一个配置文件，和web.xml是类似的。
4.标签处理类(Tag Handle Class):
标签处理类是一个Java类，这个类继承了TagSupport或者扩展了SimpleTag接口，通过这个类可以实现自定义JSP标签的具体功能。
二、自定义JSP标签的格式：
1. <!-- taglib prefix=”someprefix” uri=”/sometaglib”-->
为了使到JSP容器能够使用标签库中的自定义行为，必须满足以下两个条件：
1)从一个指定的标签库中识别出代表这种自定义行为的标签
2)找到实现这些自定义行为的具体类
第一个必需条件--找出一个自定义行为属于那个标签库，是由标签指令的前缀(Taglib Directive's Prefix)属性完成，所以在同一个页面中使用相同前缀的元素都属于这个标签库。每个标签库都定义了一个默认的前缀，用在标签库的文档中或者页面中插入自定义标签。所以，你可以使用除了诸如jsp,jspx,java,servlet,sun,sunw(它们都是在JSP白皮书中指定的保留字)之类的前缀。
uri属性满足了以上的第二个要求。为每个自定义行为找到对应的类。这个uri包含了一个字符串，容器用它来定位TLD文件。在TLD文件中可以找到标签库中所有标签处理类的名称。
2. 当web应用程序启动时，容器从WEB-INF文件夹的目录结构的META-INF搜索所有以.tld结尾的文件。也就是说它们会定位所有的TLD文件。对于每个TLD文件，容器会先获取标签库的URI，然后为每个TLD文件和对应的URI创建映射关系。
在JSP页面中，我们仅需通过使用带有URI属性值的标签库指令来和具体的标签库匹配
三、自定义JSP标签的处理过程：
1.在JSP中引入标签库：
<!-- taglib prefix=”taglibprefix” uri=”tagliburi”-->
2.在JSP中使用标签库标签
3.Web容器根据第二个步骤中的prefix，获得第一个步骤中声明的taglib的uri属性值。
4.Web容器根据uri属性在web.xml找到对应的元素。
5.从元素中获得对应的元素的值。
6.Web容器根据元素的值从WEB-INF/目录下找到对应的.tld文件。
7.从.tld文件中找到与tagname对应的元素。
8.从元素中获得对应的元素的值。
9.Web容器根据元素的值创建相应的tag handle class的实例。
10. Web容器调用这个实例的doStartTag/doEndTag方法完成相应的处理。
四、创建和使用一个Tag Library的基本步骤：
1.创建标签的处理类(Tag Handler Class);
2.创建标签库描述文件(Tag Library Descrptor File);
3.在web.xml文件中配置元素 4.在JSP文件中引人标签库。
五、TagSupport类简介：
1.处理标签的类必须扩展javax.servlet.jsp.TagSupport;
2.TagSupport类的主要属性：
A.parent属性：代表嵌套了当前标签的上层标签的处理类
B.pageContex属性：代表Web应用中的javax.servlet.jsp.PageContext对象
3.JSP容器在调用doStartTag或者doEndTag方法前，会先调用setPageContext和setParent方法，设置pageContext和parent。因此在标签处理类中可以直接访问pageContext变量;
4.在TagSupport的构造方法中不能访问pageContext成员变量，因为此时JSP容器还没有调用setPageContext方法对pageContext进行初始化。
六、TagSupport处理标签的方法：
1.TagSupport类提供了两个处理标签的方法：
public int doStartTag() throws JspException
public int doEndTag() throws JspException
2.doStartTag：当JSP容器遇到自定义标签的起始标志，就会调用doStartTag()方法。
doStartTag()方法返回一个整数值，用来决定程序的后续流程。
A.Tag.SKIP_BODY：表示标签之间的内容被忽略;
B.Tag.EVAL_BODY_INCLUDE：表示标签之间的内容被正常执行;
3.doEndTag：但JSP容器遇到自定义标签的结束标志，就会调用doEndTag()方法。doEndTag()方法也返回一个整数值，用来决定程序后续流程。
A.Tag.SKIP_PAGE：表示立刻停止执行网页，网页上未处理的静态内容和JSP程序均被忽略任何已有的输出内容立刻返回到客户的浏览器上。
B.Tag_EVAL_PAGE：表示按照正常的流程继续执行JSP网页
七、用户自定义的标签属性：
如果在标签中还包含了自定义的属性，那么在标签处理类中应该将这个属性作为成员变量，并且分别提供设置和读取属性的方法。
八、创建标签处理类的步骤：
1.创建包含JSP网页静态文本的文件(即是要替换自定义JSP标签的文本)
2.在Web应用启动时装载静态文本
3.创建标签处理类
九、如何创建包含JSP网页静态文本的文件：
1.使用java.util.Properties类来存放要替换网页中自定义JSP标签的静态文本
2.Properties类代表了一系列属性的集合，其实例既可以被保存到流中，也可以从流中加载。这些文本以key/value的形式存放在WEB-INF目录下，例如key=value，在属性列表中这些key/value都是String类型的
十、Properties类的常用API：
1.setProperty(String key, String value)：调用Hashtable类的put方法添加属性
2.getProperty(String key)：获取属性列表中key对应的属性值
3.load(InputStream in)：从输入流对象InputStream中读取属性列表(Properties list)
4.store(OutputStream out,String coMMent)：使用适当的格式将属性列表的属性对写入输出流对象中，默认使用ISO-88590-1编码格式,以行的方式处理输入。属性的 key/value之间以”=、:”配对，以回车、换行分隔key/value配对。