1 validation framework
在Struts framework中,ActionForm对象用来包装HTML表格数据(包括请求),并返回返回动态显示给用户的数据。它们必须是完全的JavaBean,并继承.Struts里面的ActionForm类,同时,用户可以有选择地覆盖两个缺省方法validate()和reset()。
这样做的缺点:
1.校验代码冗余,不可重用。
2.维护起来很困难。
validation framework将actionForm中的校验部分分离出来,通过配置文件实现。
下面将我在使用validation时总结的经验书写于下。由于时间紧张,所以对原文基本没有做修改,可能有些乱,请见谅。
1.1 组成与配置
1.1.1 组成
包:commons-validator.jar 、 jakarta-oro.jar、
配置文件: validator-rules.xml、validation.xml
1.1.2 配置
要求:
1、在web-inf/目录下有validation.xml,validator-rules.xml文件
2、在web-inf/struts-config.xml中有如下内容
<!-- ========== Message Resources Definitions =========================== -->
<message-resources parameter="org.apache.struts.webapp.validator.ApplicationResources"/>
<!--=====修改为你自己的ApplicationResources文件的路径 ============== -->
<!-- ========== Plug Ins Configuration ================================ -->
<plug-in className="org.apache.struts.validator.ValidatorPlugIn">
<set-property property="pathnames" value="/WEB-INF/validator-rules.xml,/WEB-INF/validator.xml"/>
</plug-in>
1.2 validation-rules.xml
validation-rules.xml定义了一套通用的校验规则,这些规则将在validaion.xml中被引用。你也可以自定义一些规则加到这个文件中,也可以单独存入一个文件。例如:
<validator
name="minLength"
classname="org.apache.struts.util.StrutsValidator"
method="validateMinLength"
methodParams="java.lang.Object,
org.apache.commons.validator.ValidatorAction,
org.apache.commons.validator.Field,
org.apache.struts.action.ActionErrors,
javax.servlet.http.HttpServletRequest"
depends="required,integer"
msg="errors.minlength">
</validator>
属性
描述
name
指定一个规则名,用来被其它规则引用
ClassName
包含校验规则的类
method
此校验规则在类中实际对应的方法
methodParams
Method方法的参数
depends
引用其它的规则(在当前规则之前被调用)
msg
资源文件中的关键字,当校验不通过时,此关键字中的信息将加入到errors集合中。
jsFunctionName
指定一个JavaScript函数名
”rg.apache.struts.util.StrutsValidator” 定义了以下方法:
· validateByte
· validateCreditCard
· validateDate
· validateDouble
· validateEmail
· validateFloat
· validateInteger
· validateLong
· validateMask
· validateMinLength
· validateMaxLength
· validateRange
· validateRequired
· validateShort
1.3 validation.xml
validation.xml关联ActionForm和validaion-rules.xml,定义了ActionForm中各个属性的校验规则。例如:
<form-validation>
<global>
<constant>
<constant-name>phone</constant-name>
<constant-value>^\(?(\d{3})\)?[-| ]?(\d{3})[-| ]?(\d{4})$</constant-value>
</constant>
</global>
<formset>
<form name="checkoutForm">
<field property="phone" depends="required,mask,minLength">
<msg name="mask" key="phone.invalidformat"/>
<arg0 key="registrationForm.firstname.displayname"/>
<arg1 name="minlength" key="${var:minLength}" resource="false"/>
<var>
<var-name>mask</var-name>
<var-value>${phone}</var-value>
</var>
<var>
<var-name>minLength</var-name>
<var-value>5</var-value>
</var>
</field>
</form>
</formset>
</form-validation>
这个配置文件指定用”required,mask,minLength”三个规则校验”checkoutForm”中的”phone”属性:”phone”的值不可为空,必须大于或等于5个字符,字符必须满足${phone}定义的规则。
<form>:指定要校验的ActionForm
属性
描述
name
指定要校验的ActionForm的名字
<field>:指定要校验ActionForm的哪一个属性
属性
描述
property
指定要校验的ActionForm中的属性名
depends
所用的校验规则,在validation-rules中定义
page
?当此属性的值小于或等于与此form相关的javabean的page值时,此field才会被处理
indexedListProperty
?The method name that will return an array or a Collection used to retrieve the list and then loop through the list, performing the validations for this field.
<msg>:校验失败时加到Action Errors中的信息,用来替代validator-rules中默认的错误信息
属性
描述
name
使用校验的规则名
key
资源文件中的key或自定义的值
Resource
当设为false时,key值可自定义
<arg>:一共可定义4个(arg0..arg3),作用是向资源文件提供参数的值。属性同<msg>
为了使用服务器端验证,Action Form 实现类应该扩展 ValidatorForm 而不是 ActionForm。当提交表单时,会执行 ValidatorForm 中的 validate() 方法,它将根据 validation-rules.xml 和 validation.xml 文件进行验证。
需要在 JSP 文件中的开头(即 <html:form> 前)添加 <html:errors/> 行以使错误显示出来。
这与使用客户端校验不同。
1.4 使用客户端的校验
(1) 将<html:javascript formName="checkoutForm"/>加在jsp文件末尾,即</html:html>前。
它的作用是将validation-rules.xml中与”checkoutForm”相关的校验规则的javascript函数页面中。
(2) 在<html:form>中onsubmit属性。例如:<html:form action="/saveArticleType" onsubmit="return validateCheckoutForm(this);">
说明:validateCheckoutForm()方法是在步骤(1)中自动生成的。<html:javascript>将根据formName的属性值(例如:xxx),生成validatexxx()方法。
(3) Action Form 应该去掉Validator方法。
2 扩展对象选择
在为Form选择扩展对象时,要注意:Struts框架提供了两种选择。第一种选择是使用ValidatorForm或者DynaValidatorForm;第二种选择是使用ValidatorActionForm或者DynaValidatorActionForm。
使用第一种方式的时候,在Validator.xml中的form元素的name属性必须和struts-config.xml中的action元素的name属性相匹配。
使用第二种方式时,则是与struts-config.xml中的action元素的path属性相匹配。