程序博客网 > 闻战网络歌手

JSP自定义标签实现过程

来源：互联网 发布：闻战网络歌手 编辑：程序博客网 时间：2024/05/22 16:40

浅谈JSP自定义标签实现过程

2009-07-06 16:20 忧郁王子 CSDN 我要评论(0) 字号：T | T
一键收藏，随时查看，分享好友！

本文将通过自定义标签显示日期为例，简单谈谈JSP自定义标签实现过程。包括没有正文的JSP自定义标签实现、没有正文的但带有属性的JSP自定义标签标签实现等等内容。

AD： 2013大数据全球技术峰会课程PPT下载

(一) 没有正文的JSP自定义标签实现

(1):定义JSP自定义标签处理类

  1. import java.io.IOException;  
  2. import java.util.Date;  
  3. import javax.servlet.http.HttpServletRequest;  
  4. import javax.servlet.jsp.JspException;  
  5. import javax.servlet.jsp.JspWriter;  
  6. import javax.servlet.jsp.tagext.Tag;  
  7. import javax.servlet.jsp.tagext.TagSupport;  
  8. //无正文标签类继承的是TagSupport类 实现的接口是Tag。 如果有正文的标签类继承的是BodyTagSupport类 实现的接口是BodyTag  
  9. public class DateTagNoBody extends TagSupport {  
  10.  @Override  
  11.  public int doStartTag() throws JspException {  
  12.   HttpServletRequest request;  
  13.   // 是TagSupport类中定义的一个属性，它是javax.servlet.jsp.PageContext的对象  
  14.   request = (HttpServletRequest) pageContext.getRequest();  
  15.   java.text.SimpleDateFormat formater = new java.text.SimpleDateFormat("yyyy-MM-dd");  
  16.   String date = formater.format(new Date());  
  17.   JspWriter out = pageContext.getOut();  
  18.   try {  
  19.    out.print(date);  
  20.   } catch (IOException e) {  
  21.    e.printStackTrace();  
  22.   }  
  23.   // doStartTag() 方法返回 SKIP_BODY 。当然其原因是我们的简单日期标记没有正文。  
  24.   return Tag.SKIP_BODY;  
  25.  }  
  26. } 

(2) 定义tld文件

  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <taglib> 
  3.    <tlibversion>1.0</tlibversion> 
  4.    <jspversion>1.1</jspversion> 
  5.   <tag> 
  6.     <name>displayDate</name> 
  7.     <tagclass>cn.com.chenlly.tag.DateTagNoBody</tagclass> 
  8.     <bodycontent>empty</bodycontent> 
  9.   </tag>           
  10. </taglib> 

(3) JSP页面动态引用

  1. <%@ page language="java" pageEncoding="UTF-8"%> 
  2. <%@ taglib uri="/WEB-INF/datetag.tld" prefix="c"%> 
  3. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
  4. <html> 
  5.   <head> 
  6.   </head> 
  7.   <body> 
  8.    <c:displayDate/> 
  9.   </body> 
  10. </html> 

注意：动态引用和静态引用的区别。

为了进行静态引用，首先必须将下面的项加入到web.xml 文件中：

  1. <?xml version="1.0" encoding="ISO-8859-1" ?> 
  2. <Web-app>         
  3.    <taglib> 
  4.       <taglib-uri>myTags</taglib-uri> 
  5.       <taglib-location>/WEB-INF/lib/DateTagLib.tld</taglib-location> 
  6.    </taglib>                 
  7. </Web-app> 

然后，将JSP 声明加入到所有需要使用自定义标记库的页面中：

  1. <%@ taglib uri="myTags" prefix="c" %> 

指定的uri 属性与在web.xml 文件中指定的taglib-uri 值相匹配。

在进行标记库的静态引用时，JSP 声明必须查询 web.xml 文件以执行库查询。这意味着如果移动或者重命名了库，或者希望在 web.xml 文件中加入更多的库，就必须停止服务器、更新 web.xml 文件、然后重新启动服务器。动态方法让JSP页直接指向 TLD 位置，因而是在解释JSP页面时进行处理。

(二)  没有正文的但带有属性的JSP自定义标签标签实现

