Java自定义标签库的开发及其工作流程的解读

最新推荐文章于 2022-09-23 16:58:00 发布

L小芸

最新推荐文章于 2022-09-23 16:58:00 发布

阅读量1.5k

点赞数

本文链接：https://blog.csdn.net/lycyl/article/details/48339161

版权

Java自定义标签库开发的步骤：

1.首先编写一个标签处理器类

2.编写个对应的tld文件，一般在WEB-INF/tld目录下

3.在需要使用该标签的jsp页面引入该标签库

标签库Taglib

标签被定义和分布在一个称为标签库的结构中，一个标签库是由元信息和类组成的集合：

1.标签处理器：实现定制标签功能的Java类

2.标签附加信息（TEI）：向JSP容器提供边辑以确认标签属性和创建变量的类

3.标签库描述器（TLD）：描述单个标签和整个标签库属性的XML文档

一、标签实现

1.开发步骤

a.定义标签的名字、属性、声明的变量和标签体的内容。

b.编写标签库描述器TLD。

c.编写标签处理器。

d.在JSP页面中使用标签。

2.JSP页面在JSP容器中的转换步骤：

JSP页面存在三种形式：jsp文件、java文件和class文件。

a.指令元素、和向JSP容器提供转换时信息。

b.HTML行在_jspService()方法中依顺序转换到out.print()语名中。

c.脚本元素的声明被原封不动地复制到_jspService()方法外的源码中。

d.脚本元素的表达式在_jspService()方法中依顺序转换到out.print()语名中。

e.脚本元素的scriptlet被原封不动地复制到_jspService()方法中。

f.行为元素被转换为执行其功能的运行时逻辑代码。

g.定制标签被扩展到调用其相应标签处理器中方法的Java语句中。

3.标签在JSP容器中的转换步骤：

a.JSP容器使用taglib指令元素定位标签库描述器，将页面中用到的定制标签和TLD相匹配。

b.读取标签库描述器的标签列表和每一标签相关的类名字。

c.在页面中遇到一个标签时，查找与具有指定名字的标签前缀相关的一个标签库。

d.容器使用在TLD中找到的标签结构信息生成一系列完成标签功能的Java语句。

二、标签库描述器（TLD）

标签库描述器是一个描述整个标签库标记信息和库中每个标签处理器及其属性的XML文档。

标签库描述器的DTD由一个简单的元素组成，此元素包含下列一些子元素。

整个标签库标记信息

tlibversion标签库版本号。是一个点式十进制数，最多为4组小数点分隔的数字组成。

jspversion标签库所需的JSP规范最低版本。例如JSP1.1

shortname标签库的缩写名。JSP可以使用该名字作为库中标签的缺省前缀。

uri标签库唯一URI的元素。典型URL位置来自可下载taglib的位置。

info标签库描述信息。

每个标签处理器及其属性

tag在TLD中加入标签，描述组成库的每个标签。

name与标签库的名字前缀一起使用的标签的名字，是JSP容器唯一的标签标识。

tagclass实现标签的标签处理器类的全名。

teiclass标签附加信息（TEI）类的全名。TEI类给出关于标签处理器创建变量及对标签司性执行的任意有效性验证的信息。

bodycontent描述标签处理器如何使用标签体的内容。有三种取值：

empty：表示标签体必须为空；

JSP:表示脚本元素和模板及其它标签一样被评估。

tagdependent：体内容被原封不动写入BodyContent，其它脚本元素以源码形式出现，而不被JSP容器解释。

info标签的人工可读描述性信息。

attribute使用标签时被编码的属性信息。用于定义标签的属性。

属性名：属性的名字。

true|false：属性在标签用到的位置是否要被编码。

true|false：属性值能否用表达式指定。

三、标签处理器

标签处理器是通过实现JSP容器调用的一系列预定义方法执行定制标签行为的一个Java类。

标签处理器实现了标签的行为，标签处理器是Java类。

1.标签处理器的工作方式

