碼上快樂

相關內容    簡體    繁體

SpringMVC 使用JSR-303進行校驗 @Valid

本文轉載自   查看原文   2013-08-17 11:36   4817 

注意：1 public String save(@ModelAttribute("house") @Valid House entity, BindingResult result,HttpServletRequest request,  Model model)     BindingResult 必須放在model,request前面

　　　2 validation-api-1.0.0.GA.jar是JDK的接口；hibernate-validator-4.2.0.Final.jar是對上述接口的實現。hibernate-validator-4.2.0.Final可以，但是hibernate-validator-4.3.0.Final報錯

驗證注解

驗證的數據類型

說明

@AssertFalse

Boolean,boolean

驗證注解的元素值是false

@AssertTrue

Boolean,boolean

驗證注解的元素值是true

@NotNull

任意類型

驗證注解的元素值不是null

@Null

任意類型

驗證注解的元素值是null

@Min(value=值)

BigDecimal，BigInteger, byte,

short, int, long，等任何Number或CharSequence（存儲的是數字）子類型

驗證注解的元素值大於等於@Min指定的value值

@Max（value=值）

和@Min要求一樣

驗證注解的元素值小於等於@Max指定的value值

@DecimalMin(value=值)

和@Min要求一樣

驗證注解的元素值大於等於@ DecimalMin指定的value值

@DecimalMax(value=值)

和@Min要求一樣

驗證注解的元素值小於等於@ DecimalMax指定的value值

@Digits(integer=整數位數, fraction=小數位數)

和@Min要求一樣

驗證注解的元素值的整數位數和小數位數上限

@Size(min=下限, max=上限)

字符串、Collection、Map、數組等

驗證注解的元素值的在min和max（包含）指定區間之內，如字符長度、集合大小

@Past

java.util.Date,

java.util.Calendar;

Joda Time類庫的日期類型

驗證注解的元素值（日期類型）比當前時間早

@Future

與@Past要求一樣

驗證注解的元素值（日期類型）比當前時間晚

@NotBlank

CharSequence子類型

驗證注解的元素值不為空（不為null、去除首位空格后長度為0），不同於@NotEmpty，@NotBlank只應用於字符串且在比較時會去除字符串的首位空格

@Length(min=下限, max=上限)

CharSequence子類型

驗證注解的元素值長度在min和max區間內

@NotEmpty

CharSequence子類型、Collection、Map、數組

驗證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0）

@Range(min=最小值, max=最大值)

BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子類型和包裝類型

驗證注解的元素值在最小值和最大值之間

@Email(regexp=正則表達式,

flag=標志的模式)

CharSequence子類型（如String）

驗證注解的元素值是Email，也可以通過regexp和flag指定自定義的email格式

@Pattern(regexp=正則表達式,

flag=標志的模式)

String，任何CharSequence的子類型

驗證注解的元素值與指定的正則表達式匹配

@Valid

任何非原子類型

指定遞歸驗證關聯的對象；

如用戶對象中有個地址對象屬性，如果想在驗證用戶對象時一起驗證地址對象的話，在地址對象上加@Valid注解即可級聯驗證

 

SpringMVC 使用JSR-303進行校驗 @Valid

博客分類：
 

 

一、准備校驗時使用的JAR

      

  說明：

         validation-api-1.0.0.GA.jar是JDK的接口；

         hibernate-validator-4.2.0.Final.jar是對上述接口的實現。

 

------------------------------------------------------------------------------------------------

新增一個測試的pojo bean ,增加jsr 303格式的驗證annotation

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. @NotEmpty  
  2. private String userName;  
  3. @Email  
  4. private String email;  


在controller 類中的handler method中，對需要驗證的對象前增加@Valid 標志

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. @RequestMapping("/valid")  
  2. public String valid(@ModelAttribute("vm") [color=red]@Valid[/color] ValidModel vm, BindingResult result) {  
  3.     if (result.hasErrors()) {  
  4.         return "validResult";  
  5.     }  
  6.   
  7.     return "helloworld";  
  8. }  


