Struts2教程5：使用Validation框架验证数据

本文为原创，如需转载，请注明作者和出处，谢谢！

上一篇：Struts2教程4：使用validate方法验证数据

在《Struts2教程4：使用validate方法验证数据》中曾讲到使用validate方法来验证客户端提交的数据，但如果使用validate方法就会将验证代码和正常的逻辑代码混在一起，但这样做并不利于代码维护，而且也很难将过些代码用于其他程序的验证。在Struts2中为我们提供了一个Validation框架，这个框架和Struts1.x提供的Validation框架类似，也是通过XML文件进行配置。

一、服务端验证

下面将给出一个例子来演示如何使用Struts2的validation框架来进行服务端验证。我们可以按着如下四步来编写这个程序：

【第1步】建立Action类（NewValidateAction.java）

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> package action;

import com.opensymphony.xwork2.ActionSupport;

public class NewValidateAction extends ActionSupport
{
private Stringmsg; // 必须输入
private int age; // 在13和20之间
public StringgetMsg()
{
return msg;
}
public void setMsg(Stringmsg)
{
this .msg = msg;
}
public int getAge()
{
return age;
}
public void setAge( int age)
{
this .age = age;
}
}

下面我们来验证msg和age属性。

【第2步】配置Action类，struts.xml的代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> <? xmlversion="1.0"encoding="UTF-8" ?>
<! DOCTYPEstrutsPUBLIC
"-//ApacheSoftwareFoundation//DTDStrutsConfiguration2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd" >
< struts >
< package name ="demo" extends ="struts-default" namespace ="/test" >
< action name ="new_validate" class ="action.NewValidateAction" >
< result name ="input" > /validate_form.jsp </ result >
< result name ="success" > /validate_form.jsp </ result >
</ action >
</ package >
</ struts >

【第3步】编写验证规则配置文件

这是一个基于XML的配置文件，和struts1.x中的validator框架的验证规则配置文件类似。但一般放到和要验证的.class文件在同一目录下，而且配置文件名要使用如下两个规则中的一个来命名：

<ActionClassName>-validation.xml

<ActionClassName>-<ActionAliasName>-validation.xml

其中<ActionAliasName>就是struts.xml中<ation>的name属性值。在本例中我们使用第一种命名规则，所以文件名是NewValidateAction-validation.xml。文件的内容如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> <? xmlversion="1.0"encoding="UTF-8" ?>
<! DOCTYPEvalidatorsPUBLIC"-//OpenSymphonyGroup//XWorkValidator1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd" >
< validators >
< field name ="msg" >
< field-validator type ="requiredstring" >
< message > 请输入信息 </ message >
</ field-validator >
</ field >
< field name ="age" >
< field-validator type ="int" >
< param name ="min" > 13 </ param >
< param name ="max" > 20 </ param >
< message >
必须在13至20之间
</ message >
</ field-validator >
</ field >
</ validators >

这个文件使用了两个规则：requiredstring（必须输入）和int（确定整型范围）。关于其他更详细的验证规则，请读者访问http://struts.apache.org/2.0.11.1/docs/validation.html来查看。

【第4步】编写数据录入JSP页。

在Web根目录中建立一个validate_form.jsp文件，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> < %@page language ="java" import ="java.util.*" pageEncoding ="GBK" % >
< %@taglib prefix ="s" uri ="/struts-tags" % >
< link rel ="stylesheet" type ="text/css" href ="<s:urlvalue=" /styles/styles.css" /> ">
< html >
< head >
< title > 验证数据 </ title >
</ head >
< body >
< s:form action ="new_validate" namespace ="/test" >
< s:textfield name ="msg" label ="姓名" />
< s:textfield name ="age" label ="年龄" />
< s:submit />
</ s:form >
</ body >
</ html >

大家要注意一下，如果在struts.xml的<package>标签中指定namespace属性，需要在<s:form>中也将namespace和action分开写，如上面代码所示。不能将其连在一起，Struts2需要分开的action和namespace。如下面的代码是错误的：

<s:form action="/test/new_validate" >

... ...

</s:form>

在上面的程序中还使用了一个styles.css来定制错误信息的风格。代码如下：

