Struts2校验学习(转)
最近学习了Struts2的输入校验,然后自己总结了下,以后可能还会回头看看自己的学习札记,就当给复习做个准备了。
对于输入校验,Struts2提供了两种方式,1:采用手工编写代码实现;2:基于XML配置方面实现 。
1:采用手工编写代码实现。
通过继承ActionSupport类,然后重写vlidate方法,validate方法会校验跟execute同样签名的方法,当某个数据校验失败时,我们应该调用addFieldError()这个方法向系统的FieldError添加信息,如果校验失败了,Struts2会自动转发到名为input的result这个结果页上面,在input视图上可以通过<s:fielderror /> 这样一个标签来获得失败信息,这样就可以完成一个校验了,具体代码如下
index.jsp:提供用户输入的界面,这个form表单提交方向大家看好了。
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ taglib uri="/struts-tags" prefix="s" %> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Insert title here</title> </head> <body> <s:fielderror /> <form action="${pageContext.request.contextPath }/manager_update" method="post"> 用户名:<input type="text" name="username" />不能为空<br /> 手机号:<input type="text" name="mobile" />不能为空,必须符合手机号1,3/5/8,后面9个数字<br /> <input type="submit" value="提交" /> </form> </body> </html>
message.jsp:用户输入正确的话就来到此页面
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Insert title here</title> </head> <body> ${message }<br /> </body> </html>
struts.xml:里面的Action名字采用了一个通配符,为后面讲解校验范围做测试
<?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.1.dtd"> <struts> <package name="yuan2" namespace="/" extends="struts-default"> <action name="manager_*" class="com.ambow.Action.PersonAction" method="{1}"> <result name="message">/WEB-INF/page/message.jsp</result> <result name="input">/index.jsp</result> </action> </package> </struts>
PersonAction类
package com.ambow.Action; import java.util.regex.Pattern; import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionSupport; public class PersonAction extends ActionSupport { private String username ; private String mobile ; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getMobile() { return mobile; } public void setMobile(String mobile) { this.mobile = mobile; } public String save(){ ActionContext.getContext().put("message", "保存成功!") ; return "message" ; } public String update(){ ActionContext.getContext().put("message", "更新成功!") ; return "message" ; } @Override public String execute() throws Exception { // TODO Auto-generated method stub return super.execute(); } public void validate() {//会对所有的Action起作用 if(username == null || "".equals(this.username.trim())){ this.addFieldError("username", "用户名不能为空") ; } if(mobile == null || "".equals(this.mobile.trim())){ this.addFieldError("mobile", "手机号不能为空") ; }else{ if(!Pattern.compile("^1[3,5,8]\\d{9}$").matcher(this.mobile).matches()){ this.addFieldError("mobile", "手机号格式不正确") ; } } super.validate(); } /*public void validateUpdate(){ //只对update进行校验validateXxx,方法名第一个必须大写 if(username == null || "".equals(this.username.trim())){ this.addFieldError("username", "用户名不能为空") ; } if(mobile == null || "".equals(this.mobile.trim())){ this.addFieldError("mobile", "手机号不能为空") ; }else{ if(!Pattern.compile("^1[3,5,8]\\d{9}$").matcher(this.mobile).matches()){ this.addFieldError("mobile", "手机号格式不正确") ; } } super.validate() ; }*/ }
这样一来,我们的一个校验的程序就写好了,通过部署,运行,我们可以发现,这个校验是针对Action类里面所有的方法所执行的,当我们把表单提交的action给换了以后,发现校验都是存在的,即,这个校验是全局校验,怎么只针对Action里面的一个方法进行校验呢?比如我们这个程序里面的update方法?程序只需稍微修改一下,上面代码已经写出来了,我们只需要自己定义个方法,名字为validateXxx()即可了,这个Xxx的第一个必须大写,而且Xxx是这个Action里面的一个方法。代码如下
package com.ambow.Action; import java.util.regex.Pattern; import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionSupport; public class PersonAction extends ActionSupport { private String username ; private String mobile ; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getMobile() { return mobile; } public void setMobile(String mobile) { this.mobile = mobile; } public String save(){ ActionContext.getContext().put("message", "保存成功!") ; return "message" ; } public String update(){ ActionContext.getContext().put("message", "更新成功!") ; return "message" ; } @Override public String execute() throws Exception { // TODO Auto-generated method stub return super.execute(); } /*public void validate() {//会对所有的Action起作用 if(username == null || "".equals(this.username.trim())){ this.addFieldError("username", "用户名不能为空") ; } if(mobile == null || "".equals(this.mobile.trim())){ this.addFieldError("mobile", "手机号不能为空") ; }else{ if(!Pattern.compile("^1[3,5,8]\\d{9}$").matcher(this.mobile).matches()){ this.addFieldError("mobile", "手机号格式不正确") ; } } super.validate(); }*/ public void validateUpdate(){ //只对update进行校验validateXxx,方法名第一个必须大写 if(username == null || "".equals(this.username.trim())){ this.addFieldError("username", "用户名不能为空") ; } if(mobile == null || "".equals(this.mobile.trim())){ this.addFieldError("mobile", "手机号不能为空") ; }else{ if(!Pattern.compile("^1[3,5,8]\\d{9}$").matcher(this.mobile).matches()){ this.addFieldError("mobile", "手机号格式不正确") ; } } super.validate() ; } }
这么一来,我们在form表单修改提交的方法,就会发现这个save()方法不会做校验了,而update()方法照样校验,说明这个校验只是针对update()方法管用了,这样,我们就通过手工完成了校验。
2:通过基于XML的配置实现校验
基于XML方式实现校验时,Action类也需要继承ActionSupport类,并且提供校验文件,校验文件同Action类放在一个包内,文件的取名格式为:ActionClassName-validation.xml,其中ActionClassName为Action类的简单名字,本例子中为PersonAction即可,-validation为固定写法。如果该Action类名字为com.ambow.PersonAction,那么这个配置文件名字就是PersonAction-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> <field name="mobile"> <field-validator type="requiredstring"> <param name="trim">true</param> <message>手机号不能为空</message> </field-validator> <field-validator type="regex"> <param name="expression"><![CDATA[^1[358]\d{9}$]]></param> <message>手机号格式不正确</message> </field-validator> </field> </validators>
大家如果不知道这个模板怎么来的,可以到Struts2的提供的样板程序查看,里面提供了一个校验的配置。
这样一来,我们只需要做这么一个配置即可,将PersonAction里面的校验代码全部删掉,再次部署运行,发现同样可以实现校验的功能,同理,我们发现,这个校验也是针对Action里面的所有方法都校验的,那么怎么才能针对Action里面的一个方法进行校验呢?这个其实很简单,我们只需要修改配置文件的名字为:ActionClassName-ActionName-validation.xml即可,这个ActionClassName还是上面的那个PersonAction,但是这个ActionName是访问一个Action方法的路径,本例中,可以是 manager_update或者manager_save,这个主要是看struts.xml配置文件拿到这个ActionName的名字,比如我的配置如下:
<?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.1.dtd"> <struts> <package name="yuan2" namespace="/" extends="struts-default"> <action name="manager_*" class="com.ambow.Action.PersonAction" method="{1}"> <result name="message"> /WEB-INF/page/message.jsp </result> <result name="input"> /index.jsp </result> </action> </package> <!-- Add packages here --> </struts>
通过这里,可以找到我们的ActionName,也就是我的manager_update或者manager_save 这两个ActionName
我们修改一下,写成PersonAction-manager_save-validation.xml ,然后再次部署运行,修改表单提交的Action方法,我们知道这下只能对save方法凑效了。
简单的总结了以上两种方式,如果有错误之处,还望大家指出。
- 本文附件下载:
- Validate.rar (3.1 MB)