您的位置: 首页  >  文章  >  java使用validator进行校验

java使用validator进行校验

分类: 文章 • 2024-02-13 22:46:22
不管是html页面表单提交的对象数据还是和第三方公司进行接口对接，都需要对接收到的数据进行校验（非空、长度、格式等等）。如果使用if一个个进行校验（字段非常多），这是让人崩溃的过程。幸好jdk或hibernate都提供了对object对象的校验，只需加上相应的注解即可。

     本人喜欢学习时，都建立个maven小项目进行实践学习。

1.项目建立

java使用validator进行校验

pom.xml

[html] view plain copy
  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  2.   <modelVersion>4.0.0</modelVersion>  
  3.   <groupId>com.fei</groupId>  
  4.   <artifactId>validation-test</artifactId>  
  5.   <version>0.0.1-SNAPSHOT</version>  
  6.     
  7.   <dependencies>  
  8.     
  9.     <dependency>  
  10.         <groupId>javax.el</groupId>  
  11.         <artifactId>javax.el-api</artifactId>  
  12.         <version>2.2.4</version>  
  13.     </dependency>  
  14.       
  15.   <dependency>  
  16.         <groupId>org.hibernate</groupId>  
  17.         <artifactId>hibernate-validator</artifactId>  
  18.         <version>5.1.3.Final</version>  
  19.     </dependency>  
  20.     
  21.   </dependencies>  
  22.     
  23.     
  24. </project>  
  是用来练手的

2.基本校验练习

StudentInfo.java

[java] view plain copy
  1. package com.fei.info;  
  2.   
  3. import javax.validation.constraints.Pattern;  
  4.   
  5. import org.hibernate.validator.constraints.NotBlank;  
  6.   
  7. public class StudentInfo {  
  8.   
  9.     @NotBlank(message="用户名不能为空")  
  10.     private String userName;  
  11.       
  12.     @NotBlank(message="年龄不能为空")  
  13.     @Pattern(regexp="^[0-9]{1,2}$",message="年龄是整数")  
  14.     private String age;  
  15.       
  16.     /** 
  17.      * 如果是空，则不校验，如果不为空，则校验 
  18.      */  
  19.     @Pattern(regexp="^[0-9]{4}-[0-9]{2}-[0-9]{2}$",message="出生日期格式不正确")  
  20.     private String birthday;  
  21.       
  22.     @NotBlank(message="学校不能为空")  
  23.     private String school;  
  24.   
  25.     public String getUserName() {  
  26.         return userName;  
  27.     }  
  28.   
  29.     public void setUserName(String userName) {  
  30.         this.userName = userName;  
  31.     }  
  32.   
  33.     public String getAge() {  
  34.         return age;  
  35.     }  
  36.   
  37.     public void setAge(String age) {  
  38.         this.age = age;  
  39.     }  
  40.   
  41.     public String getBirthday() {  
  42.         return birthday;  
  43.     }  
  44.   
  45.     public void setBirthday(String birthday) {  
  46.         this.birthday = birthday;  
  47.     }  
  48.   
  49.     public String getSchool() {  
  50.         return school;  
  51.     }  
  52.   
  53.     public void setSchool(String school) {  
  54.         this.school = school;  
  55.     }  
  56. }  
ValidatorUtil.java

[java] view plain copy
  1. package com.fei.util;  
  2.   
  3. import java.util.HashMap;  
  4. import java.util.Map;  
  5. import java.util.Set;  
  6.   
  7. import javax.validation.ConstraintViolation;  
  8. import javax.validation.Validation;  
  9. import javax.validation.Validator;  
  10. import javax.validation.groups.Default;  
  11.   
  12. public class ValidatorUtil {  
  13.     private static Validator validator = Validation.buildDefaultValidatorFactory()  
  14.             .getValidator();  
  15.       
  16.     public static <T> Map<String,StringBuffer> validate(T obj){  
  17.         Map<String,StringBuffer> errorMap = null;  
  18.         Set<ConstraintViolation<T>> set = validator.validate(obj,Default.class);  
  19.         if(set != null && set.size() >0 ){  
  20.             errorMap = new HashMap<String,StringBuffer>();  
  21.             String property = null;  
  22.             for(ConstraintViolation<T> cv : set){  
  23.                 //这里循环获取错误信息，可以自定义格式  
  24.                 property = cv.getPropertyPath().toString();  
  25.                 if(errorMap.get(property) != null){  
  26.                     errorMap.get(property).append("," + cv.getMessage());  
  27.                 }else{  
  28.                     StringBuffer sb = new StringBuffer();  
  29.                     sb.append(cv.getMessage());  
  30.                     errorMap.put(property, sb);  
  31.                 }  
  32.             }  
  33.         }  
  34.         return errorMap;  
  35.     }  
  36.   
  37.      
  38. }  
ValidatorTest.java

