java bean通过注解实现校验

Love The Way You Lie 2022-06-02 09:37 186阅读 0赞

#### 1、引入需要的jar包 ####

<dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>5.4.1.Final</version>
    </dependency>
    
    <dependency>
        <groupId>javax.validation</groupId>  
        <artifactId>validation-api</artifactId>  
        <version>1.1.0.Final</version>          
    </dependency>

#### 2、封装工具类 ####

import java.util.Set;
    
    import javax.validation.ConstraintViolation;
    import javax.validation.Validation;
    import javax.validation.ValidationException;
    import javax.validation.Validator;
    import javax.validation.ValidatorFactory;
    
    public class ValidationUtil { 
    
        private static Validator validator;  
    
        static {  
            ValidatorFactory vf = Validation.buildDefaultValidatorFactory();  
            validator = vf.getValidator();  
        }
    
        public static <T> void validate(T t) throws ValidationException {
            Set<ConstraintViolation<T>> set = validator.validate(t);
            if (set.size() > 0) {
                StringBuilder validateError = new StringBuilder();
                for (ConstraintViolation<T> val : set) {
                    validateError.append(val.getMessage() + " ;");
                }
                throw new ValidationException(validateError.toString());
            }
        }
    }

#### 3、在对应的实体类中，给需要进行校验的实体添加相应的注解 ####

@Size(min = 1,message = "名称不能为空！")
    @NotNull(message = "名称不能为空！")
    private String biddingName;

#### 4、在实现类中调用即可 ####

@Override
    public Response saveBidding(PurchaseBiddingHeaderVO headerVO) {
    try {
        ValidationUtil.validate(headerVO);
        .
        .
        .
    } catch(ValidationException e){
        e.printStackTrace();
        //返回校验结果给前台
        return getErrorResponse(ResponseCodeEnum.ERROR.getValue(), e.getMessage());
    }catch (Exception e) {
        e.printStackTrace();
        throw new RuntimeException();
    }

#### 常用注解列表 ####

@Null   被注释的元素必须为 null  
    @NotNull    被注释的元素必须不为 null  
    @AssertTrue     被注释的元素必须为 true  
    @AssertFalse    被注释的元素必须为 false  
    @Min(value)     被注释的元素必须是一个数字，其值必须大于等于指定的最小值  
    @Max(value)     被注释的元素必须是一个数字，其值必须小于等于指定的最大值  
    @DecimalMin(value)  被注释的元素必须是一个数字，其值必须大于等于指定的最小值  
    @DecimalMax(value)  被注释的元素必须是一个数字，其值必须小于等于指定的最大值  
    @Size(max=, min=)   被注释的元素的大小必须在指定的范围内  
    @Digits (integer, fraction)     被注释的元素必须是一个数字，其值必须在可接受的范围内  
    @Past   被注释的元素必须是一个过去的日期  
    @Future     被注释的元素必须是一个将来的日期  
    @Pattern(regex=,flag=)  被注释的元素必须符合指定的正则表达式  
    
    //Hibernate Validator 附加的 constraint 
    @NotBlank(message =)   验证字符串非null，且长度必须大于0  
    @Email  被注释的元素必须是电子邮箱地址  
    @Length(min=,max=)  被注释的字符串的大小必须在指定的范围内  
    @NotEmpty   被注释的字符串的必须非空  
    @Range(min=,max=,message=)  被注释的元素必须在合适的范围内