Struts Validator验证器使用指南(二)

一个简明的Struts验证器API指南 可以帮助你开始。

验证器资源

Struts Validator: Validating Two Fields Match作者Matt Raible。（两个字段匹配验证）关于使用方法的文章。（范例部分为翻译此文内容）

DynaForms and the Validator作者James Turner and Kevin Bedell。Struts Kickstart的其中一章（动态form和验证器），可以自由下载PDF).

Validating user input作者 David Winterfeldt and Ted Husted。Struts in Action的其中一章，可以自由下载(PDF)。

 

使用方法

作者：

丑陋 && Snowtears：经过2周的不懈努力，阅读了大量的资料，终于对Validator有了个初步的认识，整理了一下，浅浅的谈了谈写法，希望能有一定的帮助，其中肯定有许多说的不对不准确的地方，还请多指教 [e-mail]<o:p></o:p>

       王艺：

       根据以上两位的文章正理而成

配置ruts-config.xml：

1、            添加ApplicationResources配置文件。

如：

<!-- ========== Message Resources Definitions =========================== -->

<message-resources parameter="com.dc.sibss.om.struts.ApplicationResources" />

其中com.sibss.om.struts.ApplicationResources"的部分是资源文件的路径，此文件的作用是提供错误信息的非编程定制化和多语言支持。如果我们使用中文平台操作系统，则默认情况下将首先查找ApplicationResource_zh_CN.properties文件，然后是ApplicationResources_zh.properties，如果前两个文件没有被找到则将查找ApplicationResources.properties文件。

为了能够在页面上显示错误提示信息，我们还需要将以下内容添加到ApplicationResources.properties文件的末尾：

              errors.required={0} is required.

errors.minlength={0} cannot be less than {1} characters.

errors.maxlength={0} cannot be greater than {2} characters.

errors.invalid={0} is invalid.

errors.byte={0} must be an byte.

errors.short={0} must be an short.

errors.integer={0} must be an integer.

errors.long={0} must be an long.

errors.float={0} must be an float.

errors.double={0} must be an double.

errors.date={0} is not a date.

errors.range={0} is not in the range {1} through {2}.

errors.creditcard={0} is not a valid credit card number.

errors.email={0} is an invalid e-mail address.

以上仅是struts现在支持的错误类型的错误提示信息，如果你自定义了新类型的错误验证，则还需要在此加上你自己的内容。

以上内容中的{0}指的是错误提交的参数。比如：当你需要页面上的“用户名”不能为空时（也就是上面的errors.required），这个{0}就代表“用户名”，所以如果你没有填写用户名将抛出如下错误：

       用户名 is required.（你可以根据需要修改称中文）<o:p></o:p>

我们可能已经注意到了，既然错误提示信息需要配置，那么上例中“用户名”系统是如何得到的呢？没错！也是通过修改此配置文件，内容如下：

       visitCust.error.name.required=<br>用户名

这样当“用户名”为空时，struts后台程序将联合以上两处定义显示错误信息。

另外，上面的“visitCust.error.name.required”是在Validation.xml配置验证内容时指定的。具体见以下介绍。

注意：一般情况下，你的系统只需要一个ApplicationResources文件，所以开发组的成员不要添加自己的resource文件。只有在你的项目分组开发时才需要使用多个ApplicationResources文件，但是，同时你的struts-config.xml文件也会有相同的数量对应。

2、            在struts-config.xml文件中加入validator插件：

加入这个插件后你的应用就具备使用Validator的环境，如：

<!-- ========== Plug Ins Configuration ================================== --><o:p></o:p>

<plug-in className="org.apache.struts.validator.ValidatorPlugIn"><o:p></o:p>

<set-property value="/WEB-INF/validator-rules.xml,/WEB-INF/validation.xml" property="pathnames" /><o:p></o:p>

</plug-in>

这里如果是想使用多个***.xml文件的话，value部分写法如下value="/WEB-INF/validator-rules.xml,/WEB-INF/validation.xml, /WEB-INF/validation1.xml , /WEB-INF/validation2.xml "

在<action-mappings>里，定义需要验证的画面对应的Action的时候要加上validate="true"

四种使用方法

1、            用Javascript在客户端进行验证

配置：在需要验证的JSP文件中写入

<html:form action="/XXX" onsubmit="return validateXXXX(this);"><o:p></o:p>

这里的XXX 是与要进行验证的 forward name，validateXXXX (this);里面的XXXX是需要进行验证的ActionForm名。

<html:javascript formName="mytestForm"/><o:p></o:p>

在validation.xml文件中写入验证代码就可以进行基本的验证了。这种方法是在客户端进行验证，客户端可以看到JAVASCRIPT部分的全代码。安全性不高

