在Struts 2_0中实现表单数据校验
在写前几篇文章的时候,有些朋友建议我的写一篇关于表单数据校验的文章。 正如文章的开头所引用的《Writing Secure Code》的名言:“所有的输入都是罪恶的”,所以我们应该对所有的外部输入进行校验。而表单是应用程序最简单的入口,对其传进来的数据,我们必须进行校验。
转换与校验(Conversion & Validation)其实上篇文章,我本来是打算写表单数据校验的内容,但是经过再三思考后,还是决定先写Struts 2.0转换器的内容。原因是我认为转换是校验的基础,只有在数据被正确地转换成其对应的类型后,我们才可以对其取值范围进行校验。看个例子相信大家可以更清楚。现在我们就来改造一下《转换器(Converter)——Struts 2.0中的魔术师》的第一个例子。
首先,从Action开始,修改后的代码如下:
package tutorial;![]() import java.util.Locale;![]() import com.opensymphony.xwork2.ActionSupport; import com.opensymphony.xwork2.util.LocalizedTextUtil;![]() public class HelloWorld extends ActionSupport { private String msg; private Locale loc = Locale.US; public String getMsg() { return msg; } public Locale getLoc() { return loc; } public void setLoc(Locale loc) { this .loc = loc; } @Override public void validate() { System.out.println( " Calling validate() " ); if ( ! (loc.equals(Locale.US) || loc.equals(Locale.CHINA))) { addFieldError( " loc " , getText( " validation.loc " )); } } public void validateExecute() { System.out.println( " Calling validateExecute() by reflection " ); } @Override public String execute() { System.out.println( " Calling execute() " ); // LocalizedTextUtil是Struts 2.0中国际化的工具类,<s:text>标志就是通过调用它实现国际化的 msg = LocalizedTextUtil.findDefaultText( " HelloWorld " , loc); return SUCCESS; } } 然后,修改Struts.xml中Action的定义指明输入地址:
< action name ="HelloWorld" class ="tutorial.HelloWorld" >
< result > /HelloWorld.jsp </ result > < result name ="input" > /HelloWorld.jsp </ result > </ action > 接着,在HelloWorld.jsp中加入错误提示:
<% @ page contentType = " text/html; charset=UTF-8 " %>
<% @taglib prefix = " s " uri = " /struts-tags " %> < html > < head > < title > Hello World </ title > </ head > < body > < div style ="color:red;" > < s:fielderror /> </ div > < s:form action ="HelloWorld" theme ="simple" > Locale: < s:textfield name ="loc" /> < s:submit /> </ s:form > < h2 >< s:property value ="msg" /></ h2 > </ body > </ html > 再修改LocaleConverter.java文件,将内容改为:
package tutorial;![]() import java.util.Locale; import java.util.Map; import java.util.regex.Pattern;![]() public class LocaleConverter extends ognl.DefaultTypeConverter { @Override public Object convertValue(Map context, Object value, Class toType) { if (toType == Locale. class ) { System.out.println( " Converting String to Locale " ); String locale = ((String[]) value)[ 0 ]; return new Locale(locale.substring( 0 , 2 ), locale.substring( 3 )); } else if (toType == String. class ) { System.out.println( " Converting Locale to String " ); Locale locale = (Locale) value; return locale.toString(); } return null ; } } 之后,修改国际化资源文件,内容为:
HelloWorld = 你好,世界! globalMessages_zh_CN.properties invalid.fieldvalue.loc = Locale必须为\ " xx_XX\ " 的格式 validation.loc = 区域必须为中国或美国 HelloWorld = Hello World! globalMessages_en_US.properties
invalid.fieldvalue.loc = Locale must like \ " xx_XX\ " validation.loc = Locale must be China or USA 发布运行应用程序,在浏览器中键入http://localhost:8080/Struts2_Validation/HelloWorld.action,在Locale中输入zh_CN,按“Submit”提交,效果如上篇文章所示。而在服务器控制台有如下输出:
Converting String to Locale...
Calling validateExecute() by reflection... Calling validate()... Calling execute()... Converting Locale to String... 上述的输出说明了Struts 2.0的数据校验工作方式,它需要经过下面几个步骤:
不喜欢看文字的朋友,可以参考下面的图1。
图1 校验顺序图 看到这里可能大家会疑问:“这么多地方可以校验表单数据,到底我应该在那里做呢?”有选择是好事,但抉择的过程往往是痛苦的,往往让人不知所措。如果大家参照以下几点建议,相信会比较容易地做出正确的抉择。
在运行上面的例子时,在Locale中输入zh并提交时出现图2所示页面。
图2 错误格式 在Locale中输入de_DE时,出现如图3所示页面。
图3 取值错误 使用Struts 2.0的校验框架上一节的内容都是关于如何编程实现校验,这部分工作大都是单调的重复。更多情况下,我们使用Struts 2.0的校验框架,通过配置实现一些常见的校验。
我学习编程有个习惯——喜欢先看输出结果,再看代码实现。这样学的好处是先看结果可以刺激学习的激情,也可以在看代码前自已思考一下如何实现,然后带着问题去看代码,那就清晰多了。因此下面我们先来做演示。
首先,在tutorial包下新建ValidationAction.java,代码如下:
package tutorial;![]() import com.opensymphony.xwork2.ActionSupport;![]() public class ValidationAction extends ActionSupport { private String reqiuredString;![]() public String getReqiuredString() { return reqiuredString; } public void setReqiuredString(String reqiuredString) { this .reqiuredString = reqiuredString; } @Override public String execute() { return SUCCESS; } } 然后,配置上述所建的Ation,代码片段如下:
< action name ="ValidationAction" class ="tutorial.ValidationAction" >
< result > /Output.jsp </ result > < result name ="input" > /Input.jsp </ result > </ action > 接着,创建Input.jsp和Output.jsp,内容分别如下:
<% @ page contentType = " text/html; charset=UTF-8 " %> Input.jsp <% @taglib prefix = " s " uri = " /struts-tags " %> < html > < head > < title > Hello World </ title > <!-- 此标志的作用是引入Struts 2.0的常用的Javascript和CSS --> < s:head /> </ head > < body > < s:form action ="ValidationAction" > < s:textfield name ="reqiuredString" label ="Required String" /> < s:submit /> </ s:form > </ body > </ html > <% @ page contentType = " text/html; charset=UTF-8 " %> Output.jsp
<% @taglib prefix = " s " uri = " /struts-tags " %> < html > < head > < title > Hello World </ title > </ head > < body > Required String: < s:property value ="reqiuredString" /> </ body > </ html > 再接下来,在tutorial包下创建ValidationAction的校验配置文件Xxx-validation.xml(Xxx为Action的类名),在本例中该文件名ValidationAction-validation.xml,内容如下:
<? xml version="1.0" encoding="UTF-8" ?>
<! DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0//EN" "http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd" > < validators > < field name ="reqiuredString" > < field-validator type ="requiredstring" > < message > This string is required </ message > </ field-validator > </ field > </ validators > 发布运行应用程序,在地址栏中键入http://localhost:8080/Struts2_Validation/Input.jsp,出现如图4所示页面。
图4 Input.jsp 直接点击“Submit”提交表单,出现图5所示的页面。
图5 错误提示 在Required String中随便填点东西,转到Output.jsp页面,如图6所示。
图6 Output.jsp 通过上面的例子,大家可以看到使用该校验框架十分简单方便。不过,上例还有两点不足:
当然,要完善以上不足,对于Struts 2.0来说,只是小菜一碟。
下面是具体的实现,首先在国际化资源文件中加入错误消息,然后按照上面说明实现。因为要使用Javascript在客户端显示出错信息,所以在加载Input.jsp页面时,Struts 2.0需要获得国际化的字符串,故我们需要使用Action来访问Input.jsp页面,具体实现请参考《在Struts 2.0中国际化(i18n)您的应用程序》的最后部分。最后发布运行应用程序,直接在页面中点击“Submit”,表单没有被提交并出现错误提示,如图7所示:
图7 客户端校验 校验框架是通过validation拦截器实现,该拦载被注册到默认的拦截器链中。它在conversionError拦截器之后,在validateXxx()之前被调用。这里又出现了一个选择的问题:到底是应该在action中通过validateXxx()或validate()实现校验,还是使用validation拦截器?绝大多数情况,我建议大家使用校验框架,只有当框架满足不了您的要求才自已编写代码实现。
配置文件查找顺序在上面的例子中,我们通过创建ValidationAction-validation.xml来配置表单校验。Struts 2.0的校验框架自动会读取该文件,但这样就会引出一个问题——如果我的Action继承其它的Action类,而这两个Action类都需要对表单数据进行校验,那我是否会在子类的配置文件(Xxx-validation.xml)中复制父类的配置吗?
答案是不,因为Struts 2.0的校验框架跟《在Struts 2.0中国际化(i18n)您的应用程序》提到的“资源文件查找顺序”相似,有特定的配置文件查找顺序。不同的是校验框架按照自上而下的顺序在类层次查找配置文件。假设以下条件成立:
如果Dog要被校验,框架方法会查找下面的配置文件(其中别名是Action在struts.xml中定义的别名):
已有的校验器Struts 2.0已经为您实现很多常用的校验了,以下在jar的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 ="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" /> </ validators >
总结使用校验框架既可以方便地实现表单数据校验,又能够将校验与Action分离,故我们应该尽可能使用校验框架。在使用校验框架时,请不要忘记通过在资源文件加入invalid.fieldvalue.xxx字符串,显示适合的类型转换出错信息;或者使用conversion校验器。
|





}
}
fluagen
博客统计信息
热门文章
最新评论
友情链接