JSR-303 Bean Validation 介绍及 Spring MVC 服务端验证最佳实践

Posted 2020-10-02 Orson

   任何时候，当要处理一个应用程序的业务逻辑，数据校验是你必须要考虑和面对的事情。

   应用程序必须通过某种手段来确保输入参数在上下文来说是正确的。

   分层的应用在很多时候，同样的数据验证逻辑会出现在不同的层，这样就会导致代码冗余和一些管理的问题。

   为了避免这样或那样的情况发生，最好是将验证逻辑与相应的数据模型进行绑定。

1. JSR-303 Bean Validation

   JSR 是Java Specification Requests 的缩写，是指向 JCP(Java Community Process) 提出新增一个标准化技术规范的正式请求。

   任何人都可以提交 JSR，以向 Java 平台增添新的 API 和服务，已审核通过的规范涉及 Java 各个领域，有兴趣可以了解一下。

   Bean Validation 是一个运行时的数据验证框架，为 JavaBean 验证定义了相应的元数据模型和 API。

   默认的元数据是 Java Annotations，当然也可以使用 XML 可以对已存在的元数据信息进行覆盖和扩展。

   在应用中通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode， 就可以确保数据模型的正确性。

   constraint 可以注解到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constraint。

   Hibernate Validator 做为 Bean Validation 的参考实现 .提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。

   Sun validation-api.jar 中定义的规范 constraint

   Hiber-Validator 自定义的几个 constraint

2. Spring MVC 服务端验证实践

   只需要很简单的三个步骤，就可以在 Spring MVC 中校验数据模型，首先将需要的 jar 依赖进来

      <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.0.1.Final</version>
        </dependency>

   然后在需要校验数据模型上添加校验注解，如果数据模型为引入其他公司或项目,编写 xml 同样是可行的。

public class UserVO {
    @NotNull(message = "uuid 不能为空！")
    private String uuid;

    @NotEmpty(message = "用户名称不能为空！")
    private String name;

    private String passwd;

    private String sex;

    private Date birthday;
    
    @Length(min = 11, max = 11, message = "电话号码长度必须为11位！")
    private String phone;

    private String photo;

    @Email(message = "电子邮箱地址不合法！")
    private String email;

    private String yxbz;

    private String sorts;

    .....setter/getter
}

   最后就是验证并获取结果的过程，你可以硬编码编写通用方法在项目中使用，像下面这样。

   private void validBean(Object targerBean) {
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Set<ConstraintViolation<Object>> violations = validator.validate(targerBean);
        for (ConstraintViolation<Object> violation : violations) {
            System.out.println(violation.getMessage());
        }
    }

   或者你可以借助 Spring MVC 封装好的 Validated 注解 和 BindingResult 对象更优雅的完成校验的事情。

   本文只做抛砖引玉之用，具体项目具体场景请自行拿捏。