在Struts中使用Validator框架_另

在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来执行，有很多种方法漏掉它。为了确保校验一直有效,无论你运行客户端校验还是不运行，服务器端校验都会一直有效。