随笔档案(496)

Attribute元素

对于tag标签的每个属性，你必须定义它是否必须的，它的值是否可以用诸如<%= …%>的表达式来获得，
以及它的类型（可选），如果不指定它的类型，那就默认为是java.lang.String类型。如果rtexprvalue
元素被定义为true或yes，那么在type元素中就定义了attribute的返回类型。

<attribute>

<name>attr1</name>

<required>true|false|yes|no</required>

<rtexprvalue>true|false|yes|no</rtexprvalue>

<type>attribute的返回类型（只用当rtexprvalue为真是才有效）</type>

</attribute>

如果tag的某个属性不是必须的，那tag处理类会自动提供一个缺省值。

例如，在logic:present这个tag标签中定义了一个属性叫parameter，但它不是必须的，而且它可以
被诸如<%= …%>的表达式来赋值。

<tag>

<name>present</name>

<tag-class>org.apache.struts.taglib.logic.PresentTag</tag-class>

<body-content>JSP</body-content>

…

<attribute>

<name>parameter</name>

<required>false</required>

<rtexprvalue>true</rtexprvalue>

</attribute>

…

</tag>

属性元素的校验

有关于tag标签的有效值可以从tag库的说明文档中获得，当JSP页面被编译时，jsp引擎会强制性地
参照TLD中定义的规则进行检查。

还有一个方法也可以进行属性元素的校验，就是先继承类TagExtraInfo，然后调用它的isValid方法。
这个类同时也起到提供tag中定义的脚本变量信息的作用。

IsValid方法通过TagData对象来传递属性信息，它包括着tag的所有的属性名－值的信息。
由于校验发生在运行时刻，因此这个属性的值将被赋值为TagData.REQUEST_TIME_VALUE。

例如tag标签<tt:twa attr1=”value1” />在TLD中定义如下：

<attribute>

<name>attr1</name>

<required>true</required>

<rtexprvalue>true</rtexprvalue>

</attribute>

这个定义说明了attr1能在运行期间被赋值。

以下的isValid方法检查attr1属性的值是否属于Boolean类型。注意由于attr1能在运行刻被赋值，
那么isValid方法必须检查tag用户是否对此tag进行了运行时刻赋值。

Public class TwaTEI extends TagExtraInfo

{

public boolean isValid(Tagdata data)

{

Object o = data.getAttribute(“attr1”);

If(o != null && o != TagData.REQUEST_TIME_VALUE)

{

if( ( (String)o).toLowerCase().equals(“true”) ||  

((String)o).toLowerCase().equals(“false”) )

return true;

else

return false;

}

else

return true;

}

}

带body的tag

tag处理类

如果tag标签含有内容，那处理方式会略微有些不同，而且还要视tag处理类是否要与body交互的情况而定。
如果要与body交互，那我们认为tag处理类要可能要对body进行操作。

Tag处理类不与body交互

如果tag处理类不与body交互，tag处理类应该实现Tag接口或从TagSupport中派生，如果body要被计算，
那么doStartTag方法应返回 EVAL_BODY_INCLUDE，否则应返回SKIP_BODY。

如果tag处理类要对body反复运算，则它应该实现IterationTag或从TagSupport中派生。如果tag处理类
认为body还未计算完的话，那它的doStartTag方法和doAfterBody方法必须返回EVAL_BODY_AGAIN。

Tag处理类与body交互

如果tag处理类与body交互，那tag处理类应实现BodyTag接口或从BodyTagSupport中派生。这种tag处理类
一般要实现doInitBody和doAfterBody方法。

Body允许一些方法来读写它的内容。Tag处理类可以调用body内容的getString或getReader方法来从body中
提取信息，也可用 writeOut(out) 方法来将body的内容写入到out对象中。其中out对象通过tag处理类的
getPreviousOut方法来获得。

如果body的内容需要被计算，那么doStartTag方法必须返回EVAL_BODY_BUFFERED，否则，它将返回SKIP_BODY。

doInitBody 方法

此方法在body内容已经设好，但未被计算之前被调用。你可以根据不同的body内容来制定初始化策略。

doAfterBody方法

此方法在body内容已被计算后进行调用。

和doStartTag方法一样，doAfterBody方法返回一个指示符指示是否要继续计算body，如果要继续计算，
则doAfterBody应返回EVAL_BODY_BUFFERED，否则，它应返回SKIP_BODY。

release 方法

tag处理类调用此方法将它的状态重置为初始状态，并释放所有的私有资源。

