一、Struts2校验器

位于xwork-2.1.6.jar压缩包中(com.opensymphony.xwork2.validator.validators)有个文件default.xml,该文件中定义了Struts2框架内建的校验器。default.xml文件定义了常用的校验器类型。

<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>

二、校验器的使用方法

对Action中所有方法进行输入校验:

对于输入校验Struts2提供了两种实现方法:

1.  采用手工编写代码实现。

2.  基于XML配置方式实现。

手工编写代码实现:

1>继承ActionSupport类从写validae()方法

2>添加代码,判断传递来的值是否为空,如果为空:

调用addFieldError()方法添加错误信息

This.addFieldError(“username”,”用户名不能为空”)

正则表达式:

If(!Pattern.compile(“^[138]\\d{9}$)).matcher(this.mobile).matches(){

 This.addFieldError(“mobile”,”手机号不能为空”)

}

如果校验失败的话会转发到一个名为input的视图,所以在Action中需要添加一个input名字的视图

在视图中可以使用<s:fielderror/>对错误信息的输出

通过重写Valiedate()方法实现,validate()方法会校验action中所有与execute方法签名相同的方法。当某个数据校验失败时,我们应该调用addFieldError()方法往系统的fieldErrors添加校验失败信息(为了使用addFieldError()方法,action可以继承ActionSupport),如果系统的fieldError包含失败信息,Struts2会将请求转发到名为input的result。在input视图中可以通过<s:fielderror/>显示失败信息

有时候需要只对Action中某个方法进行校验:

通过ActionXxx()方法Xxx为需要校验的方法名。

输入校验的流程:

1.  类型转化器对请求参数执行类型转换,并把转换后的值赋给action中的属性。

2.  如果在执行类型转换的过称中出现异常,系统会将异常信息保存到ActionContext,conversionError拦截器将异常信息封装到fieldError里,不管类型转换是否出现异常,都会进入第三步

3.  系统通过反射技术先调用action中的validateXxxx()方法,Xxxx为方法名。

4.  再调用action中的validate()方法。

5.  经过上面4步,如果系统中的fieldError存在错误信息(即存放错误信息的集合的size大于0),系统自动将请求转发至名称为input的视图。如果系统中的fieldErrors没有任何错误信息,系统将执行action中的处理方法。

基于XML配置方式实现

action所有方法进行输入校验

使用基于XML配置方式实现输入校验时,Action也需要继承ActionSupport,并且提供校验文件,校验文件盒action类放在同一个包下,文件的取名格式为:ActionClassName-validation.xml,其中ActionClassName为action的简单类名,-validate为固定写法。如果Action类为cn.itcast.UserAction,那么该文件的取名应为:UserAction-validation.xml。下面是校验文件的模板:

<!DOCTYPE validators PUBLIC

 "-//OpenSymphony Group//XWork Validator 1.0.3//EN"

 "http://www.opensymphony.com/xwork/xwork-validator-1.0.3.dtd">

<validators>

 <field name="username">

 <field-validator type="requiredstring">

 <param name=”trim”>true</param>

 <message>用户名不能为空!</message>

 </field-validator>

 </field>

</validators>

<field>指定action中需要校验的属性,<field-validtor>指定校验器,上面指定的校验器requiredstring是由系统提供的,系统提供了能满足大部分验证需求的校验器,这些校验器的定义可以在com.opensymphony.xwork2.validator.validators下的default.xml中找到。

<message>为校验失败后的提示信息,如果需要国际化,可以为nessage指定key属性,key的值为资源文件中的key。在这个校验文件中  ,对acition中字符串类型的username属性进行验证,首先要求调用trim()方法去掉空格,然后判断用户名是否为空!

Struts2提供的校验器列表:系统提供的校验器如下;(红色为常用)

Required(必填校验器,要求field的值不能为null);

Requiredstring(必填字符串校验器,要求field的值不能为null,并且长度大于0,默认情况下会对字符串前后去空格)

Requiredlength(字符串长度校验器,要求field的值必须在指定的范围内,否则校验失败,minLength参数指定最小长度,maxLength指定参数最大长度,trim参数指定校验field之前是否去除字符串前后的空格)

Regex(正则表达式校验器,检查被校验的field是否匹配一个正则表达式,expression参数指定正则表达式,caseSensitive参数指定进行正则表达式匹配时,是否区分大小写,默认为true)

Int(整数校验器,要求field的整数值必须在指定范围内,min指定最小值,max指定最大值)

Double(双精度浮点数校验器,要求field的双精度浮点数必须在指定范围内,min指定最小值,max指定最大值)

Fieldexpression(字段OGNL表达式校验器,要求field满足一个ognl表达式,expression参数指定ognl表达式)该逻辑表达式基于ValueStack进行求值,返回true时校验通过,否则不通过

Email(邮件地址校验器,要求如果field的值非空,则必须是合法的邮件地址)

url(网址校验器,要求如果field的值非空,则必须是合法的url地址)