(1):定义JSP自定义标签处理类

  1. import java.io.IOException;  
  2. import java.util.Date;  
  3. import javax.servlet.http.HttpServletRequest;  
  4. import javax.servlet.jsp.JspException;  
  5. import javax.servlet.jsp.JspWriter;  
  6. import javax.servlet.jsp.tagext.Tag;  
  7. import javax.servlet.jsp.tagext.TagSupport;  
  8. //无正文标签类继承的是TagSupport类 实现的接口是Tag。 如果有正文的标签类继承的是BodyTagSupport类 实现的接口是BodyTag  
  9. public class DateTagNoBody extends TagSupport {  
  10.    
  11.  private String pattern;  
  12.  @Override  
  13.  public int doStartTag() throws JspException {  
  14.   HttpServletRequest request;  
  15.   // 是TagSupport类中定义的一个属性，它是javax.servlet.jsp.PageContext的对象  
  16.   request = (HttpServletRequest) pageContext.getRequest();  
  17.   java.text.SimpleDateFormat formater = new java.text.SimpleDateFormat(pattern);  
  18.   String date = formater.format(new Date());  
  19.   JspWriter out = pageContext.getOut();  
  20.   try {  
  21.    out.print(date);  
  22.   } catch (IOException e) {  
  23.    e.printStackTrace();  
  24.   }  
  25.   // doStartTag() 方法返回 SKIP_BODY 。当然其原因是我们的简单日期标记没有正文。  
  26.   return Tag.SKIP_BODY;  
  27.  }  
  28.    
  29.  //必须实现setXX()方法  
  30.  public void setPattern(String pattern){  
  31.   this.pattern = pattern;  
  32.  }  
  33. } 

(2) 定义tld文件

  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <taglib>  
  3.    <tlibversion>1.0</tlibversion>  
  4.    <jspversion>1.1</jspversion>  
  5.   <tag>  
  6.     <name>displayDate</name>  
  7.     <tagclass>cn.com.chenlly.tag.DateTagNoBody</tagclass>  
  8.     <bodycontent>empty</bodycontent>  
  9.     <!-- 定义属性 -->  
  10.     <attribute>  
  11.        <name>pattern</name> <!-- 属性名字 -->  
  12.        <type>String</type>  <!-- 属性类型 -->  
  13.        <requried>false</requried> <!-- 是否必须 -->  
  14.        <rtexprvale>false</rtexprvale> <!-- 表示是否可以使用JSP表达式  -->  
  15.   </attribute>  
  16.   </tag>  
  17. </taglib> 

(3)JSP页面动态引用

  1. <%@ page language="java" pageEncoding="UTF-8"%> 
  2. <%@ taglib uri="/WEB-INF/datetag.tld" prefix="c"%> 
  3. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
  4. <html> 
  5.   <head> 
  6.   </head> 
  7.   <body> 
  8.    <c:displayDate pattern='yyyy-MM-dd'/> 
  9.    </br> 
  10.    <c:displayDate pattern='MM/dd HH:mm:ss'/> 
  11.   </body> 
  12. </html> 

(三) 有正文的且带有属性的JSP自定义标签实现

(1):定义JSP自定义标签处理类

  1. import java.io.IOException;  
  2. import java.util.Date;  
  3. import javax.servlet.http.HttpServletRequest;  
  4. import javax.servlet.jsp.JspException;  
  5. import javax.servlet.jsp.JspWriter;  
  6. import javax.servlet.jsp.tagext.BodyContent;  
  7. import javax.servlet.jsp.tagext.BodyTagSupport;  
  8.  
  9. public class BodyTag extends BodyTagSupport {  
  10.    
  11.  private int count;  
  12.  
  13.  private HttpServletRequest reqeust;  
  14.  
  15.  private JspWriter out;  
  16.  
  17.    
  18.  public void init() {  
  19.   reqeust = (HttpServletRequest) pageContext.getRequest();  
  20.   out = pageContext.getOut();  
  21.  }  
  22.  
  23.  @Override  
  24.  public int doStartTag() throws JspException {  
  25.   init();  
  26.   return this.EVAL_BODY_INCLUDE;  
  27.  }  
  28.    
  29.  //设置当前标签体  
  30.  @Override  
  31.  public void setBodyContent(BodyContent bodyContent) {  
  32.   this.bodyContent = bodyContent;  
  33.   System.out.println("setBodyContent...");   
  34.  }  
  35.    
  36.  
  37. //需要初始化bodyContent  
  38.  @Override  
  39.  public void doInitBody() throws JspException {  
  40.   System.out.println("init.....");  
  41.  }   
  42.  
  43.  
  44.  @Override  
  45.  public int doAfterBody() throws JspException {  
  46.   if (count >= 1) {  
  47.    try {  
  48.     out.println(count);  
  49.     out.println("<Br>");  
  50.    } catch (IOException e) {  
  51.     e.printStackTrace();  
  52.    }  
  53.    count --;  
  54.    return this.EVAL_BODY_AGAIN;  
  55.   } else {  
  56.    return this.SKIP_BODY;  
  57.   }  
  58.  }  
  59.  
  60.  @Override  
  61.  public int doEndTag() throws JspException {  
  62.   java.text.SimpleDateFormat formater = new java.text.SimpleDateFormat(  
  63.     "yyyy-MM-dd");  
  64.   String date = formater.format(new Date());  
  65.   try {  
  66.    out.print(date);  
  67.   } catch (IOException e) {  
  68.    e.printStackTrace();  
  69.   }  
  70.   return this.EVAL_PAGE;  
  71.  }  
  72.  
  73.  // 必须实现setXX()方法  
  74.  public void setCount(int count) {  
  75.   this.count = count;  
  76.  }  
  77. } 