增加顯示驗證結果的jsp如下

Jsp代碼  復制代碼   收藏代碼
Jsp代碼   收藏代碼
  1. <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>  
  2.   
  3. <html>  
  4. <head>  
  5. <title>Reservation Form</title>  
  6. <style>  
  7. .error {  
  8.     color: #ff0000;  
  9.     font-weight: bold;  
  10. }  
  11. </style>  
  12. </head>  
  13.   
  14. <body>  
  15.     <form:form method="post" modelAttribute="vm">  
  16.         <form:errors path="*" cssClass="error" />  
  17.         <table>  
  18.             <tr>  
  19.                 <td>Name</td>  
  20.                 <td><form:input path="userName" />  
  21.                 </td>  
  22.                 <td><form:errors path="userName" cssClass="error" />  
  23.                 </td>  
  24.             </tr>  
  25.             <tr>  
  26.                 <td>email</td>  
  27.                 <td><form:input path="email" />  
  28.                 </td>  
  29.                 <td><form:errors path="email" cssClass="error" />  
  30.                 </td>  
  31.             </tr>  
  32.       
  33.             <tr>  
  34.                 <td colspan="3"><input type="submit" />  
  35.                 </td>  
  36.             </tr>  
  37.         </table>  
  38.     </form:form>  
  39. </body>  
  40. </html>  


訪問 http://localhost:8080/springmvc/valid?userName=winzip&email=winzip 
查看驗證結果。 
二：自定義jsr 303格式的annotation 
參考hibernate validator 4 reference 手冊中3.1節，增加一個自定義要求輸入內容為定長的annotation驗證類 
新增annotation類定義

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. @Target( { METHOD, FIELD, ANNOTATION_TYPE })  
  2. @Retention(RUNTIME)  
  3. @Constraint(validatedBy = FixLengthImpl.class)  
  4. public @interface FixLength {  
  5.   
  6.     int length();  
  7.     String message() default "{net.zhepu.web.valid.fixlength.message}";  
  8.   
  9.     Class<?>[] groups() default {};  
  10.   
  11.     Class<? extends Payload>[] payload() default {};  
  12. }  


及具體的驗證實現類如下

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. public class FixLengthImpl implements ConstraintValidator<FixLength, String> {  
  2.     private int length;  
  3.     @Override  
  4.     public boolean isValid(String validStr,  
  5.             ConstraintValidatorContext constraintContext) {  
  6.         if (validStr.length() != length) {  
  7.             return false;  
  8.         } else {  
  9.             return true;  
  10.         }  
  11.     }  
  12.   
  13.     @Override  
  14.     public void initialize(FixLength fixLen) {  
  15.         this.length = fixLen.length();  
  16.     }  
  17. }  


為使自定義驗證標注的message正常顯示，需要修改servlet context配置文件，新增messageSource bean,如下

Xml代碼  復制代碼   收藏代碼
  1.   
Xml代碼   收藏代碼
  1. <bean id="messageSource"  
  2.     class="org.springframework.context.support.ReloadableResourceBundleMessageSource"  
  3.     p:fallbackToSystemLocale="true" p:useCodeAsDefaultMessage="false"  
  4.     p:defaultEncoding="UTF-8">  
  5.     <description>Base message source to handle internationalization  
  6.     </description>  
  7.     <property name="basenames">  
  8.         <list>  
  9.             <!-- main resources -->  
  10.             <value>classpath:valid/validation</value>  
  11.         </list>  
  12.     </property>  
  13. </bean>  


表示spring 將從路徑valid/validation.properties中查找對於的message。 
新增valid bean 引用新增的messageSource bean，表示valid message將從messageSource bean 注入。

Xml代碼  復制代碼   收藏代碼
Xml代碼   收藏代碼
  1. <bean id="validator"  
  2.     class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"  
  3.     p:validationMessageSource-ref="messageSource">  
  4.     <description>Enable the bean validation provider, and configure it to  
  5.         use the messageSource when resolving properties</description>  
  6. </bean>  