a.导入javax.servlet.jsp和javax.servlet.jsp.tagext包。

包的位置:/tomcat/common/lib/jsp-api.jar(servlet:servlet-api.jar)

b.实现javax.servlet.jsp.tagext包中的Tag接口或BodyTag接口。BodyTag是Tag的子接口。

c.继承TagSupport类或BodyTagSuppoert类。它们是上述接口的缺省实现。

d.重载publicintdoStartTag()throwsJspException方法。

2.标签处理器的接口与实现

javax.servlet.jsp.tagext.Tag是实现标签的最基本的接口。

javax.servlet.jsp.tagext.TagSupport是实现Tag接口的具体类。

通常情况下继承tagSupport类而不直接实现Tag接口通常是有益的。除了对所有必需方法提供了缺省实现外、还保存了pageContext对象及对嵌套标签的支持。

Tag接口包含4个常量，表示doStartTag()和doEndTag()方法可能的返回码。

EVAL_BODY_INCLUDE当doStartTag()返回时，指明servlet应对标签体进行评估。

SKIP_BODY当doStartTag()返回时，指明servlet应忽视标签体。

EVAL_PAGE当doEndTag()返回时，指明页面其余部分应被评估。

SKIP_PAGE当doEndTag()返回时，指明页面其余部分就被跳过。

Tag接口的方法

publicvoidsetPageContext(PageContextctx)生成的servlet在请求处理器执行其它任务前首先调用此方法，实现类应保存上下文对象以便它可以在标签生命期中使用。从页面上下文中标签处理器可以访问所有JSP隐含对象。

publicvoidsetParent(Tagp)使用一个标答可以找到操作栈中它上面的标签。在setPageContext后立即调用。

publicTaggetParent()返回父标签。

publicintdoStartTag()throwsJsp在设置了页面上下文、父标签和开始标记中编码的属性后调用。返回码表明JSP实现servlet是否就评估标签体。

publicintdoEndTag()throwsJspException当遇到结否标记时调用。返回码表明JSP是否就继纽页面的其余部份。

publicvoidrelease()确保在页面退出前被调用。释放资源并重置标签处理器状态。

TagSupport类的方法

publicstaticTagfinAncestorWithClass(TagthisTag,Classcls)为所需的父标签处理器查找运行时标签栈。一个标签处理器可以提供其范围内子标签调用的方法。

publicvoidsetId(Stringid)保存和检索在id属性中指定的名字。

publicvoidsetValue(Stringname,Objecto)在本地哈希表中设置指定名字的值。

publicObjectgetValue(Stringname)从本地哈希表中获取指定名称的值。

publicvoidremoveValue(Stringname)从本地哈希表中删除指定名称的值。

publicEnumerationgetValues()返回哈希表中关键字的一个枚举。

3.标签处理器的生命期

a.生成servlet需要创建标签处理器类的一个实例。实现方式通常是调用JSP容器的工厂类的一个方法，工厂类包含一个标签处理器实例池以使其可重用不再处于激活状态的对象。

b.初始化标签处理器，使servlet获知其存在性。servlet通过调用标签处理器的两个方法实现此过程：setPageContext(PageContextctx)和setParent(Tagparent)。

c.如果标签具有属性，属性的取值通过处理器提供setter方法传入到对象。属性setter方法是一个标签支持属性所需的唯一方法。

d.页面的上下文和父标签已被调置，并已具备属性。此时调用标签处理器的doStartTag()方法，该方法可以读取这些变量并执行实现标答功能所需的计算和操作。doStartTag()方法必须返回一个整型数。返回EVAL_BODY_INCLUDE则正常处理标签体，返回SKIP_BODY则从初始JSP页面中直到此标签结束标记处的内容均被忽略。

e.标签体被评估或忽视后调用标签处理器的doEndTag()方法，返回EVAL_PAGE则页面的其余部分被评估，返回SKIP_PAGE则servlet代码立即从_jspService()中返回。