(2) 定义tld文件

  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <taglib> 
  3.    <tlibversion>1.0</tlibversion> 
  4.    <jspversion>1.1</jspversion> 
  5.   <tag> 
  6.     <name>iterator</name> 
  7.     <tagclass>cn.com.chenlly.tag.BodyTag</tagclass> 
  8.     <bodycontent>jsp</bodycontent> 
  9.     <!-- 定义属性 --> 
  10.     <attribute> 
  11.        <name>count</name> <!-- 属性名字 --> 
  12.        <type>int</type>  <!-- 属性类型 --> 
  13.        <requried>false</requried> <!-- 是否必须 --> 
  14.        <rtexprvale>false</rtexprvale> <!-- 表示是否可以使用JSP表达式  --> 
  15.   </attribute> 
  16.   </tag> 
  17. </taglib> 

(3) jsp 页面动态引用

  1. <%@ page language="java" pageEncoding="UTF-8"%> 
  2. <%@ taglib uri="/WEB-INF/bodytag.tld" prefix="c"%> 
  3. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
  4. <html> 
  5.   <head> 
  6.   </head> 
  7.   <body> 
  8.    <c:iterator count="10">HelloWorld!</c:iterator> 
  9.    <%  
  10.     out.println("Bye Bye");  
  11.     %> 
  12.   </body> 
  13. </html> 

效果图：

执行顺序

doStartTag()->setBodyContent()->doInitBody()->doAfterTag()->doEndTag()

如果doStartTag()返回的是EVAL_BODY_INCLUDE执行doAfterTag()方法,

如果它返回SKIP_BODY就执行doEndTag()方法。

setBodyContent()方法用于设置标签体内容，如果在计算BodyContent时需要进行一些初始化工作，

则在doInitBody()方法中完成。标签体内容执行完后，会调用doAfterBody()方法

在doAfterTag()方法中返回EVAL_BODY_AGAIN来重复执行doAfterTag()方法

返回SKIP_BODY值则执行doEndTag()方法。

在doEndTag()方法中返回EVAL_PAGE值,则执行此标签的后的其它代码,

返回SKIP_PAGE则不执行此页面的其它代码


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、为了使到JSP容器能够使用标签库中的自定义行为，必须满足以下两个条件：

<% @ taglib prefix=”someprefix”　uri=”/sometaglib” %>

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进行初始化。

#p#

六、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配对。

十一、ServletContext类的常用API

1、getContext(String uripath)：返回服务器中uripath所代表的ServletContext对象；

2、getInitParameter(String name)：返回ServletConfig对象中name参数的值；

3、getMineType(String file)：返回file参数代表的文件的MIME类型；

4、getRequestDispatcher(String path)：返回path代表的RequestDispacher对象；

5、getResourceAsStream(String path)：以输入流的形式返回path对应的资源，在输入留中对象可以为任意形式的数据，path参数必须以“/”开始且相对于Context Root。

十二、如何使用ServletContxt读取并保存属性文件

1、创建java.util.Properties类对象；

2、获取ServletContext对象；

3、将属性文件以输入流的形式读入到某个输入流对象中；

4、将输入流对象加载到Properties对象中；

5、将Properties对象保存到ServletContext对象中。