2、            ValidatorForm的validate方法

1、validate（）方法：使自己的ActionForm继承ValidatorForm类，在里面编写自己的方法：

public ActionErrors validate (ActionMapping mapping,HttpServletRequest request) {

ActionErrors errors = new ActionErrors();<o:p></o:p>

。。。。。。

if ( mytext.equals("aaa") ) {

//my exampleerrors.add("mytext",new ActionError("mytext.error"));

}

。。。。。。

return errors;<o:p></o:p>

}

此时，如果写了这个方法，就会屏蔽掉在Validation.xml中定义的验证部分，换句话说就是系统运行时，Validation.xml里对应此ActionForm的定义的错误验证部分不实行，如果不写这个方法的话，系统运行时会进行Validation.xml里对应此ActionForm的定义的错误验证部分的操作。此类方法是在服务器端进行验证，验证部分代码客户端不可见。

2、创建你的ActionForm并让它继承org.apache.struts.validator.ValidatorForm类。创建你的Action实现，并和上面定义的ActionForm关联。这里需要注意的是，在定义此Action时一定将validate属性设置为true，并且在你定义的ActionForm中不要实现它的validate方法――这就意味着你将使用ValidatorForm的validate方法，这样才能保证你的错误验证正常进行。配置validation.xml文件。基本内容如下：

<form-validation>

<!-- ========== Default Language Form Definitions ===================== -->

    <formset>

              <form name="custGNewForm">需要验证页面上form的名字

                     <field property="certifiCode"需要校验的属性

                                   depends="required,maxlength">校验内容

                            <arg0 key="prompt.certifiCode"/>ApplicationResource文件中对应

                            <arg1 key="${var:maxlength}" name="maxlength" resouce="false"/>

                            <var>确定最长限制的长度

                                   <var-name>maxlength</var-name>

                                   <var-value>20</var-value>

                            </var>

                     </field>

注意：此处的arg0和arg1就代表了ApplicationResources文件中使用“{}”括起来的参数。比如：<o:p></o:p>

errors.range={0} is not in the range {1} through {2}.<o:p></o:p>

定义了三个参数，所以你这里也要定义<arg0>、<arg1>、<arg2>三个参数才能完整的显示错误信息。<o:p></o:p>

errors.maxlength={0} cannot be greater than {2} characters.<o:p></o:p>

定义了0、2两个参数，所以你就需要定义<arg0>和<arg2>两个参数。<o:p></o:p>

                     <field        property="userName"

                                   depends="required,maxlength">

                            <arg0 key="prompt.userName"/>

                            <arg2 key="${var:maxlength}" name="maxlength" resouce="false"/>

                            <var>

                                   <var-name>maxlength</var-name>

                                   <var-value>80</var-value>

                            </var>

                     </field>

                     <field property="email"

                    depends="email">

                <arg0 key="prompt.email"/>

            </field>

              </form>

              <form name="custGNewCheckForm">

                     <field       property="certifiCode"

                                   depends="required">

                            <arg0 key="prompt.certifiCode"/>

                     </field>

              </form>

    </formset>

</form-validation>

在校验页面的<body>前添加如下内容：<html:errors/>

3、            DynaValidatorForm

不需要再写对应的ActionForm，只需在struts-config.xml里把自己的ActionForm进行配置：

<form-bean name="testForm" type="org.apache.struts.validator. DynaValidatorForm">

       <form-property name="mytext" type="java.lang.String"/>

<form-property name="mytextarea" type="java.lang.String"/>

       <form-property name="mydatetext" type="java.lang.String"/>

</form-bean>

在form-property里设置相应的项目，比如说mytext，mytextarea什么的，执行的时候会动态生成ActionForm，再在validation.xml里写入所希望的验证代码，就可以了。JSP文件里不需要写入任何东西，验证也是在服务器端进行，验证部分代码在JSP中不可见。

4、            组合验证

如果使用动态验证DynaValidatorForm的话，不许编写自己的对应的ActionForm，相应的特殊验证会受到相当程度的限制。这个时候，需要将特殊验证部分写入对应的Action，

if(mytext.equals("aaa")){//My Example

ActionErrors errors = new ActionErrors();

errors.add("***",new ActionError("***.error"));      

saveErrors(request,errors);<o:p></o:p>

return (mapping.findForward("false"));

}

就可以实现特殊验证了。

 <o:p></o:p>

       实际上你的FORM还可以继承ValidatorActionForm和DynaValidatorActionForm，这两种与他们对应的ValidatorForm和DynaValidatorForm的唯一区别正如开篇就讲到的：在struts-config.xml中查找对应的FORM类时，前者根据ACTION的PATH值，而后者使用NAME值。

