Struts2使用validate方法验证数据

在Struts2中最简单的验证数据的方法是使用validate。我们从ActionSupport类的源代码中可以看到， ActionSupport类实现了一个Validateable接口。这个接口只有一个validate方法。如果Action类实现了这个接口， Struts2在调用execute方法之前首先会调用这个方法，我们可以在validate方法中验证，如果发生错误，可以根据错误的level选择字 段级错误，还是动作级错误。并且可使用addFieldError或addActionError加入相应的错误信息，如果存在Action或Field 错误，Struts2会返回“input”（这个并不用开发人员写，由Struts2自动返回），如果返回了“input”，Struts2就不会再调用 execute方法了。如果不存在错误信息，Struts2在最后会调用execute方法。

这两个add方法和ActionErrors类中的add方法类似，只是add方法的错误信息需要一个ActionMessage对象，比较麻烦。 除了加入错误信息外，还可以使用addActionMessage方法加入成功提交后的信息。当提交成功后，可以显示这些信息。

以上三个add方法都在ValidationAware接口中定义，并且在ActionSupport类中有一个默认的实现。其实，在 ActionSupport类中的实现实际上是调用了ValidationAwareSupport中的相应的方法，也就是这三个add方法是在 ValidationAwareSupport类中实现的，代码如下：

private final ValidationAwareSupport validationAware=newValidationAwareSupport();
public void addActionError(StringanErrorMessage) {　
    validationAware.addActionError(anErrorMessage);
}
public void addActionMessage(StringaMessage) {
    validationAware.addActionMessage(aMessage);
}
public void addFieldError(StringfieldName,StringerrorMessage) {
    validationAware.addFieldError(fieldName,errorMessage);
}

下面我们来实现一个简单的验证程序，来体验一个validate方法的使用。

先来在Web根目录建立一个主页面（validate.jsp），代码如下：

＜%@pagelanguage="java"import="java.util.*"pageEncoding="GBK"%＞
＜%@taglibprefix="s"uri="/struts-tags"%＞
＜html＞
　＜head＞
＜title＞验证数据＜/title＞
　＜/head＞
　
　＜body＞
＜s:actionerror/＞
＜s:actionmessage/＞
＜s:formaction="validate.action"　theme="simple"＞
输入内容：＜s:textfieldname="msg"/＞
＜s:fielderrorkey="msg.hello"/＞
＜br/＞
＜s:submit/＞
＜/s:form＞
　＜/body＞
＜/html＞

在上面的代码中，使用了Struts2的tag：＜s:actionerror＞、＜s:fielderror＞和＜s:actionmessage＞，分别用来显示动作错误信息，字段错误信息，和动作信息。如果信息为空，则不显示。

现在我们来实现一个动作类，代码如下：

 

package action;
import javax.servlet.http.*;
import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.interceptor.*;
public class ValidateAction extends ActionSupport
{
private String msg;
public String execute()
{
    System.out.println(SUCCESS);
    returnSUCCESS;
}
public void validate()
{  
    if(!msg.equalsIgnoreCase("hello")) {
        System.out.println(INPUT);
        this.addFieldError("msg.hello","必须输入hello!");
        this.addActionError("处理动作失败!");
    }
    else {
        this.addActionMessage("提交成功");
    }
}
public String getMsg()
{
    returnmsg;
}
public void setMsg(Stringmsg)
{
    this.msg=msg;
}
}

大家从上面的代码可以看出，Field错误需要一个key（一般用来表示是哪一个属性出的错误），而Action错误和Action消息只要提供一个信息字符串就可以了。

最后来配置一下这个Action，代码如下：

＜packagename="demo"extends="struts-default"＞
  ＜action name="validate" class="action.ValidateAction"＞
    ＜resultname="success"＞/error/validate.jsp＜/result＞
    ＜resultname="input"＞/error/validate.jsp＜/result＞
  ＜/action＞
＜/package＞

假设应用程序的上下文路径为demo，则可通过如下的URL来测试程序：

http://localhost:8080/demo/validate.jsp

我们还可以使用ValidationAware接口的其他方法（由ValidationAwareSupport类实现）获得或设置字段错误信息、 动作错误信息以及动作消息。如hasActionErrors方法判断是否存在动作层的错误，getFieldErrors获得字段错误信息（一个Map 对象）。下面是ValidationAware接口提供的所有的方法：

 