十三、如何在Web应用启动时装载静态文本

1、创建继承了HttpServlet类的子类，在web.xml中配置这Servlet时设置load-on-startup属性：

someclass 
somepackage.SomeClass1

2、在这个Servlet的init()方法中创建java.util.Properties类

3、获取当前Web应用的ServletContext对象

4、将WEB-INF目录下的属性文件读入到输入流InputStream中：

InputStream in = context.getResourceAsString("WEB-INF/someproperties.properties");

5、将输入流加载到属性对象中

ps.load(in);

6、将属性对象保存到上

context.setAttribute("attributeName",ps);

#p#

十四、如何创建标签处理类

1、引入必需的资源

import javax.servlet.jsp.*; import javax.servlet.http.*; import java.util.*; import java.io.*;

2、继承TagSupport类并覆盖doStartTag()/doEndTag()方法

3、从ServletContext对象中获取java.util.Properties对象

4、从Properties对象中获取key对应的属性值

5、对获取的属性进行相应的处理并输出结果

十五、创建标签库描述文件(Tag Library Descriptor)

1、标签库描述文件，简称TLD，采用XML文件格式，定义了用户的标签库。TLD文件中的元素可以分成3类：

A.标签库元素 
B.标签元素 
C.标签属性元素

2、标签库元素用来设定标签库的相关信息，它的常用属性有：

A.shortname：指定Tag Library默认的前缀名(prefix)；

B.uri：设定Tag Library的惟一访问表示符。

3、标签元素用来定义一个标签，它的常见属性有：

A.name：设定Tag的名字；

B.tagclass：设定Tag的处理类；

C.bodycontent：设定标签的主体(body)内容。

1)empty：表示标签中没有body； 
2)JSP：表示标签的body中可以加入JSP程序代码； 
3)tagdependent：表示标签中的内容由标签自己去处理。

4、标签属性元素用来定义标签的属性，它的常见属性有：

A.name：属性名称；
B.required：属性是否必需的，默认为false； 
C.rtexprvalue：属性值是否可以为request-time表达式，也就是类似于< %=…% >的表达式。

十六、在Web应用中使用标签

1、如果Web应用中用到了自定义JSP标签，则必须在web.xml文件中加入元素，它用于声明所引用的标签所在的标签库

/sometaglib 
/WEB-INF/someTLD.tld

2、设定Tag Library的惟一标示符，在Web应用中将根据它来引用Tag Libray；

3、指定和Tag Library对应的TLD文件的位置；

4、在JSP文件中需要加入<% @ taglib% >指令来声明对标签库的引用。例如：

<% @ taglib prefix = “somePrefix” uri = "/someuri" %>

5、prefix表示在JSP网页中引用这个标签库的标签时的前缀，uri用来指定Tag Library的标识符，它必须和web.xml中的属性保持一致。


闻战网络歌手 闻战网络歌手
原创粉丝点击
热门IT博客
小米6怎么样知乎小米6怎么样知乎
spss mac版spss mac版
c语言进程间通信
权威数据网站
人物绘画教程软件下载
手机数据备份怎么弄
作家 知乎
知之深,爱之切
php 首字母小写
淘宝澳洲代购 都是假的
udp端口攻击
win7桌面添加网络连接
谭维维 知乎
ios推荐游戏2017 知乎
淘宝怎么绑定微信支付
dia frampton知乎
淘宝店铺被违规警告
云计算 电子政务
淘宝公共英语三级包过
淘宝插件看别人数据
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 素描相机下载 素描写生照片 素描步骤分解图带图片 衣服素描图片 眼睛素描图片 素描眼睛图片 素描入门基础教程 怎样画好素描 水果素描入门教程图解 素描阴影怎么打 怎么学画画素描 基础素描教程 素描基础培训班 素描入门基础 素描入门教学 素描画怎么画 怎么学好素描 小学生素描绘画 素描自学入门教程 儿童素描画入门 零基础自学素描 学习人物素描 素描绘画步骤 美术素描基础知识 素描教程 自学网 怎么学画素描 美术高考素描 如何学好素描 儿童创意素描 素描自学入门 学习素描入门 素描入门课程 素描入门基础知识 彩色铅笔素描教学 素描玫瑰花的画法步骤 素描几何体基础教程 儿童素描起步 风景画素描基础 美术素描培训班 专业素描培训班 高考素描培训

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里