J2EE系列之Struts2学习笔记（二十）--Struts2验证框架（自定义验证）

玩游戏的时候，我们说的脏话对方是看不到的；评论的时候如果评语中有敏感词汇也会评论失败；

上面的这种对于是否含有关键词的验证是无法用Struts自带的验证方法来实现的。好在Struts设计了自定义验证框架，使得我们可以自己定义验证器来验证含有关键词的语句。

首先看一下Struts2自带的验证器：打开Struts安装包里面的\src\xwork-core\src\test\resources下的validators.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC
        "-//Apache Struts//XWork Validator Config 1.0//EN"
        "http://struts.apache.org/dtds/xwork-validator-config-1.0.dtd">
<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="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>

上面就是Struts2自带的验证器，看到这些应该不会感到陌生。上一篇博客RegisterAction-validation.xml文件中用到的验证器<field-validator>标签的type属性的取证就是上面的name属性值，这个值代表验证器的名称，后面class属性代表验证器的实体类。下面我们也会自定义一个验证器。

对于需要验证的输入，系统会首先到项目的根目录下的validators.xml文件中寻找对应的验证器，如果根目录下面没有找到就会到系统的validators.xml文件中去寻找。所以定义验证器的时候，一般把自定义的验证器放在工程的根目录下。

下面以一个例子来看一下自定义验证器的用法。

1.在上一个工程的基础上继续添加文件。

2.新建一个com.test.validators包，在这个包里面定义一个验证器类SensitiveWordValidators：

package com.test.validators;

import com.opensymphony.xwork2.validator.ValidationException;
import com.opensymphony.xwork2.validator.validators.FieldValidatorSupport;

public class SensitiveWordValidators extends FieldValidatorSupport{

	@Override
	public void validate(Object object) throws ValidationException {
		
		String fieldName = this.getFieldName();//得到系统输入的用户字段
		String value = (String) this.getFieldValue(fieldName, object);//获取用户输入的值
		
		if(!check(value)){
			this.addFieldError(fieldName, object);//添加错误信息
			
		}
	}
	
	public boolean check(String value){
		String sensitiveWords[] = {"操","你妈"};
		for(int i=0; i<sensitiveWords.length; i++){
			if(value.indexOf(sensitiveWords[i])>-1){
				return false;
			}
		}
		
		return true;
	}

}

注意：验证器类要集成自FieldValidatorSupport这个类，并且实现validate方法。validate方法中首先获取到系统输入的用户字段，然后获取到用户输入的值value；通过check函数来判断用户的输入是否包含我们定义的敏感词汇。如果包含敏感词汇，则输出错误信息。

3.拷贝一个validators.xml文件到工程的根目录下，把我们自定义的拦截器添加到validators.xml文件中：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC
        "-//Apache Struts//XWork Validator Config 1.0//EN"
        "http://struts.apache.org/dtds/xwork-validator-config-1.0.dtd">
<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="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"/>

	<validator name="sensitive" class="com.test.validators.SensitiveWordValidators"/>

</validators>

我们这里给我们自定义的拦截器取名为sensitive。

4.定义一个新的Action：ValidationAction

package com.test.action;

import com.opensymphony.xwork2.ActionSupport;
import com.test.model.User;

public class ValidationAction extends ActionSupport{

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	
	private String name;
	
	

	public String getName() {
		return name;
	}



	public void setName(String name) {
		this.name = name;
	}



	@Override
	public String execute() throws Exception {
		System.out.println("姓名："+name);
		return SUCCESS;
	}
	
	

}

这里我们只是简单的定义了一个变量name；

5.定义这个Action要使用的验证规则文件：ValidationAction-validation.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC "-//Apache Struts//XWork Validator 1.0.2//EN" "http://struts.apache.org/dtds/xwork-validator-1.0.2.dtd">

<validators>

    <field name="name">
        <field-validator type="requiredstring">
            <message>请输入姓名</message>
        </field-validator>
        <field-validator type="sensitive">
        	<message>有敏感词汇</message>
        </field-validator>
    </field>
    
</validators>

这里对ValidationAction的name变量使用的验证器包括requiredstring和我们自定义的sensitive。requiredstring验证器用于验证输name变量的值是否为空，如果为空则提示用户输入姓名；sensitive验证器用于验证用户输入的值是否包含敏感词汇。

6.修改struts.xml文件：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
	
	<package name="manager" extends="struts-default">
		<action name="registerAction" class="com.test.action.RegisterAction">
			<result name="input">/register.jsp</result>
			<result name="success">/success.jsp</result>
		</action>
		
		<action name="validationAction" class="com.test.action.ValidationAction">
			<result name="input">/validation.jsp</result>
			<result name="success">/success.jsp</result>
		</action>
	</package>
</struts>

如果包含请求validationAction验证失败，则停留在validation.jsp页面。

7.运行程序：

输入“你妈的”，并点击提交：

可以看到，我们自定义的验证器成功了。