.label {font-style:italic; }

.errorLabel {font-style:italic;color:red; }

.errorMessage {font-weight:bold; color:red; }

需要在Web根目录中建立一个styles目录，并将styles.css

假设Web工程的上下文路径是validation，可以使用如下的URL来测试这个程序：

http://localhost:8080/validation/validate_form.jsp

显示结果如图 1 所示。

图1

二、客户端验证

在Struts2中实现客户端验证非常简单，只需要在<s:form>中加入一个validate属性，值为true。如<s:form validate="true" ... > ... </form>即可。

三、验证嵌套属性

有一类特殊的属性，即这个属性的类型是另外一个 JavaBean ，如有一个 User 类，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> package data;

public class User
{
private Stringname;
private int age;
public StringgetName()
{
return name;
}
public void setName(Stringname)
{
this .name = name;
}
public int getAge()
{
return age;
}
public void setAge( int age)
{
this .age = age;
}
}

在 NewValidateAction 类中加一个 user 属性，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> package action;

import com.opensymphony.xwork2.ActionSupport;
import data.User;

public class NewValidateAction extends ActionSupport
{
private Stringmsg;
private int age;
private Useruser;
public StringgetMsg()
{
return msg;
}

public void setMsg(Stringmsg)
{
this .msg = msg;
}
public int getAge()
{
return age;
}
public void setAge( int age)
{
this .age = age;
}
public UsergetUser()
{
return user;
}

public void setUser(Useruser)
{
this .user = user;
}
}

如果要验证NewValidateAction中的user属性，可以使用visitor验证器。操作过程如下：

首先在NewValidateAction-validation.xml中加入一个<field>标签，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> <? xmlversion="1.0"encoding="UTF-8" ?>
<! DOCTYPEvalidatorsPUBLIC"-//OpenSymphonyGroup//XWorkValidator1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd" >
< validators >

< field name ="user" >
< field-validator type ="visitor" >
< param name ="context" > abc </ param >
< param name ="appendPrefix" > true </ param >
< message > User: </ message >
</ field-validator >
</ field >
</ validators >

其中context参数将作为验证User类属性的文件名的一部分，如user属性返回一个User对象，那么用于验证User对象属性的文件名为User-abc-validation.xml。这个文件要和User.class文件在同一个目录中。appendPrefix表示是否在字段里加user，如果为true，Struts2就会使用user.name在form提交的数据中查找要验证的数据。这个属性的默认值是true。如果出错，Struts2会将<message>标签中的信息加到User-abc-validation.xml文件中的相应错误信息前面。

User-abc-validation.xml 文件的内容如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> <? xmlversion="1.0"encoding="UTF-8" ?>
<! DOCTYPEvalidatorsPUBLIC"-//OpenSymphonyGroup//XWorkValidator1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd" >
< validators >
< field name ="name" >
< field-validator type ="requiredstring" >
< message > 请输入name </ message >
</ field-validator >
</ field >
< field name ="age" >
< field-validator type ="int" >
< param name ="min" > 5 </ param >
< param name ="max" > 20 </ param >
< message >
必须在5至20之间
</ message >
</ field-validator >
</ field >
</ validators >

下面修改validate_form.jsp，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --> < s:form validate ="true" action ="new_validate" namespace ="/test" >
< s:textfield name ="msg" label ="姓名" />
< s:textfield name ="age" label ="年龄" />
< s:textfield name ="user.name" label ="姓名1" />
< s:textfield name ="user.age" label ="年龄1" />
< s:submit />
</ s:form >

大家可以看到，最后两个<s:textfield>的name属性是user.name和user.age，正好是加了前缀的。

现在重新访问 http://localhost:8080/validation/validate_form.jsp ，验证界面如图 2 所示。

图2

经笔者测试，使用visitor无法以客户端验证的方式来验证user属性，但NewValidateAction中其他的属性可以使用客户端测试。


下一篇：Struts2教程6：在Action类中获得HttpServletResponse对象的四种方法

国内最棒的Google Android技术社区（eoeandroid），欢迎访问！

《银河系列原创教程》发布

《Java Web开发速学宝典》出版，欢迎定购