4.体标签处理器的接口与实现

javax.servlet.jsp.tagext.BodyTag是Tag的子接口。

javax.servlet.jsp.tagext.BodyTagSupport是实现BodyTag类。

BodyContent是javax.servlet.jsp.JspWriter的子类，但与其父类有所区别。

BodyContent对象的内容不自动写了入servlet的输出流，而是积累在一字符串缓存中。当标签体完成后其对象仍可在doEndTag()方法中可以应用，由getString()或getReader()方法操作。并在必要时修改及写入恢复的JspWriter输出流。

BodyContent类的方法

publicvoidflush()throwsIOException复写JspWrite.flush()方法以便它总是产生溢出。刷新写入已失效，因为它没有连接到将被写入的实际输出流中。

publicvoidclearBody()重置BodyContent缓存为空。

publicReadergetReader()返回Reader读取体内容。

publicStringgetString()返回包含体内容的一个字符串。

publicvoidwriteOut(Writew)将体内容写入指定输出。

publicJspWritegetEnclosingWrite()返回栈中下一个更高的写入者对象（可能是另一个BodyContent对象）。

四，标签的实现

1 TagSupport与BodyTagSupport的区别

TagSupport与BodyTagSupport的区别主要是标签处理类是否需要与标签体交互，如果不需要交互的就用TagSupport，否则如果不需要交互就用BodyTagSupport。

交互就是标签处理类是否要读取标签体的内容和改变标签体返回的内容。

用TagSupport实现的标签，都可以用BodyTagSupport来实现，因为BodyTagSupport继承了TagSupport。

2 doStartTag(),doEndTag()

doStartTag()方法是遇到标签开始时会呼叫的方法，其合法的返回值是EVAL_BODY_INCLUDE与SKIP_BODY,前者表示将显示标签间的文字，后者表示不显示标签间的文字；doEndTag()方法是在遇到标签结束时呼叫的方法，其合法的返回值是EVAL_PAGE与SKIP_PAGE，前者表示处理完标签后继续执行以下的JSP网页，后者是表示不处理接下来的JSP网页

doAfterBody(),这个方法是在显示完标签间文字之后呼叫的，其返回值有EVAL_BODY_AGAIN与SKIP_BODY，前者会再显示一次标签间的文字，后者则继续执行标签处理的下一步。

预定的处理顺序是：doStartTag()返回SKIP_BODY,doAfterBodyTag()返回SKIP_BODY,doEndTag()返回EVAL_PAGE.

如果继承了TagSupport之后，如果没有改写任何的方法，标签处理的执行顺序是：

doStartTag() ->不显示文字 ->doEndTag()->执行接下来的网页

如果您改写了doStartTag(),则必须指定返回值，如果指定了EVAL_BODY_INCLUDE,则执行顺序是

doStartTag()->显示文字->doAfterBodyTag()->doEndTag()->执行下面的网页

JSP引擎遇到自定义标签时，首先创建标签处理器类的实例对象，然后按照JSP规范定义的通信规则依次调用它的方法。
   1、public void setPageContext(PageContext pc)， JSP引擎实例化标签处理器后，将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器，标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。
   2、public void setParent(Tag t)，setPageContext方法执行完后，WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器，如果当前标签没有父标签，则传递给setParent方法的参数值为null。
   3、public int doStartTag()，调用了setPageContext方法和setParent方法之后，WEB容器执行到自定义标签的开始标记时，就会调用标签处理器的doStartTag方法。
   4、public int doEndTag()，WEB容器执行完自定义标签的标签体后，就会接着去执行自定义标签的结束标记，此时，WEB容器会去调用标签处理器的doEndTag方法。
   5、public void release()，通常WEB容器执行完自定义标签后，标签处理器会驻留在内存中，为其它请求服务器，直至停止web应用时，web容器才会调用release方法。

