Validator验证框架

Validator验证框架使用教程
发表于：2007年7月10日 1时0分29秒来源：权限: 公开阅读(183)评论(0) 举报本文链接：http://user.qzone.qq.com/119887/blog/8

Validator验证框架使用教程
Validator验证框架使用教程
2006年10月17日 星期二 10:09
Terry原创，转载请说明作者及出处。


使用平台：Eclipse3.2+MyEclipse5.01GA

首先，Validator验证框架最好要在Struts1.2下使用，当然在Struts1.1下也是可行的，只是在Struts1.2下能支持得更好。

在Struts-Config.xml配置文件里添加插件，或是把下面的文本内容复制到Struts-Config.xml中：

  <plug-in    className="org.apache.struts.validator.ValidatorPlugIn">
 <set-property property="pathnames"
 value="/WEB-INF/validator-rules.xml,/WEB-INF/validation.xml" />  </plug-in> 

在MyEclipse下建立validation.xml的步骤如下：
在项目的根目录处点击鼠标右键，选择新建“XML(Basic Templates)”，在弹出的窗口中选择“Create XML file from a DTD file”下一步，将文件目录设置到WEB-INF下，文件名取为“validation.xml”下一步；在这里点击“Select XML Catalog entry”选项，并选择KEY名为“-//Apache Software Foundation//DTD Commons Validator Rules Configuration 1.1.3//EN”的选项，下一步；此处已经不需要再设置什么，直接点击“Finish”完成validation.xml的建立，通过这样的建立文件，在编辑过程中输入"<"符号后，编辑器就会自动查找与当前结构匹配的Validator标签。


下面介绍一下validation.xml配置文件的标签：

<form-validation></form-validation>是总框架
<formset></formset>是对Form里的数据进行配置
<form name="ActionForm对应的名称"></form>对一个ActionForm里的数据进行验证配置
<field property="ActionForm里的属性名" depends="验证规则，可以是Validation-rules里定义好的也可以是自定义的验证规则">这里配置一个属性的验证内容
<arg0 name="对应的验证规则名称" key="可以直接填入数值，也可填入变量表达式：${var：变量名}" resource="true/false"(代表是否从资源文件中读取信息，否则Key的值以参数的形式返回)>
<var></var>定义一个变量的标签体，可以在里面具体设置变量的名称以及数值
<var-name>对应Key里定义的变量名称</var-name>
<var-value>值</var-value>
<msg name="对应的验证规则名称" key="资源文件中定义的变量名称">这里定义了信息变量后，会默认定义的信息变量。
在验证规则中大部分可以使用已经预定义好的规则，它们在validator-rules.xml里，当然我们自己也可以定义规则。

实例如下：

<form-validation>
  <formset>
    <form name="employeeActionForm">
    <field property="vname" depends="required,maxlength">
      <arg0 key="employee.name"/>
      <arg1 name="maxlength" key="${var:maxlength}" resource="false"/>
      <var>
        <var-name>maxlength</var-name>
        <var-value>10</var-value>
      </var>
    </field>
    <field property="vsex" depends="required,maxlength">
      <arg0 key="employee.sex"/>
      <arg1 name="maxlength" key="${var:maxlength}" resource="false"/>
      <var>
        <var-name>maxlength</var-name>
        <var-value>5</var-value>
      </var>
    </field>
    <field property="vage" depends="required,integer,intRange">
       <arg0 key="employee.age"/>
      <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>
    <field property="vmoney" depends="integer">
      <arg0 key="employee.money"/>
    </field>
    </form>
  </formset></form-validation>

要想在ActionForm里应用上Validator框架，就必须继承ValidatorForm类；
在MyEclipse下新建ActionForm时可以将其SuperClass设置为“org.apache.struts.validator.ValidatorForm”
如果是已经建好的ActionForm要改为使用Validator验证需如下操作：
导入org.apache.struts.validator.ValidatorForm包，将类ActionForm扩展类从原先的ActionForm改为ValidatorForm
而原先的public ActionErrors validate(ActionMapping mapping,HttpServletRequest request)和
public ActionErrors validate(ActionMapping mapping, ServletRequest request)
以及Reset方法去除即可。


应用程序全局资源文件：ApplicationResources.properties
可以在文件里添加错误提示信息，格式为：
变量名：提示文本（注：若要使用中文信息则要在转换之前将中文的文本填写完，转换后文件名后需要加上_zh_CN才会被系统识别为简体中文）
内容如下：
employee.name=员工姓名employee.sex=员工性别employee.age=员工年龄employee.money=期望薪金errors.required={0}不能为空，请填写！errors.integer={0}必需为一个整数值errors.range={0}必需为1～100之间的一个数字errors.maxlength={0}的最大数不能越过{1}！
注：若需要换行可以在文本后面加上"<br>"；

以上的例子只是说明了资源文件的使用方法，但是如果就想这样来显示中文提示信息是不可行的，


