自定义JSP标签概述
• 自定义JSP标签就是程序员定义的一种JSP标签,这种标签把那些信息显示逻辑封装在一个单独的Java类中,通过一个XML文件来描述它的使用。当页面中需要使用类似的显示逻辑时,就可以在页面中插入这个标签,从而完成相应的功能。
• 使用自定义标签,可以分离程序逻辑和表示逻辑,将Java代码从HTML中剥离,便于美工维护页面;自定义标签也提供了可重用的功能组件,能够提高工程的开发效率。
• 自定义标签主要用于移除Jsp页面中的java代码。
执行过程
• 当一个含有自定义标签的JSP页面被JSP引擎(Web容器)转译成Servlet时,JSP引擎遇到自定义的标签,会把这个自定义标签转化成对一个称为“标签处理类”的调用。之后,当这个JSP页面被执行时,JSP引擎就会调用这个“标签处理类”对象,并执行其内部定义的相应操作方法,从而完成相应的功能。
开发流程
• 使用Java处理类来开发自定义JSP标签时,主要分为下几个步骤。
– 创建标签的处理类(Tag Handle Class)。这个类实现Tag接口,用来定义标签的行为,并在JSP引擎遇到自定义标签时调用执行。
– 创建标签库描述 (tld)文件(Tag Library Descriptor File),在tld文件中对标签处理器类进行描述。
– 在JSP文件中用taglib指令引入标签库,然后使用标签库描述文件中指定的标签名来使用它。
Tag接口的执行流程
• JSP引擎将遇到自定义标签时,首先创建标签处理器类的实例对象,然后按照JSP规范定义的通信规则依次调用它的方法。
1、public voidsetPageContext(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方法。
自定义标签功能扩展
• 开发人员在编写Jsp页面时,经常还需要在页面中引入一些逻辑,例如:
– 控制jsp页面某一部分内容是否执行。
– 控制整个jsp页面是否执行。
– 控制jsp页面内容重复执行。
– 修改jsp页面内容输出。
• 自定义标签除了可以移除jsp页面java代码外,它也可以实现以上功能。
• tld文件中的四种标签体类型
– EMPTY JSP scriptless tagdepentend
JSP标签API
• JSP 1.1和1.2规范中常用的接口主要有以下3个。
– Tag:此接口定义对于所有标签处理类都需要实现的方法。
– IterationTag:此接口扩展了Tag接口,增加了控制重复执行标签主体的方法。
– BodyTag:此接口扩展了IterationTag接口,并增加了访问和操作标签主体内容的方法。
标签库描述符
• 标签库描述符文件是一个以“.tld”结尾的标准XML文档,用来记录一个标签库内拥有哪些标签、每个标签包含哪些属性。
• 以下是一个JSP 2.0规范的标签库描述文件的内容:
• <taglib>元素是标签库描述符的根元素,它包含12个子元素,详细介绍如下。
– (1)<description>:标签库的一个文本描述。
– (2)<tlib-version>:指定标签库的版本。
– (3)<short-name>:为标签定义简短的名字,在taglib指令中可作为首选的前缀名使用。
– (4)<uri>:定义一个URI,用于唯一地标识此标签库。
– (5)<tag>:用于指定自定义标签的相关信息。
– (6)<display-name>:为标签库指定一个简短的别名。
– (7)<small-icon>:为标签库指定大小为16×16的小图标(gif或jpeg格式),该图标可在图形界面工具中显示。
– (8)<large-icon>:为标签库指定大小为32×32的大图标(gif或jpeg格式),该图标可在图形界面工具中显示。
– (9)<validator>:为标签库提供一个验证器。
– (10)<listener>:为标签库提供一个监听器。
– (11)<tag-file>:用于描述标签文件。
– (12)<function>:用于指定在表达式语言中使用的函数。
传统标签的开发
• 在开发传统标签之前,需要了解清楚两个支持类(TagSupport和BodyTagSupport)的生命周期。
TagSupport类的生命周期可以用图来表示
BodyTagSupport类的生命周期
用BodyTagSupport类开发自定义标签
• BodyTagSupport类中增加了两个方法:
– setBodyContent(BodyContent bc):容器在执行这个标签处理类的实例时,将调用该方法,把标签主体返回的内容缓存在BodyContent类的实例中。BodyContent除了从父类JspWriter继承提供用于向响应体中写入文本的方法,还提供了用于获取它缓冲的标签体内容。
– doInitBody():计算标签主体之前调用该方法进行初始化共,可以向bodyContent对象中写入初始内容,这些内容会放置在标签主体内容之前。
• BodyContent类专门用于缓存标签主体返回的内容,包括静态文本以及由嵌套标签或脚本元素所创建的动态内容。