自定义标签（JspFragment类、invoke方法、开发带属性的标签）

自定义标签（JspFragment类、invoke方法、开发带属性的标签）

一、JspFragment类

javax.servlet.jsp.tagext.JspFragment类是在JSP2.0中定义的，它的实例对象代表JSP页面中的一段符合JSP语法规范的JSP片段，这段JSP片段中不能包含JSP脚本元素。

WEB容器在处理简单标签的标签体时，会把标签体内容用一个JspFragment对象表示，并调用标签处理器对象的setJspBody方法把JspFragment对象传递给标签处理器对象。JspFragment类中只定义了两个方法，如下所示：

getJspContext方法用于返回代表调用页面的JspContext对象.

public abstract void invoke(java.io.Writer out)

用于执行JspFragment对象所代表的JSP代码片段，参数out用于指定将JspFragment对象的执行结果写入到哪个输出流对象中，如果传递给参数out的值为null，则将执行结果写入到JspContext.getOut()方法返回的输出流对象中。(简而言之，可以理解为写给浏览器)

二、invoke方法详解

JspFragment.invoke方法可以说是JspFragment最重要的方法，利用这个方法可以控制是否执行和输出标签体的内容、是否迭代执行标签体的内容或对标签体的执行结果进行修改后再输出。例如：

在标签处理器中如果没有调用JspFragment.invoke方法，其结果就相当于忽略标签体内容；

在标签处理器中重复调用JspFragment.invoke方法，则标签体内容将会被重复执行；

若想在标签处理器中修改标签体内容，只需在调用invoke方法时指定一个可取出结果数据的输出流对象（例如StringWriter），让标签体的执行结果输出到该输出流对象中，然后从该输出流对象中取出数据进行修改后再输出到目标设备，即可达到修改标签体的目的。

三、开发带属性的标签

自定义标签可以定义一个或多个属性，这样，在JSP页面中应用自定义标签时就可以设置这些属性的值，通过这些属性为标签处理器传递参数信息，从而提高标签的灵活性和复用性

要想让一个自定义标签具有属性，通常需要完成两个任务：

（1）在标签处理器中编写每个属性对应的setter方法

（2）在TLD文件中描术标签的属性

为自定义标签定义属性时，每个属性都必须按照JavaBean的属性命名方式，在标签处理器中定义属性名对应的setter方法，用来接收JSP页面调用自定义标签时传递进来的属性值。 例如属性url，在标签处理器类中就要定义相应的setUrl(String url)方法。

在标签处理器中定义相应的set方法后，JSP引擎在解析执行开始标签前，也就是调用doStartTag方法前，会调用set属性方法，为标签设置属性。

四、在TLD中描述标签属性

元素名：description 是否必须指定：否 描述：用于指定属性的描述信息。

元素名：name 是否必须指定：否 描述：用于指定属性的名称。属性名称是大小写敏感的，并且不能以jsp、_jsp、java和sun开头。

元素名：required 是否必须指定：否 描述：用于指定在JSP页面中调用自定义标签时是否必须设置这个属性。其取值包括true和false，默认值为false，true表示必须设置，否则可以设置也可以不设置该属性。

元素名：rtexprvale 是否必须指定：否 描述：rtexprvalue是runtime expression value（运行时表达式）的英文简写，用于指定属性值是一个静态值或动态值。其取值包括true和false，默认值为false，false表示只能为该属性指定静态文本值，例如"123"；true表示可以为该属性指定一个JSP动态元素，动态元素的结果作为属性值，例如JSP表达式<%=value %>。

元素名：type 是否必须指定：否 描述：用于指定属性值的Java类型。

<tag>元素的<attribute>子元素用于描述自定义

标签的一个属性，自定义标签所具有的每个属性

都要对应一个<attribute>元素 。

<attribute>

<description>description</description>

<name>aaaa</name>

<required>true</required>

<rtexprvalue>true</rtexprvalue>

<type>ObjectType</type>

</attribute>