在Struts中使用Validator框架
Validator 框架是一個對FormBean應用校驗規則的可插入的系統。每一個校驗規則都是一個Java方法的響應,該方法執行一類校驗,可能pass也可能 fail。缺省情況下,Validator中的校驗規則可以滿足大多數校驗需求。當然,你也可以創建自己的校驗規則。另外,Validator支持服務器端和客戶端(javascript)校驗,然而Form Bean僅提供服務器端校驗接口。
使用Validator包括如下三步:
1、啓用Validator插件;
2、生成Form Bean類;
3、修改配置文件。
下面將詳細說明如何配置和使用Validator。
一、啓用Validator插件
Validator使用兩個XML配置文件來決定安裝 哪些校驗規則和如何應用。
第一個配置文件是:validator-rules.xml,聲明校驗規則,並提供每個校驗的邏輯名稱,同時爲每個校驗規則定義客戶端JavaScript代碼。Valicator能給發送這些JavaScript代碼給瀏覽器。
第二個配置文件:validation.xml,定義哪些校驗規則被應用到哪些Form
Bean上。這個文件將struts-config.xml文件中Form
Bean的邏輯名和validator-rules.xml文件中的校驗規則名綁定在一起
雖然在Struts工具包中包含了Validator,但默認情況下Validator是沒有被啓用的。若要啓用Validator,必須在struts-config.xml文件中添加入下的代碼:
<!-- Validator Configuration -->
<plug-in className="org.apache.struts.validator.ValidatorPlugIn">
<set-property property="pathnames"
value="/WEB-INF/validator-rules.xml,/WEB-INF/validation.xml"/>
</plug-in>
其中,指定的兩個配置文件的路徑應爲相對於所在模塊的路徑,以上代碼應按照和stuts-config.xml配置文件相對應的DTD文件所要求的格式,放到合適的位置。
二、生成Form
Bean類
爲了使用Validator,Form Bean必須繼承Validator的ActionForm類。Validator的ActionForm子類提供了一個validator()方法的執行,可以簡單地忽略該方法,因爲Validator提供了校驗代碼。
Validator 提供了兩種創建Form Bean的方法:
第一種直接繼承ValidatorForm類,而非ActionForm類。這個類不必提供reset()和validator()方法。
第二種是創建動態Form Bean,用org.apache.struts.validator.DynaValidatorForm 來代替org.apache.struts.action.DynaActionForm。
但是在很多情況下,是多個action共用同一個form,如果其中一個action只用了form中的一部分屬性,那麼Validator會因爲找不到其它屬性而報錯,這時可以用 ValidatorActionForm 或者org.apache.struts.validator.DynaValidatorActionForm。
在Form Bean類中要包含和Form表單中各字段相對應的成員變量,然後公開各成員變量的get及set方法。
示例代碼如下:
package com.my;
import org.apache.struts.validator.ValidatorForm;
public class MyForm extends ValidatorForm{
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
private String name;
private String age;
}
三、修改配置文件
在struts-config.xml文件中指定Form Bean。
示例代碼如下:
<form-beans>
<form-bean name="MyForm" type="com.my.MyForm"/>
</form-beans>
Struts開發包中存在validatotr-rules.xml文件,將其拷貝到應用模塊的WEB-INF目錄下(當然也可以自己新建並編寫此文件)。在同一目錄下新建validation.xml文件。
validation.xml用於聲明應用於Form Bean的校驗。每一個需要校驗的From Bean都要有它自己的定義在這個文件中。
form-validation元素是master元素,整個文件只定義一次。在form-validation元素中,定義form-set元素,在 form-set元素中封裝多個form元素。通常,定義一個form-set元素就夠了,但是如果應用需要支持多國語言,就需要定義多個form- set。
Validator用邏輯名稱來把校驗與Form Bean對應起來。field元素的property屬性對應於Form Bean的屬性。depends屬性定義校驗規色的邏輯名稱。並編寫驗證內容。爲了方便編寫,引入相應的DTD文件(推薦validator_1_1_3.dtd)。
示例代碼如下:
<form-validation>
<formset>
<form name="MyForm">
<field property="name"
depends="required,minlength,maxlength">
<arg0 key="name" resource="false"/>
<arg1 name="minlength"
key="${var:minlength}"
resource="false"/>
<arg1 name="maxlength"
key="${var:maxlength}"
resource="fasle"/>
<var>
<var-name>minlength</var-name>
<var-value>4</var-value>
</var>
<var>
<var-name>maxlength</var-name>
<var-value>16</var-value>
</var>
</field>
<field property="age"
depends="required,integer,intRange">
<arg0 key="age" resource="false"/>
<arg1 name="intRange"
key="${var:min}"
resource="false"/>
<arg2 name="intRange"
key="${var:max}"
resource="false"/>
<var>
<var-name>min</var-name>
<var-value>1</var-value>
</var>
<var>
<var-name>max</var-name>
<var-value>100</var-value>
</var>
</field>
</form>
</formset>
</form-validation>
由於Validator 用Struts的Resource
Bundle機制來輸出錯誤信息。所以Validator允許你在ApplicationResources.properties文件中爲一條錯誤信息
定義定義一個key,如果校驗失敗,該key值所指的信息將被返回。在validator-rules.xml文件中,每一條校驗規則都用
validator
tag 的msg屬性,指定了錯誤信息的key值。
其內容如下:
# Struts Validator Error Messages
errors.required={0} is required.
errors.minlength={0} can not be less than {1} characters.
errors.maxlength={0} can not be greater than {1} characters.
errors.invalid={0} is invalid.
errors.byte={0} must be a
byte.
errors.short={0} must be a short.
errors.integer={0} must be an integer.
errors.long={0} must be a long.
errors.float={0} must be a float.
errors.double={0} must be a double.
errors.date={0} is not a
date.
errors.range={0} is not in the range {1} through {2}.
errors.creditcard={0} is an invalid credit card number.
errors.email={0} is an invalid e-mail address.
注意每一條信息都有一個佔位符,運行時,佔位符將被具體的值取代。每條錯誤信息至多有4個佔位符。如果你不想使用Resource
Bundle機器定義佔位符得值,也可以用如下明確地指定佔位符的值:
arg0 key="Auction Bid" resource="false"
上面例子中,resource屬性設置爲false用來告訴Validator,由key屬性定義得值直接代替佔位符。
爲了使容器能夠加載資源文件,還要在struts-config.xml文件中進行設置,在適當位置添加如下代碼:
<message-resources parameter="com.my.application"/>
至此,Validator配置工作已經完成。若要測試Validator,還需要編寫表單(JSP)頁面,建立Action以及配置ActionMapping等工作。
客戶端校驗
每一個校驗規則可以選擇定義Javascript玳瑁,這些代碼可以在瀏覽器端運行,只有這些JavaScript代碼運行通過,form才能被提交。
爲了運行客戶端校驗,要在JSP中需要被校驗的地方插入以下Struts HTMLTag
html:javascript formName="logonForm"
所有爲form定義的校驗都不僅運行在服務器端,還運行在客戶端。因爲客戶端校驗由JavaScript來執行,有很多種方法漏掉它。爲了確保校驗一直有效,無論你運行客戶端校驗還是不運行,服務器端校驗都會一直有效。