　　我们在tomcat服务器的"work\Catalina\localhost\JavaWeb_JspTag_study_20140816\org\apache\jsp"目录下可以找到将jspTag_Test1.jsp翻译成Servlet后的java源代码，如下图所示：

　　打开jspTag_005fTest1_jsp.java文件，可以看到setPageContext(PageContext pc)、setParent(Tag t)、doStartTag()、doEndTag()、release()这5个方法的调用顺序和过程。

　　jspTag_005fTest1_jsp.java的代码如下：

  1 package org.apache.jsp;
  2 
  3 import javax.servlet.*;
  4 import javax.servlet.http.*;
  5 import javax.servlet.jsp.*;
  6 
  7 public final class jspTag_005fTest1_jsp extends org.apache.jasper.runtime.HttpJspBase
  8     implements org.apache.jasper.runtime.JspSourceDependent {
  9 
 10   private static final JspFactory _jspxFactory = JspFactory.getDefaultFactory();
 11 
 12   private static java.util.List _jspx_dependants;
 13 
 14   static {
 15     _jspx_dependants = new java.util.ArrayList(1);
 16     _jspx_dependants.add("/WEB-INF/gacl.tld");
 17   }
 18 
 19   private org.apache.jasper.runtime.TagHandlerPool _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody;
 20 
 21   private javax.el.ExpressionFactory _el_expressionfactory;
 22   private org.apache.AnnotationProcessor _jsp_annotationprocessor;
 23 
 24   public Object getDependants() {
 25     return _jspx_dependants;
 26   }
 27 
 28   public void _jspInit() {
 29     _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody = org.apache.jasper.runtime.TagHandlerPool.getTagHandlerPool(getServletConfig());
 30     _el_expressionfactory = _jspxFactory.getJspApplicationContext(getServletConfig().getServletContext()).getExpressionFactory();
 31     _jsp_annotationprocessor = (org.apache.AnnotationProcessor) getServletConfig().getServletContext().getAttribute(org.apache.AnnotationProcessor.class.getName());
 32   }
 33 
 34   public void _jspDestroy() {
 35     _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.release();
 36   }
 37 
 38   public void _jspService(HttpServletRequest request, HttpServletResponse response)
 39         throws java.io.IOException, ServletException {
 40 
 41     PageContext pageContext = null;
 42     HttpSession session = null;
 43     ServletContext application = null;
 44     ServletConfig config = null;
 45     JspWriter out = null;
 46     Object page = this;
 47     JspWriter _jspx_out = null;
 48     PageContext _jspx_page_context = null;
 49 
 50 
 51     try {
 52       response.setContentType("text/html;charset=UTF-8");
 53       pageContext = _jspxFactory.getPageContext(this, request, response,
 54                   null, true, 8192, true);
 55       _jspx_page_context = pageContext;
 56       application = pageContext.getServletContext();
 57       config = pageContext.getServletConfig();
 58       session = pageContext.getSession();
 59       out = pageContext.getOut();
 60       _jspx_out = out;
 61 
 62       out.write("\r\n");
 63       out.write("<!-- 引用gacl标签库，标签库的前缀(prefix)可以随便设置，如这里设置成 prefix=\"gacl\" -->\r\n");
 64       out.write("\r\n");
 65       out.write("<!DOCTYPE HTML>\r\n");
 66       out.write("<html>\r\n");
 67       out.write("  <head>\r\n");
 68       out.write("    <title>输出客户端的IP</title>\r\n");
 69       out.write("  </head>\r\n");
 70       out.write("  \r\n");
 71       out.write("  <body>\r\n");
 72       out.write("    你的IP地址是(使用java代码获取输出)：\r\n");
 73       out.write("    ");
 74 
 75         //在jsp页面中使用java代码获取客户端IP地址
 76         String ip = request.getRemoteAddr();
 77         out.write(ip);
 78     
 79       out.write("\r\n");
 80       out.write("    <hr/>\r\n");
 81       out.write("     你的IP地址是(使用自定义标签获取输出)：");
 82       if (_jspx_meth_xdp_005fviewIP_005f0(_jspx_page_context))
 83         return;
 84       out.write("\r\n");
 85       out.write("  </body>\r\n");
 86       out.write("</html>\r\n");
 87     } catch (Throwable t) {
 88       if (!(t instanceof SkipPageException)){
 89         out = _jspx_out;
 90         if (out != null && out.getBufferSize() != 0)
 91           try { out.clearBuffer(); } catch (java.io.IOException e) {}
 92         if (_jspx_page_context != null) _jspx_page_context.handlePageException(t);
 93       }
 94     } finally {
 95       _jspxFactory.releasePageContext(_jspx_page_context);
 96     }
 97   }
 98 
 99   private boolean _jspx_meth_xdp_005fviewIP_005f0(PageContext _jspx_page_context)
100           throws Throwable {
101     PageContext pageContext = _jspx_page_context;
102     JspWriter out = _jspx_page_context.getOut();
103     //  xdp:viewIP
104     me.gacl.web.tag.ViewIPTag _jspx_th_xdp_005fviewIP_005f0 = (me.gacl.web.tag.ViewIPTag) _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.get(me.gacl.web.tag.ViewIPTag.class);
105     _jspx_th_xdp_005fviewIP_005f0.setPageContext(_jspx_page_context);
106     _jspx_th_xdp_005fviewIP_005f0.setParent(null);
107     int _jspx_eval_xdp_005fviewIP_005f0 = _jspx_th_xdp_005fviewIP_005f0.doStartTag();
108     if (_jspx_th_xdp_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE) {
109       _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.reuse(_jspx_th_xdp_005fviewIP_005f0);
110       return true;
111     }
112     _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.reuse(_jspx_th_xdp_005fviewIP_005f0);
113     return false;
114   }
115 }