data(日期校验器,要求field的日期值必须在指定范围内,min指定最小值,max指定最大值)

conversion(转换校验器,指定在类型转换失败时,提示的错误信息)

visitor(用于校验action中的复合属性,它指定一个校验文件用于校验复合属性中的属性)

expression(ognl表达式校验器,expression参数指定ognl表达式,该逻辑表达式基于ValueStack进行求值,返回true时校验通过,否则不通过,该校验器不可用在字段校验器风格的配置中)

例子:

类型转换检验器:

1)非字段校验:

 <validator type="conversion">

 <param name="fieldName">myField</param>

 <message>类型转换错误</message>

<param name ="repopulateField">true</param> 

 </validator>

2)字段校验:

 <field name="myField">

 <field-validator type="conversion">

 <message>类型转换错误</message>

 <param name ="repopulateField">true</param> 

 </field-validator>

 </field>

  • fieldName:该参数指定检查是否存在转换异常的字段名称,如果是字段校验,则不用指定该参数。

  • repopulateField:该参数指定当类型转换失败后,返回input页面时,类型转换失败的表单是否保留原来的错误输入。true为保留,false为不保留。

2、日期校验器:

1)非字段校验:

 <validator type="date">

 <param name="fieldName">birthday</param>

 <param name="min">1990-01-02</param>

 <param name="max">2010-07-28</param>

 <message>生日数据错误</message>

 </validator>

2)字段校验:

 <field name="birthday">

 <field-validator type="date">

 <param name="min">1990-01-01</param>

 <param name="max">2010-07-28</param>

 <message key="error.birthday"></message>

 </field-validator>

 </field>

  • min:指定字段日期值的最小值,该参数为可选参数。

  • max:指定字段日期值的最大值,该参数为可选参数。

3、浮点数值校验器:

1)非字段校验:

 <validator type="double">

 <param name="fieldName">percentage</param>

 <param name="minInclusive">20.1</param>

 <param name="maxInclusive">50.1</param>

 <message>生日数据错误</message>

 </validator>

2)字段校验:

 <field name="percentage">

 <field-validator type="double">

 <param name="minInclusive">20.1</param>

 <param name="maxInclusive">50.1</param>

 <message key="error.percentage"></message>

 </field-validator>

 </field>

  • minInclusive|minExclusive:指定字段的最小值,包含该值|不包含该值。

  • maxInclusive|maxExclusive:指定字段的最大值,包含该值|不包含该值。

4、邮件地址校验器:

1)非字段校验:

 <validator type="email">

 <param name="fieldName">MyEmail</param>

 <message>非法的邮件地址</message>

 </validator>

2)字段校验:

 <field name="MyEmail">

 <field-validator type="email">

<message>非法的邮件地址</message>

 </field-validator>

 </field>

5、表达式校验器:

 <validator type="expression">

 <param name="expression">.......</param>

 <message>Failed to meet Ognl Expression...</message>

 </validator>

  • expression:该参数为一个逻辑表达式,该参数使用OGNL表达式,并基于值栈计算,返回一个Boolean类型值。

6、字段表达式校验器:

1)非字段校验:

 <validator type="fieldexpression">

 <param name="fieldName">myField</param>

 <param name="expression"><![CDATA[#myCreditLimit > #myGirfriendCreditLimit]]></param>

 <message>My credit limit should be MORE than my girlfriend</message>

 </validator>

2)字段校验:

 <field name="myField">

 <field-validator type="fieldexpression">

 <param name="expression"><![CDATA[#myCreditLimit > #myGirfriendCreditLimit]]></param>

 <message>My credit limit should be MORE than my girlfriend</message>

 </field-validator>

 </field>

7、整数校验器:

1)非字段校验:

 <validator type="int">

 <param name="fieldName">age</param>

 <param name="min">10</param>

 <param name="max">100</param>

 <message>年龄必须在在${min}${max}之间</message>

 </validator>

2)字段校验:

 <field name="age">

 <field-validator type="int">

 <param name="min">10</param>

 <param name="max">100</param>

 <message>年龄必须在在${min}${max}之间</message>

 </field-validator>

 </field>

8、正则表达式校验器:

1)非字段校验:

 <validator type="regex">

 <param name="fieldName">myStrangePostcode</param>

 <param name="expression"><![CDATA[([aAbBcCdD][123][eEfFgG][456])]></param>

 </validator>

2)字段校验:

 <field name="myStrangePostcode">

 <field-validator type="regex">

 <param name="expression"><![CDATA[#myCreditLimit > #myGirfriendCreditLimit]]></param>

 <message>My credit limit should be MORE than my girlfriend</message>

 </field-validator>

 </field>

  • expression:为必选参数,指定匹配有的表达式。

  • caseSensitive:指明进行匹配时,是否区分大小写,为可选参数,默认为true

9、必填校验器:

1)非字段校验:

 <validator type="required">

 <param name="fieldName">username</param>

 <message>用户名不能为空</message>

 </validator>

2)字段校验:

 <field name="username">

 <field-validator type="required">

 <message>用户名不能为空</message>

 </field-validator>

 </field>