范例：

Struts 验证器：验证两个字段匹配<o:p></o:p>

在使用指南中，有一节讲述怎样创建验证器来验证两个字段匹配，我用这个服务器端验证器（象例子中显示的那样）做口令，确定口令验证。这个已经可以正常工作了；但我还想用客户端的javascript验证器来试一试。我写了自己的程序来比较两个字段，但他们和推荐给你的那个不同（from validator-rules.xml）。所以昨天，我补充了怎样添加JavaScript方法到validator-rules.xml。 这里就是怎样配置的的整个过程（大部分在使用指南中已经包含了，保存JavaScript）。<o:p></o:p>

怎样添加两个字段的验证器<o:p></o:p>

Step 1: 生成一个包含validateTwoFields方法的类。在我的代码重，我的类定义为ValidationUtil，他有下列方法：

 <o:p></o:p>

public static boolean validateTwoFields(

Object bean,

ValidatorAction va,                                       

Field field,

ActionErrors errors,

HttpServletRequest request) {

 <o:p></o:p>

    String value = ValidatorUtil.getValueAsString(bean, field.getProperty());

    String sProperty2 = field.getVarValue("secondProperty");

String value2 = ValidatorUtil.getValueAsString(bean, sProperty2);

 <o:p></o:p>

    if (!GenericValidator.isBlankOrNull(value)) {

        try {

            if (!value.equals(value2)) {

                errors.add(field.getKey(),

                           Resources.getActionError(request, va, field));

 <o:p></o:p>

                return false;

            }

        } catch (Exception e) {

            errors.add(field.getKey(),

                       Resources.getActionError(request, va, field));

 <o:p></o:p>

            return false;

        }

    }

 <o:p></o:p>

    return true;

}

Step 2: 编辑 validator-rules.xml ，加入"twofields" 规则。<o:p></o:p>

<validator name="twofields" classname="org.appfuse.webapp.util.ValidationUtil"

method="validateTwoFields"

    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" msg="errors.twofields">

    <javascript><![CDATA[

        function validateTwoFields(form) {

            var bValid = true;

            var focusField = null;

            var i = 0;

            var fields = new Array();

            oTwoFields = new twofields();

            for (x in oTwoFields) {

                var field = form[oTwoFields[x][0]];

                var secondField = form[oTwoFields[x][2]("secondProperty")];

           

                if (field.type == ′text′ ||

                    field.type == ′textarea′ ||

                    field.type == ′select-one′ ||

                    field.type == ′radio′ ||

                    field.type == ′password′) {

           

                    var value;

                    var secondValue;

                    // get field′s value

                    if (field.type == "select-one") {

                        var si = field.selectedIndex;

                        value = field.options[si].value;

                        secondValue = secondField.options[si].value;

                    } else {

                        value = field.value;

                        secondValue = secondField.value;

                    }

               

                    if (value != secondValue) {

                   

                        if (i == 0) {

                            focusField = field;

                        }

                        fields[i++] = oTwoFields[x][1];

                        bValid = false;

                    }

                }

            }

           

            if (fields.length > 0) {

                focusField.focus();

                alert(fields.join(′\n′));

            }

           

            return bValid;

        }]]></javascript>

</validator>

Step 3: 在validation.xml中为你的表单配置验证：<o:p></o:p>

<field property="password" depends="required,twofields">

  <msg name="required" key="errors.required"/>

  <msg name="twofields" key="errors.twofields"/>

  <arg0 key="userForm.password"/>

  <arg1 key="userForm.confirmPassword"/>

  <var>

    <var-name>secondProperty</var-name>

    <var-value>confirmPassword</var-value>

  </var>

</field>

这里errors.twofields的字段 ′{0}′必须与字段′{1}′ 的值相同。第三步的一个可选的工作就时使用 XDoclet 来生成validation.xml。requires (1) 配置XDoclet (当然)和(2) 在你的表单中添加添加一些@struts 标签setPassword方法。<o:p></o:p>

/**

 * Returns the password.

 * @return String

 *

 * @struts.validator type="required" msgkey="errors.required"

 * @struts.validator type="twofields" msgkey="errors.twofields"

 * @struts.validator-args arg1resource="userForm.password"

 * @struts.validator-args arg1resource="userForm.confirmPassword"

 * @struts.validator-var name="secondProperty" value="confirmPassword"

 */

public String setPassword() {

       return password;

}

我昨天已经把这个作为建议发送给struts-dev邮件列表, 但还没有收到任何消息。

来源:http://www.java-asp.net/java/200511/t_44525.html