[java] view plain copy
  1. package com.fei;  
  2.   
  3. import java.util.Map;  
  4.   
  5. import com.fei.info.StudentInfo;  
  6. import com.fei.util.ValidatorUtil;  
  7.   
  8. public class ValidatorTest {  
  9.   
  10.     public static void main(String[] args) {  
  11.         StudentInfo s = new StudentInfo();  
  12.         long startTime = System.currentTimeMillis();  
  13.         print(ValidatorUtil.validate(s));  
  14.         System.out.println("===============耗时(毫秒)=" + (System.currentTimeMillis() - startTime));  
  15.           
  16.         s.setUserName("小明");  
  17.         s.setAge("a10");  
  18.         s.setBirthday("2016-9-1");  
  19.         startTime = System.currentTimeMillis();  
  20.         print(ValidatorUtil.validate(s));  
  21.         System.out.println("===============耗时(毫秒)=" + (System.currentTimeMillis() - startTime));  
  22.           
  23.           
  24.           
  25.     }  
  26.       
  27.     private static void print(Map<String,StringBuffer> errorMap){  
  28.         if(errorMap != null){  
  29.             for(Map.Entry<String, StringBuffer> m : errorMap.entrySet()){  
  30.                 System.out.println(m.getKey() + ":" + m.getValue().toString());  
  31.             }  
  32.         }  
  33.     }  
  34. }  

来看看运行结果：

[plain] view plain copy
  1. 十二月 12, 2016 4:02:00 下午 org.hibernate.validator.internal.util.Version <clinit>  
  2. INFO: HV000001: Hibernate Validator 5.1.3.Final  
  3. school:学校不能为空  
  4. age:年龄不能为空  
  5. userName:用户名不能为空  
  6. ===============耗时(毫秒)=280  
  7. birthday:出生日期格式不正确  
  8. school:学校不能为空  
  9. age:年龄是整数  
  10. ===============耗时(毫秒)=3  
   看到运行结果，心中一喜，达到了我们的要求。


   看StudentInfo中的import发现注解的来源有来自javax和hibernate。

javax中有

java使用validator进行校验


java使用validator进行校验

hibernate中有

java使用validator进行校验


  如果现有的校验规则都不满足，则可以自定义校验规则

3.自定义校验规则

Money.java

[plain] view plain copy
  1. package com.fei.validator;  
  2.    
  3. import java.lang.annotation.ElementType;  
  4. import java.lang.annotation.Retention;  
  5. import java.lang.annotation.RetentionPolicy;  
  6. import java.lang.annotation.Target;  
  7.    
  8. import javax.validation.Constraint;  
  9. import javax.validation.Payload;  
  10.    
  11.    
  12. @Target({ElementType.FIELD, ElementType.METHOD})  
  13. @Retention(RetentionPolicy.RUNTIME)  
  14. @Constraint(validatedBy=MoneyValidator.class)  
  15. public @interface Money {  
  16.      
  17.     String message() default"不是金额形式";  
  18.      
  19.     Class<?>[] groups() default {};  
  20.      
  21.     Class<? extends Payload>[] payload() default {};  
  22.    
  23. }  

MoneyValidator.java

[plain] view plain copy
  1. package com.fei.validator;  
  2.    
  3. import java.util.regex.Pattern;  
  4.    
  5. import javax.validation.ConstraintValidator;  
  6. import javax.validation.ConstraintValidatorContext;  
  7.    
  8.    
  9. public class MoneyValidator implements ConstraintValidator<Money, Double> {  
  10.    
  11.     private String moneyReg = "^\\d+(\\.\\d{1,2})?$";//表示金额的正则表达式  
  12.     private Pattern moneyPattern = Pattern.compile(moneyReg);  
  13.      
  14.     public void initialize(Money money) {  
  15.        // TODO Auto-generated method stub  
  16.         
  17.     }  
  18.    
  19.     public boolean isValid(Double value, ConstraintValidatorContext arg1) {  
  20.        if (value == null)  
  21.            //金额是空的，返回true，是因为如果null，则会有@NotNull进行提示  
  22.            //如果这里false的话，那金额是null，@Money中的message也会进行提示  
  23.            //自己可以尝试  
  24.            return true;  
  25.        return moneyPattern.matcher(value.toString()).matches();  
  26.     }  
  27.    
  28. }  

StudentInfo.java

加上,注意因为money是Double，所以不能用@NotBlank，因为@NotBlank是对字符串校验的

[plain] view plain copy
  1. @NotNull(message="金额不能为空")  
  2.     @Money(message="金额格式不正确")  
  3.     private Double money;  

ValidatorTest.java

[plain] view plain copy
  1. package com.fei;  
  2.   
  3. import java.util.Map;  
  4.   
  5. import com.fei.info.StudentInfo;  
  6. import com.fei.util.ValidatorUtil;  
  7.   
  8. public class ValidatorTest {  
  9.   
  10.     public static void main(String[] args) {  
  11.         StudentInfo s = new StudentInfo();  
  12.         long startTime = System.currentTimeMillis();  
  13.         print(ValidatorUtil.validate(s));  
  14.         System.out.println("===============耗时(毫秒)=" + (System.currentTimeMillis() - startTime));  
  15.           
  16.         s.setUserName("小明");  
  17.         s.setAge("a10");  
  18.         s.setBirthday("2016-9-1");  
  19.         s.setMoney(100.00001);  
  20.         startTime = System.currentTimeMillis();  
  21.         print(ValidatorUtil.validate(s));  
  22.         System.out.println("===============耗时(毫秒)=" + (System.currentTimeMillis() - startTime));  
  23.           
  24.           
  25.           
  26.     }  
  27.       
  28.     private static void print(Map<String,StringBuffer> errorMap){  
  29.         if(errorMap != null){  
  30.             for(Map.Entry<String, StringBuffer> m : errorMap.entrySet()){  
  31.                 System.out.println(m.getKey() + ":" + m.getValue().toString());  
  32.             }  
  33.         }  
  34.     }  
  35. }  