转换的命令是：
native2ascii -encoding gb2312 ApplicationResources.properties ApplicationResources_zh_CN.properties

native2ascii命令是Java JDK目录下BIN目录里的一个可执行文件，若发现不能执行，请修改系统环境变量，即在Path变量里加入"X:\...\jdk1.5.1\bin;"，修改完需要重新启动系统所配置的环境变量才可生效。
可将命令制作成批命令，注意：转换格式后，在工程里需要手动刷新文件，否则项目不会识别你所做的改动


到这里Validator验证框架的所有配置已经完成此时你只要在页面相应位置放入<html:errors/>标签即可显示，这样是将所有的错误在同一个地方显示，若想实在在每个输入控件后面显示错误提示，就必须手动设置标签的属性，如：<html:errors property="XXX">；


用Validator（验证器）提供的丰富的内置验证方法简化Struts的开发过程。
　　
　　Struts框架的一个主要好处是它提供了对接收到的表单数据进行验证的内置界面。如果有任何验证失败，则应用程序都会重新显示HTML表单，这样就可以改正无效的数据了。如果验证成功，则处理过程会继续进行。Struts框架的简单验证界面会减少与处理数据验证有关的令人头疼的事情，这样你就可以把精力集中到验证代码上，而不是放到捕获数据、重新显示不完整或无效数据的技巧上。
　　
　　但是，Struts内置的验证界面也有缺点。例如，在整个应用程序中验证代码常常会大量重复，因为许多域需要相同的验证逻辑。对一些相似字段的验证逻辑进行任何修改都要求在几个地方修改代码，还要重新编译受影响的代码。为了解决这个问题并增强Struts验证界面的功能，作为Struts的第三方附加件创建了Validator框架。后来，Validator被集成到核心Struts代码库中，并从Struts中分离出来，现在它是一个独立的Jakarta Commons项目。虽然Validator是一个独立的框架，但它仍能与其他程序封装在一起后提供，并与Struts无缝集成。
　　
　　Validator概述
　　没有Validator，你就不得不编写验证表单数据所需的全部代码，并把它放入Form Bean对象的validate( )方法中。对于想在其上进行数据验证的每个Form Bean域来说，都需要编写逻辑代码来实现验证。此外，你还必须编写代码来存储验证失败时的出错消息。
网管下载dl.bitscn.com


　　
　　有了Validator，你就不必在Form Bean中编写用于验证或存储错误消息的任何代码。相反，Form Bean提供了Validator的一个ActionForm子类，它提供验证或存储错误消息的功能。
　　
　　可把Validator框架作为一个可用于Form Bean验证的可插入的验证例行程序系统来进行安装。每个验证例行程序都只是一个Java方法，负责执行特定类型的验证任务，验证可能通过，也可能失败。 默认情况下，Validator与几个有用的验证例行程序封装在一起来提供，这些例行程序能满足大多数情况下的验证要求。但是，如果Validator框架没有提供你需要的验证例行程序，那么你可以自己创建定制的验证例行程序，并将它插入到该框架中。此外，Validator还支持服务器端和客户端（JavaScript）的验证，而Form Bean只提供服务器端验证界面。
　　
　　Validator使用两个XML配置文件来分别确定安装哪个验证例行程序和如何将它们应用于给定的应用程序。第一个配置文件validator-rules.xml说明应该被插入到框架中的验证例行程序，并提供每个验证的逻辑的名称。validator-rules.xml文件还定义了每个验证例行程序的客户端JavaScript代码。可以配置Validator让它把这个JavaScript代码发送到浏览器上，这样验证就可以在客户端和服务器端进行了。
网管网www.bitscn.com

　　
　　第二个配置文件validation.xml确定哪个验证例行程序应用到哪个Form Bean。文件中的定义使用struts-config.xml文件给出的Form Bean的逻辑名称以及validator-rules.xml文件给出的验证例行程序的逻辑名称，以便把二者关联起来。
　　
　　使用Validator框架包括启用Validator插件、配置Validator的两个配置文件，以及创建提供Validator的ActionForm子类的Form Beans。下面详细解释如何配置和使用Validator。
　　
　　启用Validator插件
　　虽然Validator框架是与Struts封装在一起提供的，但在默认状况下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>
　　

