JSR303-Bean Validation介绍与基于SpringBoot项目使用

JSR303-Bean Validation介绍与基于SpringBoot项目使用

1.关于Bean Validation

在任何时候，当你要处理一个应用程序的业务逻辑，数据校验是你必须要考虑和面对的事情。应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的。在通常的情况下，应用程序是分层的，不同的层由不同的开发人员来完成。很多时候同样的数据验证逻辑会出现在不同的层，这样就会导致代码冗余和一些管理的问题，比如说语义的一致性等。为了避免这样的情况发生，最好是将验证逻辑与相应的域模型进行绑定。

Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。缺省的元数据是 Java Annotations，通过使用 XML 可以对原有的元数据信息进行覆盖和扩展。在应用程序中，通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode， 就可以确保数据模型（JavaBean）的正确性。constraint 可以附加到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。

下载 JSR 303 – Bean Validation 规范 http://jcp.org/en/jsr/detail?id=303

Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。如果想了解更多有关 Hibernate Validator 的信息，请查看 http://www.hibernate.org/subprojects/validator.html

2.Constraint介绍

Bean Validation 中内置的 constraint

Hibernate Validator 附加的 constraint

3.Springboot项目中应用

首先，引入maven依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

然后在定义的javabean中可以直接使用上述的constraint, 如下所示，非常方便

/**
 * <p>@filename LoginVO</p>
 * <p>
 * <p>@description 登录VO</p>
 *
 * @author llspace
 * @version 1.0
 * @since 2019/6/19 15:53
 **/
@Data
public class LoginVO {
    @NotBlank(message = "用户名不能为空")
    @Email
    private String username;

    @NotBlank(message = "密码不能为空")
    @Length(min = 6, message = "密码长度至少6位")
    private String password;
}

4.自定义Constraint实现

一个 constraint 通常由 annotation 和相应的 constraint validator 组成，它们是一对多的关系。也就是说可以有多个 constraint validator 对应一个 annotation。在运行时，Bean Validation 框架本身会根据被注释元素的类型来选择合适的 constraint validator 对数据进行验证。

有些时候，在用户的应用中需要一些更复杂的 constraint。Bean Validation 提供扩展 constraint 的机制。可以通过两种方法去实现，一种是组合现有的 constraint 来生成一个更复杂的 constraint，另外一种是开发一个全新的 constraint。

下面主要介绍下如何在项目中开发一个全新的 constraint，模仿@Email来自定义实现@Mobile

同上依旧是基于springboot+maven，引入上述依赖

第一步，定义一个注解类

/**
 * <p>@filename IsMobile</p>
 * <p>
 * <p>@description Mobile Validator注解类</p>
 *
 * @author llspace
 * @version 1.0
 * @since 2019/6/19 17:22
 **/
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {MobileValidator.class })
public @interface  Mobile {

    boolean required() default true;

    String message() default "请输入正确的手机号码!";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };
}

第二步，实现MobileValidator校验器(实现ConstraintValidator接口)

/**
 * <p>@filename MobileValidator</p>
 * <p>
 * <p>@description 自定义Mobile Validator</p>
 *
 * @author llspace
 * @version 1.0
 * @since 2019/6/19 17:23
 **/

public class MobileValidator implements ConstraintValidator<Mobile, String> {

    private boolean required = false;

    @Override
    public void initialize(IsMobile constraintAnnotation) {
        required = constraintAnnotation.required();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if(required) {
            return ValidatorUtil.isMobile(value);
        }else {
            if(StringUtils.isEmpty(value)) {
                return true;
            }else {
                return ValidatorUtil.isMobile(value);
            }
        }
    }
}

第三布，实现手机号验证工具类

/**
 * <p>@filename ValidatorUtil</p>
 * <p>
 * <p>@description 自定义Validator验证方法工具类</p>
 *
 * @author llspace
 * @version 1.0
 * @since 2019/6/19 17:04
 **/
public class ValidatorUtil {
   
   private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
   
   public static boolean isMobile(String src) {
      if(StringUtils.isEmpty(src)) {
         return false;
      }
      Matcher m = mobile_pattern.matcher(src);
      return m.matches();
   }

}

OK, 至此自定义@Mobile constraint就实现了，有兴趣的小伙伴们自己动手试试吧！