Struts标签taglib指南

转自  http://www.solol.org/technologic/java/j-struts/

谢谢solo L

Struts是Apache Jakarta的一个著名的开源项目，目标是为构建基于Java的web应用程序提供一个框架。

Struts提供了非常多的标签，依据功能和使用习惯的不同被分到了五个标签库中:

• Bean Tags:该标签库包含的标签可以用来创建bean、访问bean和访问bean的属性。同时提供了依据cookies、headers和parameters的值创建相关bean的能力。
• HTML Tags:该标签库包含的标签可以用来创建Struts输入表单。
• Logic Tags:该标签库包含的标签可以用来进行逻辑判断、集合迭代和流程控制。
• Nested Tags:该标签库建立在前三个标签库的基础上，具有前三个标签库的所有功能，只是允许标签间的嵌套。
• Tiles Tags:该标签库包含的标签可以用来创建tiles样式的页面。

这篇指南主要介绍前三个标签库中的标签。如果您对后两类标签也感兴趣可以查阅参考资料中的Struts的用户指南。

bean:cookie

cookie最早是由Netscape公司提出来的，用来存储客户的少量状态信息。如果您对cookie的具体细节感兴趣可以查阅参考资料中的cookie spec。

bean:cookie标签取回请求中名称为name的cookie的值。如果没有指定multiple属性则依据刚取回的值创建一个Cookie 类型的bean。如果指定了multiple属性则依据刚取回的值创建一个Cookie[]类型的数组。然后用id属性值将Cookie或Cookie []绑定到page作用域中(这种绑定是为了其它标签能够使用该值)，并创建对应的scripting变量(这种变量是为了JSP脚本能够使用该值)。

下面的代码片段示例了如何使用bean:cookie标签读取名为JSESSIONID的cookie的值，并且使用了两种方式进行了输出：