修改 <mvc:annotation-driven> 增加對validator bean的引用

Xml代碼  復制代碼   收藏代碼
Xml代碼   收藏代碼
  1. <mvc:annotation-driven validator="validator" />  



最后修改之前新增的pojo bean ，新增一個mobileNO屬性並增加對自定義標注的引用

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. @FixLength(length=11)  
  2. private String mobileNO;  


在前端jsp中也增加新字段的支持

Jsp代碼  復制代碼   收藏代碼
Jsp代碼   收藏代碼
  1. <tr>  
  2.     <td>mobileno</td>  
  3.     <td><form:input path="mobileNO" />  
  4.     </td>  
  5.     <td><form:errors path="mobileNO" cssClass="error" />  
  6.     </td>  
  7. </tr>  



可訪問url http://localhost:8080/springmvc/valid?userName=winzip&email=winzip&mobileNO=138188888 
來查看修改的結果。 

三 json輸入的驗證 
Spring mvc 3.0.5中對於json格式的輸入直接使用@valid標注有問題，目前這個bug還未修復 (見 SPR-6709)，預計在3.1 m2版本中會修復。 
在此之前，可以通過如下幾種方式來對json（或xml）格式的輸入來進行驗證。 
1：在handler method中直接對輸入結果進行驗證

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. @RequestMapping("/validJson1")  
  2. @ResponseBody  
  3. public JsonResult processSubmitjson(@RequestBody ValidModel vm,  
  4.         HttpServletRequest request) {  
  5.     JsonResult jsonRst = new JsonResult();  
  6.       
  7.     Set<ConstraintViolation<ValidModel>> set = validator.validate(vm);  
  8.     for (ConstraintViolation<ValidModel> violation : set) {  
  9.   
  10.         String propertyPath = violation.getPropertyPath().toString();  
  11.         ;  
  12.         String message = violation.getMessage();  
  13.         log.error("invalid value for: '" + propertyPath + "': "  
  14.                 + message);  
  15.     }         
  16.     if (!set.isEmpty()){  
  17.         jsonRst.setSuccess(false);  
  18.         jsonRst.setMsg("輸入有誤!");  
  19.         return jsonRst;  
  20.     }  
  21.   
  22.     jsonRst.setSuccess(true);  
  23.     jsonRst.setMsg("輸入成功!");  
  24.     return jsonRst;  
  25. }  




可通過修改后的helloworld.jsp中的json valid test1按鈕進行調用測試。 

2：將此驗證邏輯封裝為一個AOP，當需驗證的對象前有@valid標注和@RequestBody標注時開始驗證 
新增handler method如下

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. @RequestMapping("/validJson2")  
  2.  @ResponseBody  
  3.  public JsonResult testJson4(@RequestBody @Valid ValidModel vm){  
  4.     log.info("handle json for valid");  
  5.     return new JsonResult(true,"return ok");      
  6.  }  


這里沒有對輸入值做任何驗證，所有的驗證都在AOP中完成。 
修改pom.xml增加對AOP相關類庫的引用。

Xml代碼  復制代碼   收藏代碼
Xml代碼   收藏代碼
  1. <dependency>  
  2.     <groupId>org.aspectj</groupId>  
  3.     <artifactId>aspectjweaver</artifactId>  
  4.     <version>1.6.11</version>  
  5. </dependency>  
  6.   
  7. <dependency>  
  8.     <groupId>cglib</groupId>  
  9.     <artifactId>cglib</artifactId>  
  10.     <version>2.2.2</version>  
  11. </dependency>  
  12.   
  13. <dependency>  
  14.     <groupId>org.springframework</groupId>  
  15.     <artifactId>spring-aop</artifactId>  
  16.     <version>${org.springframework.version}</version>  
  17. </dependency>  


