几乎每一个Web开发者都会遇到输入校验的问题,输入校验直接影响了系统的抗破坏性能和稳定性。输入校验往往同类型转换联系在一起,在判断用户输入数据的合法性之前,需要先进行类型转换判断,然后再进行输入校验处理。两者都是对用户输入数据的规范化检查和处理。Struts2框架为开发者的输入校验提供了良好的支持。
一、 使用validate方法进行输入校验
1、 validate()方法输入校验
在ActionSupport类定义中,提供了一个数据校验void validate()方法,开发者只要在自己的Action实现类中重写该方法即可。下面为示例代码:
public void validate(){
if(username!=null&&username.length()>10){
addFieldError("username","用户名长度不能大于10!");
}
If(password==null||getPassword().trim().equals("")){
addFieldError("password","密码不能为空!");
}
}
2、 validateXxx()方法输入校验
在Struts2框架的核心内容介绍中已经提到,Action实现类中可以包含多个处理逻辑,即可以实现动态方法调用,每一个处理逻辑对应一个处理方法。 Struts2框架为开发者提供了一个validateXxx()方法来对不同的业务处理方法进行数据输入校验。例如增加一个Login()方法来对应用户登录,那么可以使用validateLogin()方法来处理数据输入校验。
public String Login() throws Exception{
return SUCCESS;
}
public void validateLogin(){
if(username!=null&&username.length()>10){
addFieldError("username","用户名长度不能大于10!");
}
If(password==null||getPassword().trim().equals("")){
addFieldError("password","密码不能为空!");
}
}
注意:采用这种输入校验时,validate()方法会对该Action实现类中所有的处理方法进行数据输入校验,所以在使用validateXxx()方法时,最好去掉validate()方法的代码,或者检查两者不要重复校验。
3、 输入校验流程
1. Struts2框架的类型转换是先于输入校验执行的,Struts2框架使用类型转换器对用户输入的字符进行转换,转换为Action中对应的属性类型。在此转换过程中,如果出现异常,则转换异常拦截器执行拦截操作,并将转换异常信息保存到ActionContext中。
2. 如果用户请求调用了Action的Xxx()方法,则执行validateXxx()方法进行数据校验,如果发现校验异常,则将异常信息保存到ActionContext中。然后调用validate()方法进行输入校验。
3. 在执行Action处理方法之前,查找ActionContext中是否有fieldError信息,如果发现有fieldError信息,则直接返回一个input逻辑视图,跳过Action处理方法的执行;如果没有发现fieldError信息,则执行Action的相应处理方法。
二、 基于框架的输入校验
Struts2框架提供了一种基于框架文件的输入校验方式,将校验规则保存在特定的框架文件中,这样一来就使输入校验同Action实现了分离,提高了系统的维护性。
基于框架的输入校验不需要在Action的实现类中重写validate()方法,Action只需要关系处理用户请求即可。这样一来Action只是一个简单的业务控制器,不处理任何用户数据的输入校验工作。在execute()方法中只简单返回一个success字符串。
为了使用Struts2的框架校验规则文件进行输入校验,需要建立一个特定的校验规则文件就可以。Struts2框架的校验规则文件就是一个XML格式配置文件。该文件的命名规则为“Action名称-validation.xml”,保存在同Action实现类相同的目录下。本示例的校验规则文件为LoginAction-validation.xml,内容如下(有两种格式):
(字段校验格式)
<?xml version="1.0" encoding="gb2312"?>
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.3//EN" "http://www.opensymphoy.com/xwork/xwork-validator-1.0.3.dtd">
<validators>
<field name="username">
<field-validator type="stringlength">
<param name="minLength">4</param>
<param name="maxLength">10</param>
<message>框架校验:用户名长度为${minLength}到${maxLength}之间</message>
</field-validator>
<field-validator type="requiredstring">
<message>框架校验:用户名不能为空</message>
</field-validator>
</field>
<field name="password">
<field-validator type="requiredstring">
<message>框架校验:密码不能为空</message>
</field-validator>
<field-validator type="stringlength">
<param name="minLength">4</param>
<param name="maxLength">20</param>
<message>框架校验:密码长度为${minLength}到${maxLength}之间</message>
</field-validator>
</field>
</validators>
(非字段校验格式)
<?xml version="1.0" encoding="gb2312"?>
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.3//EN" "http://www.opensymphoy.com/xwork/xwork-validator-1.0.3.dtd">
<!--校验规则定义的根源素-->
<validators>
<validator type='stringlength'>
<param name="fieldName">username</param>
<param name="minLength">4</param>
<param name="maxLength">10</param>
<message>框架校验:用户名称长度为${minLength}到${maxLength}之间</message>
</validator>
<validator type="requiredstring">
<param name="fieldName">username</param>
<message>框架校验:用户名不能为空</message>
</validator>
<validator type='stringlength'>
<param name="fieldName">password1</param>
<param name="minLength">4</param>
<param name="maxLength">10</param>
<message>框架校验:密码长度为${minLength}到${maxLength}之间</message>
</validator>
<validator type="requiredstring">
<param name="fieldName">password1</param>
<message>框架校验:密码不能为空</message>
</validator>
</validators>
三、 输入校验的国际化信息
基于框架文件的输入校验配置中,用于显示校验异常信息的元素<message/>都是使用硬编码的形式写入配置文件中的,Struts2框架允许在该元素中使用Key属性来获得国际化信息资源。例如:
globalMessages_zh_CN.properties文件中加入如下资源:
login.usernameLength=用户名字符数在4到10之间
login.username=用户名不能为空
修改检验文件配置:
<validator type='stringlength'>
<param name="fieldName">username</param>
<param name="minLength">4</param>
<param name="maxLength">10</param>
<message key="login.usernameLength"> </message>
</validator>
<validator type="requiredstring">
<param name="fieldName">username</param>
<message key="login.username"></message>
</validator>
四、 复合类型属性的输入校验
Struts2开发中经常使用的是将用户输入的字符串转换为一个复合类型,那么Action中含有复合类型属性时就需要使用Struts2框架提供的复合类型校验器。
Struts2框架提供了一个复合类型校验器——Visitor校验器,该校验器用于校验Action定义的复合类型。
示例: 例如,一个用户Action中包含了一个User类型的复合类型属性,其业务控制器为LoginAction,由于Action中定义了一个复合类型,所以需要建立两个校验规则文件,第一个为Action的校验规则文件LoginAction-validation.xml,代码如下:
<?xml version="1.0" encoding="gb2312"?>
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.3//EN" "http://www.opensymphoy.com/xwork/xwork-validator-1.0.3.dtd">
<validators>
<field name="user">
<!—复合类型校验 -->
<field-validator type="visitor">
<!—参数context指明了该复合类型属性的上下文校验名称 -->
<param name="context">userContext</param>
<!—appendPrefix指明是否在校验信息中加入复合类型信息 -->
<param name="appendPrefix">true</param>
<message>用户信息:</message>
</field-validator>
</field>
</validators>
第二个校验规则文件为User-userContext-validation.xml,User指明了该复合类型对应的类名,userContext即为参数context的值。该校验规则文件代码如下:
<?xml version="1.0" encoding="gb2312"?>
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.3//EN" "http://www.opensymphoy.com/xwork/xwork-validator-1.0.3.dtd">
<validators>
<field name="name">
<field-validator type="requiredstring">
<message>用户名不能为空!</message>
</field-validator>
</field>
……
……
</validators>