Struts標籤
Struts提供了非常多的標籤,依據功能和使用習慣的不同被分到了五個標籤庫中:
- Bean Tags:該標籤庫包含的標籤可以用來創建bean、訪問bean和訪問bean的屬性。同時提供了依據cookies、headers和parameters的值創建相關bean的能力。
- HTML Tags:該標籤庫包含的標籤可以用來創建Struts輸入表單。
- Logic Tags:該標籤庫包含的標籤可以用來進行邏輯判斷、集合迭代和流程控制。
- Nested Tags:該標籤庫建立在前三個標籤庫的基礎上,具有前三個標籤庫的所有功能,只是允許標籤間的嵌套。
- Tiles Tags:該標籤庫包含的標籤可以用來創建tiles樣式的頁面。
這篇指南主要介紹前三個標籤庫中的標籤。如果您對後兩類標籤也感興趣可以查閱參考資料中的Struts的用戶指南。
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標籤在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標籤取回請求中名稱爲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標籤對指定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標籤用來從指定的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標籤將頁上下文中的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標籤取回請求中的參數值。如果沒有指定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¶m=2¶m=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標籤取回指定的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標籤創建一個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標籤取回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的屬性值寫到當前的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標籤,但是這裏也是這篇指南要介紹的第一個Struts html標籤。因此我想在這裏從整體上簡單的介紹一下,最後給出一個對照表。其中的絕大多數標籤就不一一介紹了,要介紹的也不會在這裏介紹,而是將其獨立出來以顯重要性。
從用戶處收集數據是動態web應用非常重要的一個方面,因此構建輸入表單也就自然而然的成爲struts框架的一個重要內容。Struts html標籤庫含有創建Struts輸入表單的標籤,和其它標籤庫(bean、logic、nested和tiles)中的標籤一起協作就可以產生基於html的用戶界面。
下面的對照表會使您對Struts html標籤庫有一個整體的印象:
圖示 1. Struts HTML標籤和HTML元素對照表
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");
}
html:select標籤生成一個select元素。是單選還是多選取決於該標籤的multiple屬性。如果指定了multiple="true"則爲多選,此時對應的屬性應該是一個數組。如果沒有指定multiple="true"則爲單選,此時對應的屬性應該是標量。
注意:爲了正確的處理沒有做任何的選擇的情況,在ActionForm中的reset()方法中必須將標量屬性設置爲默認值而將數組的長度置爲0。
另外的一個重要問題就是struts如何生成option元素了,這個任務struts交給了html:option、html:options和html:optionsCollection三個標籤。
html:option標籤
html:option標籤生成一個HTML的option元素。該標籤必須嵌在html:select標籤中。它的顯示文本來自其標籤體,也可以來自於資源文件。它的value屬性用來指定什麼值將要被提交。
<html:option value="one">one</html:option>
<html:option value="two">two</html:option>
html:options標籤
html:options標籤生成多個HTML的option元素。該標籤必須嵌在ht