package com.opensymphony.xwork2;
import java.util.Collection;
import java.util.Map;
public interface ValidationAware
{
void setActionErrors(CollectionerrorMessages);
Collection getActionErrors();
void setActionMessages(Collectionmessages);
Collection getActionMessages();
void setFieldErrors(MaperrorMap);
Map getFieldErrors();
void addActionError(StringanErrorMessage);
void addActionMessage(StringaMessage);
void addFieldError(StringfieldName,StringerrorMessage);
boolean hasActionErrors();
boolean hasActionMessages();
boolean hasErrors();
boolean hasFieldErrors();
}

 

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

 

服务端验证

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

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

package action;
import com.opensymphony.xwork2.ActionSupport;
public class NewValidateAction extends ActionSupport
{
private String msg;　//必须输入
private int age;　//在13和20之间
public String getMsg()
{
    returnmsg;
}
public void setMsg(Stringmsg)
{
    this.msg=msg;
}
public int  getAge()
{
    return age;
}
public void setAge(intage)
{
    this.age=age;
}
}

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

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

如下：

＜?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。文件的内容如下：

＜?xmlversion="1.0"encoding="UTF-8"?＞
＜!DOCTYPEvalidatorsPUBLIC"-//OpenSymphonyGroup//XWorkValidator1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd"＞
＜validators＞
＜fieldname="msg"＞
＜field-validatortype="requiredstring"＞
＜message＞请输入信息＜/message＞
＜/field-validator＞
＜/field＞
＜fieldname="age"＞
＜field-validatortype="int"＞
＜paramname="min"＞13＜/param＞
＜paramname="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文件，代码如下：

＜%@pagelanguage="java"import="java.util.*"pageEncoding="GBK"%＞
＜%@taglibprefix="s"uri="/struts-tags"%＞
＜linkrel="stylesheet"type="text/css"href="＜s:urlvalue="/styles/styles.css"/＞"＞
＜html＞
　＜head＞
＜title＞验证数据＜/title＞
　＜/head＞　
　＜body＞
＜s:formaction="new_validate"namespace="/test"＞
＜s:textfieldname="msg"label="姓名"　/＞
＜s:textfieldname="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类，代码如下：

package data;
public class User
{
private String name;
private int age;
public String getName()
{
    returnname;
}
public void setName(Stringname)
{
    this.name=name;
}
public int getAge()
{
    return age;
}
public void setAge(intage)
{
    this.age=age;
}
}

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

 

package action;
import com.opensymphony.xwork2.ActionSupport;
import data.User;
public class NewValidateAction extends ActionSupport {
	private String msg;
	private int age;
	private User user;
	public  String getMsg()
	{
	    return msg;
	}
	public void setMsg(Stringmsg)
	{
	    this.msg=msg;
	}
	public int getAge()
	{
	    return age;
	}
	public void setAge(intage)
	{
	    this.age=age;
	}
	public User getUser()
	{
	    returnuser;
	}
	public void setUser(Useruser)
	{
	    this.user=user;
	}
}

 

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

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

＜?xmlversion="1.0"encoding="UTF-8"?＞
＜!DOCTYPEvalidatorsPUBLIC"-//OpenSymphonyGroup//XWorkValidator1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd"＞
＜validators＞
……
＜fieldname="user"＞
＜field-validatortype="visitor"＞
＜paramname="context"＞abc＜/param＞
＜paramname="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文件的内容如下：

＜?xmlversion="1.0"encoding="UTF-8"?＞
＜!DOCTYPEvalidatorsPUBLIC"-//OpenSymphonyGroup//XWorkValidator1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd"＞
＜validators＞
＜fieldname="name"＞
＜field-validatortype="requiredstring"＞
＜message＞请输入name＜/message＞
＜/field-validator＞
＜/field＞
＜fieldname="age"＞
＜field-validatortype="int"＞
＜paramname="min"＞5＜/param＞
＜paramname="max"＞20＜/param＞
＜message＞
必须在5至20之间
＜/message＞
＜/field-validator＞
＜/field＞
＜/validators＞

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

＜s:formvalidate="true"action="new_validate"namespace="/test"＞
＜s:textfieldname="msg"label="姓名"　/＞
＜s:textfieldname="age"label="年龄"/＞
＜s:textfieldname="user.name"label="姓名1"　/＞
＜s:textfieldname="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中其他的属性可以使用客户端测试。