博客
关于我
强烈建议你试试无所不能的chatGPT，快点击我
struts2 验证框架原理及实例
阅读量：3484 次
发布时间：2019-05-19

本文共 7037 字，大约阅读时间需要 23 分钟。

struts2的核心是从webwork演变来的，其数据验证框架其实就是原webwork的那一套东西。

　　一，Struts2数据验证的整体框架介绍

　　struts2的action都要继承ActionSupprot类，这个类实现了与这两个跟数据验证有关的接口。其中只有一个方法validate()用于数据验证； 则用于记录验证出错时的相关信息。

　　而数据验证在什么时候被调用呢？数据验证的调用是包装在workflow拦截器里，

　　我们看看workflow拦截器在struts_default.xml中的定义，它是放在默认的defaultStack拦截器组里，相关顺序如下：

[html]   
 
  1. <interceptor-ref name="params"/>  
  2. <interceptor-ref name="conversionError"/>  
  3. <interceptor-ref name="validation"/>  
  4. <interceptor-ref name="workflow"/>  

　　params与conversionError这两个拦截器在workflow的前面，它们的工作是从request中把数据转成正确的类型数据，以供后面处理。validation拦截器实质是与我们这里谈的数据验证不是一回事，它只判断有没有@SkipValidation注解，如果有就不会路过数据验证，只是起一个开关作用。

　　当workflow拦截器触发时，它先检查当前请求的action是否实现了接口，如果实现了该接口，则调用　validate()方法：如果这个方法处理时发现有数据验证不通过，则会生成一个错误信息并交给的方法去存储这些出错信息。当validate()方法执行完毕，workflow拦截器还要调用的hasErrors()方法，看看是否有出错信息生成，如果有出错信息，就中断当前action的执行流程，返回"input"字符串，一般我们是在配置文件struts.xml里配置"input"返回结果的跳转页面。

　　二，数据验证的方式
　
　　１，在action类里实现validate()方法
　　这是最简单的方法了，直接在actionClass中实现接口的方法，如：

[java]   
 
  1.  public class RegUser  extends ActionSupport  {  
  2.   　　public String execute(){         
  3.   
  4. 　　      return SUCCESS;                 
  5.   　　}  
  6.   　　private String username;             
  7.   　　private String password;              
  8.   　　  
  9. 　// Getters and setters omitted  
  10. 　public void validate(){                                                                    
  11.      　　if ( getPassword().length() == 0 ){                                       
  12.         　　　addFieldError( "password", getText("密码不能为空") );  
  13.      　　}  
  14.     　　 if ( getUsername().length() == 0 ){                                      
  15.        　　　 addFieldError( "username", getText("用户名不能为空") );  
  16.   　   }  
  17.   　　 .  .  .   
  18.  　 }  
  19. }  

 　　配置文件：

[html]   
 
  1. <action name="regUser">  
  2.    <result name="success">  
  3. 　　    /WEB-INF/pages/regsucc.jsp  
  4.    </result>  
  5.    <result name="input">  
  6.    　　 /WEB-INF/pages/regerror.jsp  
  7.    </result>  
  8.   </action>　　  

　　　把所有的判断逻辑直接写到action类里，如果有验证错误，直接返回"input"。

　　２，使用xml配置文件:ActionClass-validations.xml

　　　其实struts2已经内置了一些基本的数据验证，完全可以省去我们日常的一些数据验证需求，通过配置文件的方式。

　　　在ActionClass所在的目录下，新建一个以ActionClass名字组合成的特定xml：ActionClass-validations.xml(例，我的ActionClass名为RegUser，则我应该在同目录下建一名为RegUser-validations.xml的文件)，其内容如下:

[html]   
 
  1. <?xml version="1.0″ encoding="UTF-8″?>  
  2. <!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.2//EN"  
  3. "http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd">  
  4. <validators>         <!-  表明这是一个验证器  ->  
  5.     <field name="username">   <!-  声明要验证的字段  ->  
  6.         <field-validator type="requiredstring">  <!-  声明该字段验证器的类型为"必填的字符串" ->  
  7.             <message>用户名不能为空</message>      <!- 如果验证不通过时的出错信息 ->  
  8.         </field-validator>  
  9.     </field>  
  10.      
  11.     <field name="password">  
  12.         <field-validator type="requiredstring">  
  13.             <message>密码不能为空</message>  
  14.         </field-validator>  
  15.     </field>  
  16.      
  17.    <!-  
  18.     <field name="age">  
  19.         <field-validator type="int">  <!-  声明该字段验证器的类型为"必须是整数" ->  
  20.             <param name="min">13</param>　　<!-  声明该字段最小值是13 ->  
  21.             <param name="max">20</param>      <!-  声明该字段最大值是20 ->  
  22.             <message>  
  23.                 必须在 13至20之间  
  24.             </message>  
  25.         </field-validator>  
  26.     </field>  
  27.     ->  
  28. </validators>  

 　　以下是目前struts2所支持的内置的验证器说明，我们可以直接在xml文件里声明拿来使用：

