Struts2: ActionSupport类中验证(Validate)功能的实现

原文http://www.lifelaf.com/blog/?p=551
在Struts2中，action类通过实现特定的接口来配合使用拦截器是一种很常见的做法。ActionSupport类也是这样，通过实现Validateable接口和ValidationAware接口来配合使用validation拦截器与workflow拦截器，从而实现验证（Validate）功能：

public class ActionSupport  implements   Action,

Validateable,ValidationAware,... {}

Validateable接口与validation拦截器

Validateable接口非常简单，其中只有一个方法：/**

* Performs validation.

*/voidvalidate();

如果action声明使用validation拦截器（只要Struts2 package继承了struts-default，那么该package内的action就都会使用validation拦截器），拦截器（ValidationInterceptor类）会调用action的validate()方法：

if(action instanceof Validateable) {   

Validateable validateable = (Validateable) action;   

validateable.validate();

}

不过，ActionSupport类对validate()方法的实现是空的，需要子类进行覆写并加入真正的验证代码：

/**

* A default implementation that validates nothing.

* Sub  classes should override this method to provide validations.

*/publicvoidvalidate(){}

ValidationAware接口与workflow拦截器

ValidationAware接口定义了一系列存储和读取错误信息的方法：

void setActionErrors(Collection errorMessages);

Collection getActionErrors();voidsetActionMessages(Collection messages);

Collection getActionMessages();

void   setFieldErrors(Map> errorMap);Map> getFieldErrors();

void  addActionError(StringanErrorMessage);

void  addActionMessage(StringaMessage);

void   addFieldError(StringfieldName,StringerrorMessage);

boolean hasActionErrors();

boolean hasActionMessages();

boolean hasErrors();

boolean hasFieldErrors();

如果action声明使用workflow拦截器（只要Struts2 package继承了struts-default，那么该package内的action就都会使用workflow拦截器），拦截器（DefaultWorkflowInterceptor类）会判断action中是否含有错误，如果有的话，则读取这些错误信息并显示在页面上：

if(action instanceof ValidationAware) {

ValidationAware validationAwareAction = (ValidationAware) action;   

if (validationAwareAction.hasErrors()){        ...    }}

在ActionSupport中，除了ValidationAware接口所定义的方法，ActionSupport还提供了一些用于清除已有错误信息的方法：

public  void  clearFieldErrors(){...}

public  void  clearActionErrors(){...}

public  void  clearMessages(){...}

public  void   clearErrors(){...}

public  void   clearErrorsAndMessages(){...}

而所有错误信息的存储、读取以及清除工作，ActionSupport都是通过调用ValidationAwareSupport类来实现的 — ValidationAwareSupport类内部则定义了三个变量用于存储这些信息：

private Collection actionErrors;

private Collection actionMessages;

private

在action类中加入验证代码

从ActionSupport类处继承的action类，可以通过覆写父类的validate()方法来加入验证代码。而在validate()方法中，action类可以使用addFieldError或者addActionError等方法来存储错误信息。这样，当validate拦截器起作用的时候，validate()方法被调用，错误信息被存储；接着当workflow拦截器起作用的时候，这些错误信息被读取并显示在页面上：

从上面的描述中可以看到，validate拦截器需要在workflow拦截器之前起作用，否则workflow拦截器就无法读取到错误信息。而这也正是struts-default包中默认拦截器栈里的次序