以下的例子读取body的内容（其中含有一条sql语句），然后将它传递给一个对象，让它进行查询。
由于此处body不须重新计算，所以doAfterBody会返回SKIP_BODY。

Public class QueryTag extends BodyTagSupport

{

public int doAfterBody() throws JspTagException

{

BodyContent bc = getBodyContent();

//将body的内容以字符串的格式提取出来

String query = bc.getString();

//清除body

bc.clearBody();

try{

Statement stmt = connection.createStatement();

Result result = stmt.executeQuery(query);

}catch(SQLException e){

throw new JspTagException(“queryTag: “ + e.getMessage() );

return SKIP_BODY;

}

}

body-content元素

由于tag可能会有body，你必须用body-content元素来指定body内容的类型：

<body-content>JSP|tagdependent</body-content>

如果body的内容是定制的或内部的tag、脚本元素、或HTML广本，则归类为JSP类型。其他的类型，
比如上面代码所述的?D?D将sql statement类传给 query tag的这种类型应该标为tagdependent。

注意：实际上body-content的值并不影响tag处理类对body内容的处理，它仅仅是被tag编辑工具
用来描述此body的内容。

用tags定义脚本变量

tag处理类

tag处理类负责创建或设置页面中定义的脚本变量，用pageContext.setAttribute(name,value,scope)
或pageContext.setAttribute(name,value)方法来实现。一般来说，tag处理类通过脚本变量的名称来
获取它，脚本变量的名称一般可用get方法来获得。

如果脚本变量的值依赖于tag处理类中的上下文中某一对象，那它可用pageContext.getAttribute(name,scope)
方法来找到那个对象。一般的处理过程是tag处理类先找到脚本变量，再对其进行处理，
然后用pageContext.setAttribute(name,object)的方法来设置它的新值。

对象的生存周期(scope)如下表：

对象的生存周期表

名字
可访问范围
生存周期

page
当前页面
一直有效，除非页面向客户提交响应或重定向到一个新页面

request
当前页面或当前页面重定向到的页面
一直有效，除非页面向客户提交响应

session
当前页面或在同一浏览器窗口中的页面
一直有效,除非关闭当前浏览器、超时、网络故障

application
整个web应用程序的所有请求
一直有效，除非发生网络故障、服务器故障

提供关于脚本变量的信息

以下示例定义了一个名为“book”的脚本变量，用来访问程序中关于书的信息：

<bean:define id=”book” name=”bookDB” property=”bookDetails” type=”database.BookDetails” />

<font color=”red” size=”+2” >

<%= messages.getString(“CartRemoved”) %>

<strong><jsp:getProperty name=”book” property=”title” /></strong>

</font>

当包含此tag的JSP页面被编译时，jsp引擎会自动生成关于此book的同步的代码
（同步可以避免几个客户同时访问此book时造成的冲突），要生成同步代码，
jsp引擎需要知道此脚本变量的如下信息：

· 脚本变量名称

· 脚本变量所属的类

· 此脚本变量是否引用了一个新的或已存在的对象

· 此脚本变量的有效性

有两种办法可以向jsp引擎提供关于脚本变量的信息：在TLD中定义variable子元素，
或用tei-class子元素定义一个额外tag信息类。用variable最简单，但可能降低了一些灵活性。

Variable元素

Variable元素有如下子元素：

· name-given ?D?D 给出的名字，是一个常量

· name-from-attribute?D?D 属性名，在编译时给出的属性名

name-given或name-from-attribute两者必须选一，但以下子元素是可选的：

· variable-class?D?D变量的类型，缺省为java.lang.String。

· declare?D?D此脚本变量是否引用了一个新对象，缺省为True。

· scope?D?D脚本变量的范围，缺省为NESTED。下表描述了scope的几种类型：

脚本变量的有效范围

值
有效性
方法

NESTED
在tag标签的开始和结束之间
如果tag处理类实现BodyTag接口，则在doInitBody和doAfterBody中调用，否则在doStartTag中调用

AT_BEGIN
从tag标签的开始一直到页面结束
如果tag处理类实现BodyTag接口，则在doInitBody、doAfterBody和doEndTag中调用，
否则在doStartTag和doEndTag中调用

AT_END
从tag标签的结束一直到页面结束
在doEndTag中调用

以struts为例，它的bean:define标签的实现遵循JSP1.1规范，此规范要求使用额外tag信息类来定义脚本变量。
Variable元素是JSP1.2规范中加入的。以bean:define标签为例，你可以定义如下variable元素：

<tag>

<variable>

<name-from-attribute>id</name-from-attribute>

<variable-class>database.BookDetails</variable-class>

<declare>true</declare>

<scope>AT_BEGIN</scope>

</variable>

</tag>

额外tag信息类

如果要定义一个额外tag信息类，你要继承javax.servlet.jsp.TagExtraInfo类。
一个TagExtraInfo类必须实现getVariableInfo方法，此方法返回一个叫VariableInfo的数组类，
它包括如下信息：

· 变量名

· 变量所属类名

· 此变量是否引用了一个新对象

· 此变量的有效范围

jsp引擎将一个名为data的参数传给getVariableInfo方法，data中包括tag标签中的所有“属性名?D?D属性值”对。
它可以用来向VariableInfo对象提供脚本变量的名字和类名。

以struts为例，它在bean:define标签中定义了一个名为DefineTei的额外tag信息类，用来向脚本变量提供信息。
由于脚本变量的名称（book）和类名（database.BookDetails）是通过tag标签的属性来传递的，
它们一般定义在VariableInfo的构建代码中，并且可用data.getAttributeString方法来得到这些信息。
如果要允许book脚本变量能在从tag开始直到整个JSP页面结束的范围内都可用的话，那它的范围应设为AT_BEGIN。
如下所示：

public class DefineTei extends TagExtraInfo

{

public VariableInfo[] getVariableInfo(TagData data)

{

String type = data.getAttributeString(“type”);

If( type == null)

type = “java.lang.Object”;

return new VariableInfo[] {

new VariableInfo(data.getAttributeString(“id”),  

type,

true,

VariableInfo.AT_BEGIN)

};

}

}

注意：关于额外tag信息类的类名必须要在TLD中的tag标签下的tei-class子元素中定义。
因此，DefineTei的tei-class中的定义看起来如下：
<tei-class>
org.apache.struts.taglib.bean.DefineTagTei
</tei-class>

具有协作关系的tag

tag通过共享对象来进行协作，JSP技术支持2种方式的对象共享。

第一种方法是使用pageContext对象进行对象的共享（可支持JSP页面和tag处理类之间的共享），
如果在一个tag处理类中要调用由另一个tag处理类创建的对象，可调用pageContext.getAttribute(name, scope)方法。

第二各方式的共享是对于tag之间有嵌套关系而言的，外层的tag所创建的对象对于内层的tag来说是
可以共用的。这种形式的共享的好处是减少了可能存在的重名冲突。

要访问一个嵌套tag创建的对象，tag处理类必须先找到此嵌套tag对象，可用TagSupport的静态方法
TagSupport.findAncestorWithClass(from, class)或TagSupport.getParent方法。前者在当不确定
此tag是否为嵌套tag对象时使用。一旦它的父类被找到，它就能访问其所有动态或静态创建的对象。
静态创建的对象是父类的成员，而动态创建的对象可能是父类的私有对象。诸如此类的对象可以用tag处理类的setValue方法来保存，用getValue方法来获得。

下例阐述了以上两种共享对象的方法。在这个例子当中，一个查询tag检查一个名为connection的属性名
是否在doStartTag中被设置。如果connection属性被设置，tag处理类从pageContext中得到这个connection对象。
否则，此tag处理类先找到它的父tag处理类，然后从它的父tag处理类中找到connection对象。

public class QueryTag extends BodyTagSupport
{
     private String connectionId;
     public int doStartTag() throws JspException
    {
       String cid = getConnection();
       if(cid != null)
       {
           //存在一个connection id，使用它。
           connection = (Connection) pageContext.getAttribute(cid);
       }
       else
       {
           ConnectionTag ancestorTag = (ConnectionTag)findAncestorWithClass(this,  
           ConnectionTag.class);
           if(ancestorTag == null)
           {
              throw new JspTagException(“一个没有connection属性的查询标签必须被一个connection标记嵌套。”);
           }
           connection = ancestorTag.getConnection();
       }
    }
}  

此查询标签在JSP页面中的调用形式可以从以下2种定义中任选一种：

<tt:connection id=”con01” ...> ... </tt:connection>

<tt:query id=”balances” connection=”con01” >

SELECT account, balance FROM acct_table

where customer_num = <%= request.getCustno() %>

</tt:query>

或

<tt:connection ...>

<x:query id=”balances”>

SELECT account, balance FROM acct_table

where customer_num = <%= request.getCustno() %>

</x:query>

</tt:connection>

与此同时，在TLD中必须指定connection属性为可选的，定义如下：

<tag>

...

<attribute>

<name>connection</name>

<required>false</required>

</attribute>

</tag>