3，使用自己定义的验证器做数据验证

　　 前面介绍过的第2种方式，是利用struts自带的验证器，通过xml配置文件来进行数据验证的，但如果我们的验证要求比较特殊，比如对一个参数的复杂数据、字符组合要求，则可能会考虑自己写一个验证器，如果是这样，那为什么不彩第１种方式，直接在action里实现validate方法呢？是的，当然这样也可以，但我们的目标是尽可能重用代码，或许这个类型的数据验证会用在多个action，甚至于提供给后来的同学们使用，抽象成一个独立的验证器，通过配置文件来声明，以达到复用。
　　下面就介绍如果新建一个可复用的自定义验证器。
　　一般新建自定义的验证器，我们要继承 或 类。下面以一个密码验证的代码例子为说明：
　　　所需验证的密码数据要满足下面条件：
　　　１，密码中要包含字母，大小写均可
　　　２，密码中要包含数字，0-9
          ３，密码中要包含至少一个特殊字符
　　　参见以下代码：
　　　１，我们要先继承 （该类已经继承 ）类
           ２，为我们的验证声明几个正则表达式的pattern:对数字的，普通字符，以及特殊字符
　　　３，实现validate()方法，在这里实现验证的逻辑代码
　　　４，利用继承自 中的getFileName()和getFileValue（）方法获取要进行验证的数据
　　　５，如果验证不通过，要调用addFieldError()方法，继承自 类，以声明错误
[java]   
 
  1. public class PasswordIntegrityValidator  extends FieldValidatorSupport {   
  2.    static Pattern digitPattern = Pattern.compile( "[0-9]");                     
  3.    static Pattern letterPattern = Pattern.compile( "[a-zA-Z]");               
  4.    static Pattern specialCharsDefaultPattern = Pattern.compile( "!@#$");  
  5.   
  6.    public void validate(Object object) throws ValidationException {  
  7.       String fieldName = getFieldName();                                          
  8.       String fieldValue = (String) getFieldValue(fieldName, object );  
  9.       fieldValue = fieldValue.trim();                                
  10.       Matcher digitMatcher = digitPattern.matcher(fieldValue);         
  11.       Matcher letterMatcher = letterPattern.matcher(fieldValue);         
  12.       Matcher specialCharacterMatcher;                                  
  13.       if ( getSpecialCharacters() != null ){                                         
  14.          Pattern specialPattern =   
  15.                      Pattern.compile("[" + getSpecialCharacters() + "]" );      
  16.          specialCharacterMatcher = specialPattern.matcher( fieldValue );  
  17.       } else{  
  18.          specialCharacterMatcher =   
  19.                      specialCharsDefaultPattern.matcher( fieldValue );          
  20.       }  
  21.       if ( !digitMatcher.find() ) {                           
  22.          addFieldError( fieldName, object );               
  23.       }else if ( !letterMatcher.find() ) {                 
  24.          addFieldError( fieldName, object );              
  25.       }else if ( !specialCharacterMatcher.find() ) {  
  26.          addFieldError( fieldName, object );              
  27.  }  
  28.    }  
  29.    private String specialCharacters;  
  30.    public String getSpecialCharacters() {  
  31.         return specialCharacters;  
  32.     }  
  33.     public void setSpecialCharacters(String specialCharacters) {  
  34.         this.specialCharacters = specialCharacters;  
  35.     }  
  36. }  

　　在建完主体的验证器代码，就要在配置文件中声明它，以便我们使用：
　　在WEB-INF/classes/下新建或编辑validators.xml文件，声明我们上面创建的验证器：
[html]   
 
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <!DOCTYPE validators PUBLIC  
  3.         "-//OpenSymphony Group//XWork Validator Config 1.0//EN"  
  4.          "http://www.opensymphony.com/xwork/xwork-validator-config-1.0.dtd">   
  5. <validators>    
  6.    <validator name="passwordintegrity"    
  7.               class="manning.utils.PasswordIntegrityValidator"/>   
  8. </validators>   
　　完成了声明，我们就可以使用前面介绍过的 的方式来使用这个验证器了：
　　在为要使用的类的目录下建立ActionClass-validations.xml的文件，增加如下内容：
[html]   
 
  1. <field-validator type="passwordintegrity">  
  2.       <param name="specialCharacters">$!@#?</param>  
  3.       <message>您的密码必须包括至少一个数字，字符，并包括如下的特殊的字符： "${specialCharacters}".  
  4.       </message>  
  5.  </field-validator>  
