通过上篇博客可以简单的了解Struts2的校验配置流程和一些具体的操作。接下来继续总结Struts2的输入校验。
概述
Struts2提供了方便的输入校验功能,大多数校验可以通过配置内建校验器的方法(编写校验规则文件),不需要增加程序代码。对于特殊的校验规则,也可以方便的指定校验规则。
内建校验器
Struts2提供了15种内建校验器,可以查看doc文档了解内建校验器的规则和用法,常见的有required,requiredstring,regex,email,url,date,int,expression等。配置内建校验器,最关键的是编写校验规则文件和国际化文件。
编写校验规则文件
编写校验文件十分方便,可以通过修改struts2示例中的Login-validation.xml文件即可,步骤如下:
1、修改文件名并存放在和Action同目录下
将文件名修改为ActionName-validation.xml,并将文件存放在Action同目录下。
2、编写文件规则
校验文件的根元素是<validators.../>
,可以包含多个<filed.../>
或<validator...>
。<filed.../>
元素是字段校验器配置风格,<validator...>
是非字段校验器配置风格。在doc中都有每个内建校验器参数的含义以及使用示例,可以直接参考。
<filed.../>
字段校验器配置风格<!-- 校验Action的name属性 --> <field name="name"> <!-- 指定name属性必须满足必填规则 --> <field-validator type="requiredstring"> <param name="trim">true</param> <message>必须输入名字</message> </field-validator> <!-- 指定name属性必须匹配正则表达式 --> <field-validator type="regex"> <param name="regex"><![CDATA[(\w{4,25})]]></param> <message>您输入的用户名只能是字母和数字 ,且长度必须在4到25之间</message> </field-validator> </field>
<validator...>
非字段校验器配置风格<!-- 配置指定必填字符串的校验器 --> <validator type="requiredstring"> <!-- 使用该校验器校验name属性 --> <param name="fieldName">name</param> <param name="trim">true</param> <!-- 指定校验失败后输出name.required对应的国际化信息 --> <message key="name.requried"/> </validator>
3、编写国际化配置文件
在校验规则文件的校验器中,message元素可以指定key属性,获取国际化消息。编写ActionName_zh_CN.properties文件,对应key属性所对应的消息。
4、注意事项
- 短路校验器:默认情况下系统会执行所有校验器,如果需要发现校验错误则不再执行后面的校验器,则需要将
<filed.../>
或<validator...>
的short-circuit属性设为true。 - 校验文件的搜索规则:Action中可能包含多个处理逻辑(逻辑方法),不同的处理逻辑可能需要不同的校验规则,Struts2允许为不同的控制逻辑指定不同的校验规则支持。需要将校验规则文件名命名为:ActionName-FunctionName-validation.xml。在这样的情况下,项目中就会有很多校验文件,系统将按照如下顺序搜索并执行每一个校验文件配置的校验器:
(1)superAction-validatioan.xml
(2)superAction-别名-validatioan.xml
(3)thisAction-validatioan.xml
(4)thisAction-别名-validatioan.xml
自定义校验
对于一些特殊的校验要求,需要进行自定义校验。Action继承ActionSupport自定义校验可以通过重写validate()或validateXxx()方法即可。只要发现校验错误,则将提示通过addFieldError()添加进系统的FieldError中即可。其中,validateXxx()方法为多个逻辑对应不同的校验方法。
Struts2输入校验步骤
1、类型转换器负责对字符串的请求执行类型转换,并将这些值设置为Action的属性值。
2、在执行类型转换过程中如果出现异常,将异常信息保存到ActionContext中,conversionError拦截器负责将其封装到FieldError中,然后执行第3步。如果没有异常直接第3步。
3、使用配置的校验器进行输入校验。
4、通过反射调用validateXxx()方法。
5、调用validate()方法。
6、如果上面5步都没有出现FieldError,将调用Action中处理用户请求的方法,如果出现FieldError,系统转入input逻辑视图指向的视图资源。