　　该定义告诉Struts为你的应用程序加载并初始化Validator插件。在初始化时，该插件装入由路径名属性指定的、用逗号分隔的Validator配置文件清单。每个配置文件的路径应该用与Web应用程序的相关的路径来指定，如前面的例子所示。 网管bitscn_com
　　
　　请注意，你的应用程序的struts-config.xml文件必须与Struts Configuration Document Type Definition（Struts配置文档类型定义，DTD）一致，后者规定文件中元素出现的顺序。所以，你必须把Validator插件定义放到该文件的适当位置。确保文件中元素适当排列的最简便方法就是使用诸如Struts Console的工具，它自动格式化你的配置文件，以便与DTD保持一致。
　　
　　配置validator-rules.xml
　　Validator框架可以设置为可插入系统，其验证例行程序仅仅是插入到该系统中执行具体验证的Java方法。validator-rules.xml文件说明性地插入Validator用于执行验证的验证例行程序中。Struts示例应用程序带有这个文件的预配置拷贝。在大多数情况下，你不必修改这个预配置拷贝，除非你要向该框架中添加自己定制的验证。
　　
　　清单1 是一个示例validator-rules.xml文件，说明如何将验证例行程序插入到Validator中。validator-rules.xml文件中的每个验证例行程序都有自己的定义，它用validator标记声明，利用name属性为该验证例行程序指定逻辑名，并指定该例行程序的类和方法。该例行程序的逻辑名称供该文件中的其他例行程序以及validation.xml文件中的验证定义用于引用该例行程序。 网管联盟bitsCN@com
　　
　　请注意，validator标记放在javascript的标记中，javascript标记用于定义客户端JavaScript代码，以便在客户端执行与服务器端相同的验证。
　　
　　提供的验证程序
　　默认情况下，Validator中包括几个基本验证例行程序，你可以用它们来处理大多数验证问题。这些例行程序具有逻辑名称，如required（用于输入要求的值）、CreditCard（用于输入信用卡号码值）、email（用于输入电子邮件地址值），等等。
　　
　　创建Form Bean
　　为了使用Validator，你的应用程序的Form Bean必须归到Validator的ActionForm的某一子类，而不是ActionForm本身。Validator的ActionForm子类提供了ActionForm的validate( )方法（它嵌入到Validator框架中）的实施过程。你不必从头编写验证代码并把它投入validate( )方法中，相反，可以完全忽略该方法，因为Validator为你提供了验证代码。
　　
　　与Struts提供的核心功能相类似，Validator提供给你两种可供选择的方法来创建Form Bean。 你可以选择的第一种方法就是像下面这样创建一个特定的Form Bean对象：
　　

　　package com.jamesholmes.minihr;
　　
　　import org.apache.struts.validator.ValidatorForm; 
　　public class LogonForm extends ValidatorForm {
　　　private String username;
　　　private String password;
　　　
　　　public String getUsername() {
　　　　return username;
　　　}
　　　
　　　public void setUsername(String 
　　username) {
　　　　this.username = username;
　　　}
　　
　　　public String getPassword() {
　　　　return password;
　　　}
　　public void setPassword(String 
　　password) {
　　　　this.password = password;
　　　}
　　}

　　
　　这个类与你不是用Validator所创建的类相似，但它提供ValidatorForm而不是ActionForm。这个类也不提供ActionForm的空reset( )和validate( )方法的实施过程，因为ValidatorForm提供了相应过程。
　　
　　在struts-config.xml文件中配置这个特定Form Bean的方法与配置正则Form Bean的方法相同：
　　
　　

　　<form-beans>
　　　<form-bean name="logonForm"
　　　　　　　　type="com.jamesholmes.minihr.LogonForm"/>
　　</form-beans>
　　

　　用表单标记的name属性给特定Form Bean指定的逻辑名是在定义validation.xml文件中的验证时所使用的名称，如下所示： 中国网管论坛bbs.bitsCN.com
　　　　

　　<!DOCTYPE form-validation 
　　PUBLIC "-//Apache Software Foundation//
　　　　　 DTD Commons Validator Rules
　　　　　 Configuration 1.0//EN"
　　　　　 "http://jakarta.apache.org/
　　　　　commons/dtds/validator_1_0.dtd">
　　
　　<form-validation>
　　　<formset>
　　　　<form name="logonForm">
　　　　　<field property="username" 
　　　　　　　　depends="required">
　　　　　　<arg0 key="prompt.username"/>
　　　　　</field>
　　　　</form>
　　　</formset>
　　</form-validation>
　　　

　　Validator使用该表单标记的name属性的值将验证定义与要应用这些定义的Form Bean的名称相匹配。
　　
　　创建Form Bean时可以选择的第二种方法是在struts-config.xml文件中定义一个动态Form Bean，如下所示：
　　　　

　　<form-beans>
　　　<form-bean name="logonForm"
　　　　　　　　type="org.apache.struts.validator.DynaValidatorForm">
　　　　<form-property name="username"
　　　　　　　　type="java.lang.String"/>
　　　　<form-property name="password"
　　　　　　　　type="java.lang.String"/>
　　　</form-bean>
　　</form-beans>
　　　

　　动态Form Bean不要求创建特定的Form Bean对象；相反，要定义Form Bean应该具有的属性和类型，而Struts为你动态创建Form Bean。 Validator允许你使用这个概念，就像在核心Struts中使用这个概念一样。与使用 【转自www.bitsCN.com】