Struts2学习 一 Validation(验证器)
数据验证在Web开发中是经常使用和比不可少的功能.Struts2框架也为我们提供了这个功能,下面就是该功能的用法和示例代码:
Struts2有两种验证方式 :
1. 通过代码方式验证
2. 通过XML配置文件的方式验证.
Struts2的数据校验功能是通过"拦截器"完成的. 具体的拦截器类如下 :
<interceptor name="validation" class="org.apache.struts2.interceptor.validation.AnnotationValidationInterceptor"/>
代码验证
-
使用代码方式校验用户提交的数据, 需要校验的Action需要继承ActionSupport类. 并且重写父类方法 一一 validate()(推荐使用)
-
让自定义的Action实现Validateable, ValidationAware接口 (不推荐使用)
这里我们以第一种方式演示.
-
在自定的Action中重写validate()方法
/** * 不验证任何内容的默认实现 * A default implementation that validates nothing. * 子类应该重写此方法提供验证逻辑 * Subclasses should override this method to provide validations. */ public void validate() { }
ActionSupport中的validate方法不提供任何的验证逻辑.需要开发者自己写入.并将验证结果存储
@Override
public void validate() {
if (user.getUserName() == null || "".equals(user.getUserName())) {
super.addFieldError("userName", "用户名不能为空");
}
if (user.getPwd() == null || "".equals(user.getPwd())) {
super.addFieldError("pwd", "密码不能为空");
}
super.validate();
}
验证的结果可以调用addFieldError(String,String)方法存储起来.Struts2将验证结果以Map的形式存储起来.key是Action中需要验证的字段.value则是验证结果,下面是Struts2中存储校验结果的代码.
public synchronized void addFieldError(String fieldName, String errorMessage) {
final Map<String, List<String>> errors = internalGetFieldErrors();
List<String> thisFieldErrors = errors.get(fieldName);
if (thisFieldErrors == null) {
thisFieldErrors = new ArrayList<String>();
errors.put(fieldName, thisFieldErrors);
}
thisFieldErrors.add(errorMessage);
}
这样我们就可以在jsp页面中取出校验结果信息提示用户.
用上面这种重写validate()的方式校验数据.该Action中所有的方法都会调用验证逻辑.当用户访问这个Action中的其他业务方法.就会报错.这显然不是我们想要.
如果我们只想校验Action中指定的方法.我们需要对validate()的方法名进行修改:
命名规则:
validate + 需要验证的方法名
举个栗子:
public void validateLogin(){}
这样就只会验证Action中的Login方法
举个栗子 :
public void validateLogin() {
if (user.getUserName() == null || "".equals(user.getUserName())) {
super.addFieldError("userName", "用户名不能为空");
}
if (user.getPwd() == null || "".equals(user.getPwd())) {
super.addFieldError("pwd", "密码不能为空");
}
super.validate();
}
XML方式验证
因为"校验"是很常用的功能.所以Struts2对常用的验证进行了封装, 即提供了 "验证器" .用来验证常用的业务逻辑. 例如非空判断、email、日期验证等.......
Struts2提供的验证器 :
Struts2提供的验证器都存在xwork-core.jar中.路径如下:
xwork-core-2.3.4.1.jar/com.opensymphony.xwork2.validator.validators/default.xml
内容 :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC
"-//Apache Struts//XWork Validator Definition 1.0//EN"
"http://struts.apache.org/dtds/xwork-validator-definition-1.0.dtd">
<!-- START SNIPPET: validators-default -->
<validators>
<validator name="required" class="com.opensymphony.xwork2.validator.validators.RequiredFieldValidator"/>
<validator name="requiredstring" class="com.opensymphony.xwork2.validator.validators.RequiredStringValidator"/>
<validator name="int" class="com.opensymphony.xwork2.validator.validators.IntRangeFieldValidator"/>
<validator name="long" class="com.opensymphony.xwork2.validator.validators.LongRangeFieldValidator"/>
<validator name="short" class="com.opensymphony.xwork2.validator.validators.ShortRangeFieldValidator"/>
<validator name="double" class="com.opensymphony.xwork2.validator.validators.DoubleRangeFieldValidator"/>
<validator name="date" class="com.opensymphony.xwork2.validator.validators.DateRangeFieldValidator"/>
<validator name="expression" class="com.opensymphony.xwork2.validator.validators.ExpressionValidator"/>
<validator name="fieldexpression" class="com.opensymphony.xwork2.validator.validators.FieldExpressionValidator"/>
<validator name="email" class="com.opensymphony.xwork2.validator.validators.EmailValidator"/>
<validator name="url" class="com.opensymphony.xwork2.validator.validators.URLValidator"/>
<validator name="visitor" class="com.opensymphony.xwork2.validator.validators.VisitorFieldValidator"/>
<validator name="conversion" class="com.opensymphony.xwork2.validator.validators.ConversionErrorFieldValidator"/>
<validator name="stringlength" class="com.opensymphony.xwork2.validator.validators.StringLengthFieldValidator"/>
<validator name="regex" class="com.opensymphony.xwork2.validator.validators.RegexFieldValidator"/>
<validator name="conditionalvisitor" class="com.opensymphony.xwork2.validator.validators.ConditionalVisitorFieldValidator"/>
</validators>
<!-- END SNIPPET: validators-default -->
使用XML方式验证字段.只需要以特定的名字创建XML文件.并在xml文件中声明验证规则即可:
-
xml文件的命名方式 : ActionClassName-validation.xml
注意 : 此xml要与需要验证的Action在同意目录下 : -
在xml文件声明 :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC
"-//Apache Struts//XWork Validator 1.0.3//EN"
"http://struts.apache.org/dtds/xwork-validator-1.0.3.dtd">
<!-- 验证器跟标签 -->
<validators>
<!-- field: 代表需要验证的字段 -->
<field name="user.userName">
<!-- 指定该字段使用什么验证器,可指定多个验证器 -->
<field-validator type="requiredstring">
<!-- 验证失败的提示信息 -->
<message>用户名不能为空!</message>
</field-validator>
</field>
<field name="user.pwd">
<field-validator type="requiredstring">
<message>密码不能为空</message>
</field-validator>
<field-validator type="stringlength">
<param name="minLength">6</param>
<param name="maxLength">8</param>
<message>密码必须6-8位!</message>
</field-validator>
</field>
</validators>
当只需要对特定方法进行验证时 ,只需要将文件名修改.内容可以不变.
命名方式 :
语法:ActionClassName-ActionName-validation.xml
举例:UserAction-user_login-validation.xml
验证UserAction中的login方法
总结 :
使用方式 :
代码:
重写validate() , 验证action所有方法
Validate方法名(), 验证指定“方法名”的方法
Xml:
验证所有方法: ActionClassName-validation.xml
验证指定方法: ActionClassName-actionName-validation.xml
优缺点 :
代码验证,
比较灵活,可以满足所有的需求.
比较繁琐,要写重复的验证判断逻辑!
适合: 表单字段较少的情况用!
XML验证:
通用,但不够灵活; 可以验证特定简单的业务。
适合: 验证表单字段较多,可以大大简化代码!
(配置文件过多)
验证错误处理
Struts在进行数据效验的时候,验证失败,会返回input视图,要求我们要在struts.xml中配置input视图对应的错误页面!
配置:
Struts.xml
<global-results>
<result name="input">/register.jsp</result>
</global-results>
Jsp显示错误
Struts在进行数据效验的时候,验证失败,会返回input视图,要求我们要在struts.xml中配置input视图对应的错误页面!
方式1:显示所有错误
<%@taglib uri="/struts-tags" prefix="s" %>
<!-- 显示的是struts在运行时期产生的所有错误 -->
<s:fielderror></s:fielderror>
方式2:显示指定的错误
<!-- 修改struts标签默认的样式: 不让换行 -->
<style type="text/css">
ul{
display: inline;
}
ul li{
display: inline;
color: red;
}
</style>
显示指定的错误:
<s:fielderror fieldName="user.userName"></s:fielderror>