注意点：
(1)
<field-validator type="visitor">
<message>用户:</message>
</field-validator>
这段代码中message标签内不能为空，否则将会报错,visitor类型的作用在于，当验证字段user时，将获得user的类型，并根据类型UserEntity查找UserEntity-validation.xml,执行验证。
(2)
当你使用了图形验证码，你想在验证框架中将其进行验证时。需要先将图形验证码的字符串放入session中，然后在验证框架中验证。
<message>${#session.CODE}:${code}</message>
写这句的原因是我在执行图形验证的时候，老是验证不正确，所以我使用这句话，将存放在session中的code和我输入的code在错误信息内输出，已查看是否出现问题
(3)
如果你的表单使用的是simple方式,那么s:form是不会显示错误信息的，那么
我们在jsp页面写入 <s:fielderror cssStyle="color: red"></s:fielderror>,用来输出错误信息，当然你也可以针对每个字段输出错误信息。如果错误信息重复显示，说明你的action采用的单例模式，请将其修改为scope="prototype"
(4)
使用struts验证框架，需要配置input结果跳转。
(5)
若校验同时提供XML和validate()两种方法，则都会被执行，而且是XML校验先执行，validate()方法后执行。而错误信息都会显示。"short-circuit"属性仅针对xml有效
另外在校验过程中还要注意一些问题：
多方法Action情况如何使用配置文件进行校验？
我们知道大多数据情况下，Action可能会有多个方法，面我们上面所说的都是针对execute（）方法进行的校验，如果存在多方法的情况下，需要进行校验的信息肯定是不样的，一个配置文件肯定解决不了问题，所有在多方式需要校验的情况下，我们需要在Action同级别的目录下，创建命名规则如下的配置文件：ActionName-method-validation.xml 配置文件，比如：RegisterAction中有个test()方法需要校验，可以创建
RegisterAction-test-validation.xml 配置文件进行配置，这个文件就会针对tets（）方法进行校验，但是需要注意的是：在调用test()方法时，使用RegisterAction-test-vaidation.xml 文件进行校验后，还会调用RegisterAction-vaidation.xml 文件进行校验，这样的话，肯定会产生干扰，为了解决这样问题，可以在开发过程中，不提供RegisterAction-validtion.xml 这样的文件，对于execute()方法，可以提供一个RegisterAction-execute-validation.xml 文件进行配置校验。
XML方式校验与硬编码方式校验的选择|
我们采用了XML 配置文件的方式进行校验，介是Action中的validate()方法同时也会被执行的，这时一些校验就可能会重复！所以在开发过程中，我们只采用一种方式，要么使用XML方式进行校验，要么采用硬编码的方式进行校验，而不建议混合使用的方式；一般情况下，我们采用XML方式进行校验，而且XML方式可以满足我们的需求，在业务特别复杂或校验粒度比较细的情况下我们可以采用硬编码的方式校验。
前端验证注意！
Struts2 XML配置方式进行是服务器端校验，当然在开发过程中我们经常会需要客户端校验，Struts2也提供了客户端校验功能，使用客户端校验，首先页面中Struts2 标签的主题不能设为simple主题，另外form标签的validate 属性要改为true。但是Struts2提供的这种客户端校验功能是非常有限的，所有在需要使用客户端校验的情况，可以采用javascript 或Ajax的方式进行校验，会更灵活一点。
转载自：
可以参考：struts2 in action写得很详细
简单的例子：
验证框架原理详解：
一个复杂的实战例子：
你可能感兴趣的文章
[ 笔 记 ] netcat 传输信息 / banner
查看>>
[ 笔 记 ] 主动信息收集_002
查看>>
[ CTF ] ssh私钥泄漏_笔记
查看>>
设计模式学习
查看>>
操作系统学习总结
查看>>
Java JSON字符串与自定义类/基本类型相互转换
查看>>
Java中时间戳和时间格式的转换
查看>>
Dubbo基础知识整理
查看>>
计算机网络知识整理
查看>>
Java基础知识
查看>>
操作系统知识整理
查看>>
实现自己的权限管理系统（二）：环境配置以及遇到的坑
查看>>
实现自己的权限管理系统（四）: 异常处理
查看>>
实现自己的权限管理系统（十）：角色模块
查看>>
实现自己的权限管理系统（十二）：权限操作记录
查看>>
实现自己的权限管理系统（十三）：redis做缓存
查看>>
实现自己的权限管理系统（十四）：工具类
查看>>
JavaWeb面经(一)：2019.9.14
查看>>
JavaWeb面经(二)：2019.9.16 Synchronized关键字底层原理及作用
查看>>
JavaWeb面试经：redis
查看>>
喝酒易醉，品茶养心，人生如梦，品茶悟道，何以解忧？唯有杜康！-- 愿君每日到此一游！
当前时间: 2024-09-12 21:25:48   当前IP: 3.129.194.67   联系邮箱:javaeecc@qq.com     Copyright © 2020 - 2022 baihongyu.com 京ICP备2021015314号-2
强烈建议你试试无所不能的CHAT-GPT，快点击我
强烈建议你试试无所不能的CHAT-GPT，快点击我