　　下面重点分析一下上述代码中标红色的那个 private boolean _jspx_meth_xdp_005fviewIP_005f0(PageContext _jspx_page_context)方法中的代码

　　①、这里是实例化一个viewIP标签处理器类me.gacl.web.tag.ViewIPTag的对象

1  //  xdp:viewIP
2     me.gacl.web.tag.ViewIPTag _jspx_th_xdp_005fviewIP_005f0 = (me.gacl.web.tag.ViewIPTag) _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.get(me.gacl.web.tag.ViewIPTag.class);

　　②、实例化标签处理器后，调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器

1 _jspx_th_xdp_005fviewIP_005f0.setPageContext(_jspx_page_context);

　　③、setPageContext方法执行完后，接着调用的setParent方法将当前标签的父标签传递给当前标签处理器，如果当前标签没有父标签，则传递给setParent方法的参数值为null

1 _jspx_th_xdp_005fviewIP_005f0.setParent(null);

　　④、调用了setPageContext方法和setParent方法之后，WEB容器执行到自定义标签的开始标记时，就会调用标签处理器的doStartTag方法

1 int _jspx_eval_xdp_005fviewIP_005f0 = _jspx_th_xdp_005fviewIP_005f0.doStartTag();

　　⑤、WEB容器执行完自定义标签的标签体后，就会接着去执行自定义标签的结束标记，此时，WEB容器会去调用标签处理器的doEndTag方法

1 if (_jspx_th_xdp_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE)

　　这就是自定义标签的执行流程。

　　这里以一个入门级的案例来讲解javaweb的自定义标签开发，在后面的博文中会进行更加详尽的介绍。

L小芸

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
Java自定义标签库的开发及其工作流程的解读

Java自定义标签库开发的步骤：1.首先编写一个标签处理器类2.编写个对应的tld文件，一般在WEB-INF/tld目录下3.在需要使用该标签的jsp页面引入该标签库标签库Taglib标签被定义和分布在一个称为标签库的结构中，一个标签库是由元信息和类组成的集合：1.标签处理器：实现定制标签功能的Java类2.标签附加信息（TEI）：向JSP容
复制链接

扫一扫