hibernate Validation 自定义枚举校验

小灰灰 2023-06-08 10:59 14阅读 0赞

### 文章目录 ###

*   *  1、 定义通用的枚举校验器 EnumValueValidator
     *  2、业务场景
     *   *  2.1、业务场景1
         *  2.2、业务场景2
     *  3、使用
     *   *  3.1、 使用校验器
         *  3.2、 捕获错误
     *  4、maven 依赖
     *  5、相关文章

## 1、 定义通用的枚举校验器 EnumValueValidator ##

这个枚举校验器是通用的，正常情况下，一个项目中只要写这一枚举校验器即可。

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    import java.lang.reflect.Method;
    import java.lang.reflect.Modifier;
    
    import javax.validation.Constraint;
    import javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    import javax.validation.Payload;
    
    @Target({  ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
    @Retention(RetentionPolicy.RUNTIME)
    @Constraint(validatedBy = EnumValueValidator.Validator.class)
    /** * 枚举校验器 */
    public @interface EnumValueValidator { 
    
    	String message() default "{EnumValueValidator's value is invalid}";
    
    	Class<?>[] groups() default { };
    
    	Class<? extends Payload>[] payload() default { };
    
    	Class<? extends Enum<?>> enumClass();
    
    	class Validator implements ConstraintValidator<EnumValueValidator, Object> { 
    
    		private Class<? extends Enum<?>> enumClass;
    		
    		private String enumMethod="isValidName";
    		
    		
    		@Override
    		public void initialize(EnumValueValidator enumValue) { 
    			enumClass=enumValue.enumClass();
    		}
    
    		@Override
    		public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) { 
    			if (value == null) { 
    				return Boolean.FALSE;
    			}
    
    			Class<?> valueClass = value.getClass();
    
    			try { 
    				
    				Method method = enumClass.getMethod(enumMethod, valueClass);
    				if (!Boolean.TYPE.equals(method.getReturnType()) && !Boolean.class.equals(method.getReturnType())) { 
    					return Boolean.FALSE;
    				}
    
    				if(!Modifier.isStatic(method.getModifiers())) { 
    					return Boolean.FALSE;
    				}
    	
    				Boolean result = (Boolean)method.invoke(null, value);
    				return result == null ? false : result;
    			} catch (Exception e) { 
    				e.printStackTrace();
    				return Boolean.FALSE;
    			}
    			
    		}
     
    	}
    }

## 2、业务场景 ##

### 2.1、业务场景1 ###

邮寄状态 `postStatus` 的取值限定在范围是 0、1、2、3 。  
其中：  
0 ：表示 未邮寄  
1 ：表示 已邮寄  
2 ：表示 收到货  
3 ：表示 邮寄出错

**定义枚举类：**

/** * 枚举，必须实现 isValidName 方法 */
    public enum PostStatusEnum  { 
    	
    	
    	//0:未邮寄, 1:已邮寄,2:收到货,3:邮寄出错
    	A("0", "未邮寄"),
    	B("1", "已邮寄"),
    	C("2", "收到货"),
    	D("3", "邮寄出错");
    
    	private String code;
    
    	private String desc;
    
    	private PostStatusEnum() { 
    	}
    
    	private PostStatusEnum(String code, String desc) { 
    		this.code = code;
    		this.desc = desc;
    	}
    
    	public boolean match(final String code) { 
    		return this.getCode().equals(code);
    	}
    
    	/** * 是否是合法的用户类型 * * @param code * 用户类型 * @return 是否合法 */
    	public static boolean isValidName(final String code) { 
    		for (PostStatusEnum item : values()) { 
    			if (item.getCode().equals(code)) { 
    				return true;
    			}
    		}
    		return false;
    	}
    
    	public String getCode() { 
    		return code;
    	}
    
    	public void setCode(String code) { 
    		this.code = code;
    	}
    
    	public String getDesc() { 
    		return desc;
    	}
    
    	public void setDesc(String desc) { 
    		this.desc = desc;
    	}
    }

### 2.2、业务场景2 ###

证件类型 `cardType` 的取值 限定范围是 A、B、C、D、E、F 。  
其中：  
A ：表示 身份证  
B ：表示 护照  
C ：表示 军官  
D ：表示 台湾居民来往大陆通行证  
E ：表示 港澳居民来往内地通行证  
F ：表示 外国人永久居留

**定义枚举类 ：**

/** *用户信息 —— 证件类型 CardType */
    public enum UserInfoCardTypeEnum  { 
    	
    	
    	A("A", "身份证"),
    	B("B", "护照"),
    	C("C", "军官"),
    	D("D", "台湾居民来往大陆通行证"),
    	E("E", "港澳居民来往内地通行证"),
    	F("F", "外国人永久居留")
    	;
    
    	private String code;
    
    	private String desc;
    
    	private UserInfoCardTypeEnum() { 
    	}
    
    	private UserInfoCardTypeEnum(String code, String desc) { 
    		this.code = code;
    		this.desc = desc;
    	}
    
    	public boolean match(final String code) { 
    		return this.getCode().equals(code);
    	}
    
    	/** * 是否是合法的用户类型 * * @param code * 用户类型 * @return 是否合法 */
    	public static boolean isValidName(final String code) { 
    		for (UserInfoCardTypeEnum item : values()) { 
    			if (item.getCode().equals(code)) { 
    				return true;
    			}
    		}
    		return false;
    	}
    
    	public String getCode() { 
    		return code;
    	}
    
    	public void setCode(String code) { 
    		this.code = code;
    	}
    
    	public String getDesc() { 
    		return desc;
    	}
    
    	public void setDesc(String desc) { 
    		this.desc = desc;
    	}
    
    }

## 3、使用 ##

### 3.1、 使用校验器 ###

public class UpdateOrderStatusVO implements Serializable { 
    	
     
        /** * 邮寄状态：0:未邮寄, 1:已邮寄,2:收到货,3:邮寄出错 */
        @NotNull(message="邮寄状态不能为空")
        @EnumValueValidator(enumClass = PostStatusEnum.class,message="邮寄状态取值不正确")
        private String postStatus;
    
        /** * 证件类型 */
        @NotNull(message="证件类型不能为空")
        @EnumValueValidator(enumClass = UserInfoCardTypeEnum.class,message="证件类型取值不正确")
        private String  cardType;
    
    
       // getter/setter
       
    }

### 3.2、 捕获错误 ###

**方式1： 通过 Controller 的 BindingResult 捕获错误：**

@RequestMapping("/order/updateStatus")
    public void saveAll(@Validated UpdateOrderStatusVO vo, BindingResult bindingResult,@Validated Student student, BindingResult bindingResult2) { 
        if (bindingResult.hasErrors()) { 
            for (ObjectError error : bindingResult.getAllErrors()) { 
                System.out.println(error.getDefaultMessage());
            }
    
        }
        System.out.println("-----------");
    
        if (bindingResult2.hasErrors()) { 
            for (ObjectError error : bindingResult2.getAllErrors()) { 
                System.out.println(error.getDefaultMessage());
            }
    
        }
    }

**方式2： 也可以通过 ConstraintViolationException 捕获错误：**

@ControllerAdvice
    @Component
    public class GlobalExceptionHandler { 
    
    	/** * 拦截捕捉 MissingServletRequestParameterException 异常 */
    	@ResponseBody
    	@ExceptionHandler(value = MissingServletRequestParameterException.class)
    	public String doMissingServletRequestParameterHandler(MissingServletRequestParameterException exception) { 
    		MissingServletRequestParameterException exs = (MissingServletRequestParameterException) exception;
    		System.err.println(exs.getMessage());
    		return "bad request, ";
    	}
    
    	/** * 拦截捕捉 ConstraintViolationException 异常 */
    	@ResponseBody
    	@ExceptionHandler(value = ConstraintViolationException.class)
    	public Map ConstraintViolationExceptionHandler(ConstraintViolationException ex) { 
    		Map map = new HashMap();
    		Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
    		Iterator<ConstraintViolation<?>> iterator = constraintViolations.iterator();
    		List<String> msgList = new ArrayList<>();
    		while (iterator.hasNext()) { 
    			ConstraintViolation<?> cvl = iterator.next();
    			System.err.println(cvl.getMessageTemplate());
    			msgList.add(cvl.getMessageTemplate());
    		}
    		map.put("status", 500);
    		map.put("msg", msgList);
    		return map;
    	}
    }

## 4、maven 依赖 ##

javaBean hibernate Validation： https://blog.csdn.net/xiaojin21cen/article/details/90572834

## 5、相关文章 ##

SpringMVC/Boot中的校验框架 @Valid 和 @Validated的使用： https://blog.csdn.net/xiaojin21cen/article/details/90572980