Java参数校验工具validation实践

介绍

　　在项目开发当中，数据校验是你必须要考虑和面对的事情，为此要写上一大串的代码进行校验，这样就会导致代码冗余和一些管理的问题。

例如下面的代码：

public void push(List<Long> userList, String url, String content) {
        Preconditions.checkArgument(CollectionUtils.isNotEmpty(userList), "用户列表不能为空");
        Preconditions.checkArgument(StringUtils.isNotEmpty(url), "推送url不能为空");
        Preconditions.checkArgument(StringUtils.isNotEmpty(content), "推送内容不能为空");
    }

　　validation可以做以下事情

• validation可以抛出统一的参数校验异常，方便定位问题
• 编程简单，只需要注解就能搞定，不需要编写大量的代码

　　validation提供以下注解：

使用

　　添加JAR包依赖

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

一、简单的参数校验

public class UserBean {
    @Range(min = 20, max = 50, message = "age应该在[20，50]之间")
    private Integer age;

    @NotNull(message = "name不能为空")
    private String name;

    @Length(max = 100, message = "address不能超过100")
    private String address;

    @Email(message = "email格式不对")
    private String email;


    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }


    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

}

 　　创建对象验证器

/**
 * 对象验证器
 *
 * Created by Albert on 18/1/25.
 */
public class BeanValidator {

    /**
     * 验证某个bean的参数
     *
     * @param object 被校验的参数
     * @throws ValidationException 如果参数校验不成功则抛出此异常
     */
    public static <T> void validate(T object) {
        //获得验证器
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        //执行验证
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(object);
        //如果有验证信息，则取出来包装成异常返回
        if (CollectionUtils.isEmpty(constraintViolations)) {
            return;
        }
        throw new ValidationException(convertErrorMsg(constraintViolations));
    }

    /**
     * 转换异常信息
     * @param set
     * @param <T>
     * @return
     */
    private static <T> String convertErrorMsg(Set<ConstraintViolation<T>> set) {
        Map<String, StringBuilder> errorMap = new HashMap<>();
        String property;
        for (ConstraintViolation<T> cv : set) {
            //这里循环获取错误信息，可以自定义格式
            property = cv.getPropertyPath().toString();
            if (errorMap.get(property) != null) {
                errorMap.get(property).append("," + cv.getMessage());
            } else {
                StringBuilder sb = new StringBuilder();
                sb.append(cv.getMessage());
                errorMap.put(property, sb);
            }
        }
        return errorMap.toString();
    }
}

 　　编写测试类

public class ValidatorTest {

    public static void main(String[] args) {
        UserBean userBean = new UserBean();
        userBean.setAge(12);
        userBean.setName("张三");
        userBean.setAddress("124444444112");
        userBean.setEmail("123");

        BeanValidator.validate(userBean);
    }
}

　　运行结果

 二、自定义验证器

　　定义注解，message、groups和payload三个属性是必须定义的。

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ZipCodeValidator.class)
public @interface ZipCode {
    String message() default "";
    Class<?>[] groups() default {};  
    Class<? extends Payload>[] payload() default {};
}

 　　定义验证类

public class ZipCodeValidator implements ConstraintValidator<ZipCode, String> {

    private String zipCodeReg = "[1-9]d{5}(?!d)";//表示邮编的正则表达式
    private Pattern zipCodePattern = Pattern.compile(zipCodeReg);


    @Override
    public void initialize(ZipCode zipCode) {

    }

    @Override
    public boolean isValid(String val, ConstraintValidatorContext constraintValidatorContext) {
        if(val == null) {
            return true;
        }
        return zipCodePattern.matcher(val).matches();
    }
}

 　　UserBean 加入以下代码

@ZipCode(message = "邮编格式错误")
    private String zipCode;

public String getZipCode() {
        return zipCode;
    }

    public void setZipCode(String zipCode) {
        this.zipCode = zipCode;
    }

 　　编写测试类

public class ValidatorTest {

    public static void main(String[] args) {
        UserBean userBean = new UserBean();
        userBean.setAge(12);
        userBean.setName("张三");
        userBean.setAddress("124444444112");
        userBean.setEmail("123");

        userBean.setZipCode("000111");
        BeanValidator.validate(userBean);
    }
}

 　　运行结果

结语

本文只列举了部分常用的校验方法，还有更多的使用方式，就不在这里一一列举了。