运行结果：

[plain] view plain copy
  1. 十二月 12, 2016 4:42:41 下午 org.hibernate.validator.internal.util.Version <clinit>  
  2. INFO: HV000001: Hibernate Validator 5.1.3.Final  
  3. school:学校不能为空  
  4. age:年龄不能为空  
  5. money:金额不能为空  
  6. userName:用户名不能为空  
  7. ===============耗时(毫秒)=280  
  8. birthday:出生日期格式不正确  
  9. school:学校不能为空  
  10. age:年龄是整数  
  11. money:金额格式不正确  
  12. ===============耗时(毫秒)=4  

  当然，如果你的项目使用springMVC或structs2，都会对应的集成方法。

4.级联校验

  如果校验的对象中包含另一个对象信息时，校验也要同时校验另一个对象，则可以使用@Valid

ParentInfo.java

[plain] view plain copy
  1. package com.fei.info;  
  2.   
  3. import org.hibernate.validator.constraints.NotBlank;  
  4.   
  5. public class ParentInfo {  
  6.   
  7.     @NotBlank(message="父亲名称不能为空")  
  8.     private String fatherName;  
  9.       
  10.     @NotBlank(message="母亲名称不能为空")  
  11.     private String motherName;  
  12.   
  13.     public String getFatherName() {  
  14.         return fatherName;  
  15.     }  
  16.   
  17.     public void setFatherName(String fatherName) {  
  18.         this.fatherName = fatherName;  
  19.     }  
  20.   
  21.     public String getMotherName() {  
  22.         return motherName;  
  23.     }  
  24.   
  25.     public void setMotherName(String motherName) {  
  26.         this.motherName = motherName;  
  27.     }  
  28. }  
StudentInfo.java

中加入，set,get是必须的

[plain] view plain copy
  1. /**  
  2.      * 如果不加@NotNull，则prentInfo=null时，不会对ParentInfo内的字段进行校验  
  3.      */  
  4.     @NotNull(message="父母信息不能为空")  
  5.     @Valid  
  6.     private ParentInfo parentInfo;  
ValidatorTest.java

[java] view plain copy
  1. package com.fei;  
  2.   
  3. import java.util.Map;  
  4.   
  5. import com.fei.info.ParentInfo;  
  6. import com.fei.info.StudentInfo;  
  7. import com.fei.util.ValidatorUtil;  
  8.   
  9. public class ValidatorTest {  
  10.   
  11.     public static void main(String[] args) {  
  12.         StudentInfo s = new StudentInfo();  
  13.         long startTime = System.currentTimeMillis();  
  14.         print(ValidatorUtil.validate(s));  
  15.         System.out.println("===============耗时(毫秒)=" + (System.currentTimeMillis() - startTime));  
  16.           
  17.         s.setUserName("小明");  
  18.         s.setAge("a10");  
  19.         s.setBirthday("2016-9-1");  
  20.         s.setMoney(100.00001);  
  21.         s.setParentInfo(new ParentInfo());  
  22.         startTime = System.currentTimeMillis();  
  23.         print(ValidatorUtil.validate(s));  
  24.         System.out.println("===============耗时(毫秒)=" + (System.currentTimeMillis() - startTime));  
  25.           
  26.           
  27.           
  28.     }  
  29.       
  30.     private static void print(Map<String,StringBuffer> errorMap){  
  31.         if(errorMap != null){  
  32.             for(Map.Entry<String, StringBuffer> m : errorMap.entrySet()){  
  33.                 System.out.println(m.getKey() + ":" + m.getValue().toString());  
  34.             }  
  35.         }  
  36.     }  
  37. }  

运行结果：

[plain] view plain copy
  1. 十二月 12, 2016 4:56:16 下午 org.hibernate.validator.internal.util.Version <clinit>  
  2. INFO: HV000001: Hibernate Validator 5.1.3.Final  
  3. parentInfo:父母信息不能为空  
  4. school:学校不能为空  
  5. age:年龄不能为空  
  6. money:金额不能为空  
  7. userName:用户名不能为空  
  8. ===============耗时(毫秒)=285  
  9. birthday:出生日期格式不正确  
  10. school:学校不能为空  
  11. parentInfo.fatherName:父亲名称不能为空  
  12. age:年龄是整数  
  13. parentInfo.motherName:母亲名称不能为空  
  14. money:金额格式不正确  
  15. ===============耗时(毫秒)=9  

转自：https://blog.****.net/dream_broken/article/details/53584169

相关推荐