10、必填字符串校验器:

1)非字段校验:

 <validator type="requiredstring">

 <param name="fieldName">username</param>

 <param name="trim">true</param>

 <message>用户名不能为空</message>

 </validator>

2)字段校验:

 <field name="username">

 <field-validator type="requiredstring">

 <param name="trim">true</param>

 <message>用户名不能为空</message>

 </field-validator>

 </field>

  • trim:可选参数,用于指定是否在校验之前对字符串进行整理,默许为true

11、字符串长度校验器:

1)非字段校验:

 <validator type="stringlength">

 <param name="fieldName">username</param>

 <param name="minLength">4</param>

 <param name="maxLength">10</param>

 <message>用户名长度在${minLength}${maxLength}之间</message>

 </validator>

2)字段校验:

 <field name="username">

 <field-validator type="stringlength">

 <param name="minLength">4</param>

 <param name="maxLength">10</param>

 <param name="trim">true</param>

 <message key="error.length.username"></message>

 </field-validator>

 </field>

12、网址校验器:

1)非字段校验:

 <validator type="url">

 <param name="fieldName">myHomePage</param>

 <message>Invalid homepage url</message>

 </validator>

2)字段校验:

 <field name="myHomePage">

 <field-validator type="url">

 <message>Invalid homepage url</message>

 </field-validator>

 </field>

13visitor校验器:

该校验器名称为:visitor,用来校验Action中定义的复合类型属性,支持简单的复合类型、数组类型、Map等集合类型。

1)非字段校验:

 <validator type="visitor">

 <param name="fieldName">user</param>

 <param name="context">myContext</param>

 <param name="appendPrefix">true</param>

 </validator>

2)字段校验:

 <field name="user">

 <field-validator type="visitor">

 <param name="context">myContext</param>

 <param name="appendPrefix">true</param>

 </field-validator>

 </field>

如果想自定义一个自己的校验器,可以在Web工程的WEB-LIB\lib目录下增加一个validators.xml配置文件,在该文件中定义自己的校验器。

注意:如果使用validators.xml配置文件,则系统默认的default.xml配置文件不会加载,所以需要将default.xml的内容复制到validators.xml配置文件中。否则不能使用系统内建的校验器。

基于XML配置方式对指定action方法实现输入校验

当校验文件的取名为ActionClassName-validation.xml时,会对 action中的所有处理方法实施输入验证。如果你只需要对action中的某个action方法实施校验,那么,校验文件的取名应 为:ActionClassName-ActionName-validation.xml,其中ActionName为struts.xml中 action的名称。例如:在实际应用中,常有以下配置:
<action name="user_*" class="cn.itcast.action.UserAction" method="{1}“ >
 <result name="success">/WEB-INF/page/message.jsp</result>
 <result name="input">/WEB-INF/page/addUser.jsp</result>
</action>
UserAction中有以下两个处理方法:
public String add() throws Exception{
   ....
}
public String update() throws Exception{
   ....
}
要对add()方法实施验证,校验文件的取名为: UserAction-user_add-validation.xml
要对update()方法实施验证,校验文件的取名为: UserAction-user_update-validation.xml

三、在编写ActionClassName-validator.xml校验文件时,如果出现不了帮助信息,可以按下面的方法解决:

Windowsàpreferencesàmyeclipseàfiles and editorsàxmlàxmlcatalog

点“add”在出现的窗口中的location中选“File System”,然后在xwork-2.1.2解压目录的str\java目录中选择xwork-validator-1.0.3.dtd,回到设置窗口的时候不要急着关闭窗口,应把窗口中的key Type该为URL。Key改为  http:www.opensymphony.com/xwork/xwork-validator-1.0.3.dtd

 

四、基于XML校验的一些特点

当为某个action提供了ActionClassName-validation.xml和ActionClassName-ActionName-validation.xml两种规则的校验文件时,系统按下面顺序寻找校验文件:
1。AconClassName-validation.xml
2。ActionClassName-ActionName-validation.xml
系统寻找到第一个校验文件时还会继续搜索后面的校验文件,当搜索到所有校验文件时,会把校验文件里的所有校验规则汇总,然后全部应用于action方法的校验。如果两个校验文件中指定的校验规则冲突,则只使用后面文件中的校验规则。

当action继承了另一个action,父类action的校验文件会先被搜索到。

假设UserAction继承BaseAction:
<action name="user" class="cn.itcast.action.UserAction" method="{1}">
</action>

访问上面action,系统先搜索父类的校验文件:BaseAction-validation.xml, BaseAction-user-validation.xml,接着搜索子类的校验文件: UserAction-validation.xml, UserAction-user-validation.xml。应用于上面action的校验规则为这四个文件的总和。