<logic:present cookie="JSESSIONID">
     <bean:cookie id="jSession" name="JSESSIONID"/>
     <!-- 其它标签通过绑定到page作用域中的属性使用该值 -->
     这个cookie的名称是<bean:write name="jSession" property="name"/>，
     值为<bean:write name="jSession" property="value"/>。<br/>
     <!-- JSP脚本通过scripting变量使用该值 -->
     <%
       String name = jSession.getName();
       String value = jSession.getValue();
       out.println("这个cookie的名称是"+name+"，值为"+value+"。
       <br/>"); 
     %>
</logic:present>

bean:define

bean:define标签在toScope(如果没有指定值就使用page作用域)指定的作用域中创建一个新属性，同时创建一个 scripting变量。我们可以通过id值使用它们。新创建的属性可以由其它标签使用，而新创建的scripting变量可以由JSP脚本使用。

我们可以使用三种方式为新创建的属性和scripting变量赋值：

• 通过该标签的name、property和scope取回值，并且保持类型的一致性，除非取回的值为Java的原始类型，这时会使用适合的包装器类对这些值进行包装。
• 通过该标签的value指定值，这时新创建的属性和scripting变量的类型为java.lang.String。
• 通过在该标签的体中嵌入值，这时新创建的属性和scripting变量的类型为java.lang.String。

 

下面的代码片段示例了如何使用bean:define标签创建新属性values和新scripting变量values，它将listForm中persons的值取出来赋给values:

<bean:define id="values" name="listForm" property = "persons" 
 type="java.util.List"/> 

下面给出ListForm的代码片段以帮助您更好的理解，其中Person是一个只有id和name两个属性的简单bean：

public class ListForm extends ActionForm {
     private List<Person> persons = null;
     public List<Person> getPersons() {
       return persons;
     }
     public void setPersons(List<Person> persons) {
       this.persons = persons;
     }
     public void reset(ActionMapping mapping, 
         HttpServletRequest request) {
       persons = null;
     }
} 

下面的代码片段示例了logic:iterate标签如何使用bean:define标签创建的新属性values:

<logic:iterate id="person" name="values">
     <bean:write name="person" property="id"/><br/>
</logic:iterate>

下面的代码片段示例了JSP脚本如何使用bean:define标签创建的新scripting变量values:

<%
     Person p = new Person();
     for(int i=0;i<values.size();i++){
       p = (Person)values.get(i);
       out.println(p.getId());
       out.println("<br/>");
     }    
%>

bean:header

bean:header标签取回请求中名称为name的header的值。如果没有指定multiple属性则依据刚取回的值创建一个String 类型的bean。如果指定了multiple属性则依据刚取回的值创建一个String[]类型的数组。然后用id属性值将String或String []绑定到page作用域中(这种绑定是为了其它标签能够使用该值)，并创建对应的scripting变量(这种变量是为了JSP脚本能够使用该值)。

下面是我的浏览器发送的header的内容，这些内容和浏览器有关，因此您的浏览器发送的内容可能和下面列出的不同。不过这没有关系，因为要理解bean:header标签您只要对这些内容有一个大概的认识就足够了。

accept: */* 
accept-language: zh-cn 
accept-encoding: gzip, deflate 
user-agent: Mozilla/4.0 (compatible; MSIE 6.0; //应该在同一行
     Windows NT 5.1; SV1; .NET CLR 1.1.4322) 
host: localhost:8080 
connection: Keep-Alive 

下面的代码片段示例了如何使用bean:header标签读取名为User-Agent的header的值，并且使用了两种方式进行了输出：

<logic:present header="User-Agent">
     <!-- 其它标签通过绑定到page作用域中的属性使用该值 -->
     您的浏览器是<bean:header id="userAgent" name="User-Agent"/>
     <bean:write name="userAgent"/>。<br/>
     <!-- JSP脚本通过scripting变量使用该值 -->
     <%
       out.println("您的浏览器是"+userAgent+"。<br/>"); 
     %>
</logic:present>

bean:include

bean:include标签对指定url(由forward、href或page确定)处的资源做一个请求，将响应数据作为一个String类型的bean绑定到page作用域，同时创建一个scripting变量。我们可以通过id值访问它们。

下面的代码片段示例了bean:include标签的用法，其中include.txt文件包含要include的内容，然后将这些内容输出:

<bean:include id="value" page="/include.txt"/>
<!-- 其它标签通过绑定到page作用域中的属性使用该值 -->
<bean:write name="value"/><br/>
<!-- JSP脚本通过scripting变量使用该值 -->
<%
     out.println(value); 
%>

bean:message

bean:message标签用来从指定的locale中取回国际化的消息并输出，在这个过程中我们还可以传递五个以内的参数。message key可以通过key直接指定，也可以通过name和property间接的指定。

bean:message标签有两种指定message key的方式，一是通过key属性直接指定；二是通过name和property属性间接的指定，其中message key是在message resources文件中定义的。

我们可以在struts-config.xml文件中使用<message-resources>来设置message resources文件。

为了介绍该标签我使用了三个message resources文件，三个文件的名字分别为Resources.properties、Resources_en.properties和 Resources_zh.properties。在struts-config.xml文件中的设置(这里不用设置三个，struts会依据 locale自动找到对应的文件)如下：

<message-resources parameter="Resources" />

三个message resources文件中定义的message key为：

<!-- Resources.properties -->
resource=Resources.properties.
from=Resources.properties.
<!-- Resources_en.properties -->
from=Resources_en.properties.
<!-- Resources_zh.properties 
     因为文件的编码被限制为ISO8859所以要有汉字必须用jdk的native2ascii提前转换 
-->
from=Resources_zh.properties.

下面的代码片段示例了bean:message标签的用法:

<bean:message key="from"/><br/>
<bean:message key="resource"/><br/>
<html:link action="/locale?language=en">English</html:link>
<html:link action="/locale?language=zh">Chinese</html:link>

上面的代码中含有改变locale的两个html:link标签，要使它们工作您的struts-config.xml文件中必须含有下面定义的form和action:

<form-bean name="localeForm" 
       type="org.apache.struts.action.DynaActionForm">
     <form-property name="language" type="java.lang.String" />
     <form-property name="country" type="java.lang.String" />
     <!--action成功后要跳到那里-->
     <form-property name="page"     type="java.lang.String" 
       initial="/message.jsp"/>
</form-bean>
 
<action path="/locale" type="org.apache.struts.actions.LocaleAction"
     name="localeForm" scope="request">
</action>

在不同的locale下我们得到了如下的两个结果：

在locale为zh时的结果：
Resources_zh.properties.
Resources.properties.
在locale为en时的结果： 
Resources_en.properties.
Resources.properties.

让我们来看一下在locale为zh时如何得到的是上面的结果。因为locale为zh所以<bean:message key="from"/><br/>先找Resources_zh.properties这个文件从中得到form键的值。而< bean:message key="resource"/><br/>也会先找Resources_zh.properties这个文件但这次没有找到 resource键，这时Struts会到Resources.properties这个文件中找，很幸运这里找到了。如果还没有找到，或message resource文件不存在就会抛出异常。当locale为en时类似，您可以自己试试。

bean:page

bean:page标签将页上下文中的application、config、request、response 或 session取出，然后用id属性值将它们绑定到page作用域中(这种绑定是为了其它标签能够使用该值)，并创建对应的scripting变量(这种 变量是为了JSP脚本能够使用该值)。

下面的代码片段示例了bean:page标签取出response，然后使用bean:write标签将response的characterEncoding和contentType属性输出：

<bean:page id="res" property="response"/>
<!-- 其它标签通过绑定到page作用域中的属性使用该值 -->
<bean:write name="res" property="characterEncoding"/><br/>
<bean:write name="res" property="contentType"/><br/>
<!-- JSP脚本通过scripting变量使用该值 -->
<%
     String characterEncoding = res.getCharacterEncoding();
     String contentType = res.getContentType();
     out.println(characterEncoding+"<br/>"); 
     out.println(contentType+"<br/>"); 
%>

您可以用和上面类似的代码访问application、config、request 或 session中的任何一个对象。

bean:parameter

bean:parameter标签取回请求中的参数值。如果没有指定multiple属性则依据刚取回的值创建一个String类型的bean。如 果指定了multiple属性则依据刚取回的值创建一个String[]类型的数组。然后用id属性值将String或String[]绑定到page作 用域中(这种绑定是为了其它标签能够使用该值)，并创建对应的scripting变量(这种变量是为了JSP脚本能够使用该值)。

下面的两个代码片段使用相同的url传递参数，url的形式为http://127.0.0.1:8080/struts- demo/parameter.jsp?param=1&param=2&param=3。前面的代码片段中没有指定multiple属 性，因此p是String类型而且仅仅读取了参数的第一个值。后面的代码片段中指定了multiple属性的值，因此ps是String[]类型的包含所 有参数的值。

<bean:parameter id="p" name="param"/>
<bean:write name="p"/>

<bean:parameter id="ps" multiple="true" name="param"/>
<logic:iterate id="p" name="ps">
     <bean:write name="p"/><br/>
</logic:iterate>

bean: resource

bean:resource标签取回指定的web应用程序的资源，以InputStream或String的形式保存到page作用域中并且创建 scripting变量。采用什么形式取决于标签的input属性，如果指定input则以InputStream的形式保存，如果没有指定input则 以String的形式保存。

下面的两个代码片段示例了bean:resource标签，其中resource.txt是要使用的资源文件。前面的代码片段中没有指定input 属性，因此以String的形式处理资源文件，bean:write标签输出资源文件的内容。后面的代码片段中指定了input属性的值，因此以 InputStream的形式使用资源文件，两个bean:write标签分别输出InputStream对象的实例名(如 java.io.ByteArrayInputStream@16dadf9)和类名(如class java.io.ByteArrayInputStream)。

<bean:resource id="str" name="/resource.txt"/>
<!-- 其它标签通过绑定到page作用域中的属性使用该值 -->
<bean:write name="str"/><br/>
<!-- JSP脚本通过scripting变量使用该值 -->
<%
     out.println(str+"<br/>");
%>

<bean:resource id="is" input="true" name="/resource.txt"/>
<!-- 其它标签通过绑定到page作用域中的属性使用该值 -->
<bean:write name="is"/><br/>
<bean:write name="is" property="class"/>
<!-- JSP脚本通过scripting变量使用该值 -->
<%
     out.println(is+"<br/>");
     out.println(is.getClass()+"<br/>");
%>

bean:size

bean:size标签创建一个java.lang.Integer类型的bean，这个bean的值为该标签指定的Collection或Map 中所含元素的个数。 这可以和logic:iterate标签配合使用，因为logic:iterate标签不能得到所叠代的集合的元素的个数，这有时候很不方便。

下面的代码片段示例了bean:size标签取出persons中还有元素的个数，其中listForm和persons的定义参见bean:define标签部分：

<logic:notEmpty name="listForm" property = "persons">    
     <bean:size id="size" name="listForm" property = "persons"/>
     <bean:write name="size"/>    
</logic:notEmpty>     

bean:struts

bean:struts标签取回Struts的内部对象formBean、forward或mapping的值，然后用id绑定到page作用域中(这种绑定是为了其它标签能够使用该值)，并创建对应的scripting变量(这种变量是为了JSP脚本能够使用该值)。

下面的代码片段示例了bean:struts标签取出listForm对象，让我们先来看一下listForm的定义在读代码：

<!-- listForm的定义<form-bean name="listForm" 
     type="org.solo.struts.form.ListForm" /> -->
<bean:struts id="listFormBean" formBean="listForm"/>
name:<bean:write name="listFormBean" property="name"/><br/>
type:<bean:write name="listFormBean" property="type"/><br/>
dynamic:<bean:write name="listFormBean" property="dynamic"/><br/>

上面代码运行的结果为：

name:listForm 
type:org.solo.struts.form.ListForm
dynamic:false 

bean:write

bean:write标签将指定的bean的属性值写到当前的JspWriter中，并且可以对输出进行格式化。

下面的代码片段示例了bean:write标签输出User-Agent：

<logic:present header="User-Agent">
     <bean:header id="header" name="User-Agent"/>
     <bean:write name="header"/>
</logic:present>

下面的代码片段示例了bean:write标签格式化输出当前日期，其中now是在DataForm中定义的一个java.util.Date类型 的域(值为new Date())，format.date.standard是在资源文件中的一个键(format.date.standard=yyyy-MM- dd)：

<bean:define id="date" name="dataForm" property="now"/>
<br/><bean:write name="date"/>
<br/><bean:write name="date" format="MM/dd/yyyy"/>
<br/><bean:write name="date" formatKey="format.date.standard"/>

上面代码运行的结果为：

Sun Jun 04 17:04:05 CST 2006
06/04/2006
2006-06-04

html:base

虽然这里的标题是html:base标签，但是这里也是这篇指南要介绍的第一个Struts html标签。因此我想在这里从整体上简单的介绍一下，最后给出一个对照表。其中的绝大多数标签就不一一介绍了，要介绍的也不会在这里介绍，而是将其独立出来以显重要性。

从用户处收集数据是动态web应用非常重要的一个方面，因此构建输入表单也就自然而然的成为struts框架的一个重要内容。Struts html标签库含有创建Struts输入表单的标签，和其它标签库(bean、logic、nested和tiles)中的标签一起协作就可以产生基于 html的用户界面。

下面的对照表会使您对Struts html标签库有一个整体的印象：

 

图示 1. Struts HTML标签和HTML元素对照表

 

html:cancel

html:cancel标签生成一个取消按钮。当点击该按钮后action servlet会绕过相应的form bean的validate()方法，同时将控制权交给相应的action。在该action中可以使用Action.isCancelled (HttpServletRequest)方法判断是否被取消了。如果返回true表示这个action被取消了，否则表示这个action没有被取消。

请注意，如果您修改了html:cancel标签的property属性值，那么struts提供的cancel探测机制就失效了，您自己必须提供类似的机制。

下面是可取消的action的配置文件，注意<set-property property="cancellable" value="true"/>这一行，如果不添加Struts会抛出 org.apache.struts.action.InvalidCancelException异常。这是我在完成本指南的过程中发现的唯一向下不兼 容的地方。

<action path="/cancel" 
     type="org.solo.struts.action.CancelAction" name="cancelForm" 
       scope="request">
     <set-property property="cancellable" value="true"/>
     <forward name="success" path="/cancel.jsp" />
</action>

下面是html:cancel标签的代码：

<html:cancel>取消</html:cancel>

下面是对应的action中的代码：

if(isCancelled(request)){     
     //action被取消时要做的事情写在这里
     return mapping.findForward("cancel");
}else{
     //action没有被取消时要做的事情写在这里
     return mapping.findForward("success");
}