修改servet context xml，增加對aop的支持。

Xml代碼  復制代碼   收藏代碼
Xml代碼   收藏代碼
  1. <!-- enable Spring AOP support -->  
  2. <aop:aspectj-autoproxy proxy-target-class="true" />  


最后，新增AOP類

Java代碼  復制代碼   收藏代碼
Java代碼   收藏代碼
  1. public class CustomerValidatorAOP {  
  2.   private Validator validator;  
  3.    
  4.   @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")  
  5.   private void controllerInvocation() {  
  6.   }  
  7.    
  8.   @Around("controllerInvocation()")  
  9.   public Object aroundController(ProceedingJoinPoint joinPoint) throws Throwable {  
  10.    
  11.     MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();  
  12.     Method method = methodSignature.getMethod();  
  13.     Annotation[] annotationList = method.getAnnotations();  
  14.    /* for(Annotation anno:annotationList){ 
  15.         System.out.println(ResponseBody.class.isInstance(anno)); 
  16.     } 
  17. */  
  18.     Annotation[][] argAnnotations = method.getParameterAnnotations();  
  19.     String[] argNames = methodSignature.getParameterNames();  
  20.     Object[] args = joinPoint.getArgs();  
  21.    
  22.     for (int i = 0; i < args.length; i++) {  
  23.       if (hasRequestBodyAndValidAnnotations(argAnnotations[i])) {  
  24.         Object ret = validateArg(args[i], argNames[i]);  
  25.         if(ret != null){  
  26.             return ret;  
  27.         }  
  28.       }  
  29.     }  
  30.    
  31.     return joinPoint.proceed(args);  
  32.   }  
  33.    
  34.   private boolean hasRequestBodyAndValidAnnotations(Annotation[] annotations) {  
  35.     if (annotations.length < 2)  
  36.       return false;  
  37.    
  38.     boolean hasValid = false;  
  39.     boolean hasRequestBody = false;  
  40.    
  41.     for (Annotation annotation : annotations) {  
  42.       if (Valid.class.isInstance(annotation))  
  43.         hasValid = true;  
  44.       else if (RequestBody.class.isInstance(annotation))  
  45.         hasRequestBody = true;  
  46.    
  47.       if (hasValid && hasRequestBody)  
  48.         return true;  
  49.     }  
  50.     return false;  
  51.   }  
  52.    
  53.   
  54.   private JsonResult validateArg(Object arg, String argName) {  
  55.     BindingResult result = getBindingResult(arg, argName);  
  56.     validator.validate(arg, result);  
  57.     if (result.hasErrors()) {  
  58.       JsonResult jsonresult = new JsonResult();  
  59.       jsonresult.setSuccess(false);  
  60.       jsonresult.setMsg("fail");  
  61.       return jsonresult;  
  62.     }  
  63.     return null;  
  64.   }  
  65.    
  66.   private BindingResult getBindingResult(Object target, String targetName) {  
  67.     return new BeanPropertyBindingResult(target, targetName);  
  68.   }  
  69.    
  70.   @Required  
  71.   public void setValidator(Validator validator) {  
  72.     this.validator = validator;  
  73.   }  


這里只考慮了輸入為json格式的情況，僅僅作為一種思路供參考，實際使用時需要根據項目具體情況進行調整。 
可通過修改后的helloworld.jsp中的json valid test2按鈕進行調用測試。

 

原文：http://starscream.iteye.com/blog/1068905

 


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 SpringMVC 使用JSR-303進行校驗 @Valid SpringMVC 使用JSR-303進行校驗 @Valid 使用JSR-303進行校驗 @Valid 使用JSR-303進行校驗 使用JSR-303進行后台數據校驗 jsr-303 參數校驗-學習（轉） jsr-303 參數校驗—自定義校驗注解 JSR-303注解中的分組校驗groups屬性 JSR 303 進行后台數據校驗 【原】設計一個基於Spring Boot框架下的參數校驗組件（JSR-303）
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM