Bean Validation

BeanValidation实战

原创于 2018-10-08 10:52:59 发布 · 433 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#Bean Validation #Java #叩丁狼教育

Java基础专栏收录该内容

86 篇文章

订阅专栏

本文介绍BeanValidation框架，用于JavaBean的数据校验，避免代码冗余，确保数据一致性。演示了使用Hibernate Validator实现，包括常见注解如@NotNull、@Email、@Size等，以及如何在Spring MVC中配置和使用。

本文作者：梁开权，叩丁狼高级讲师。原创文章，转载请注明出处。

关于 Bean Validation

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

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

更多详细的信息可以参考JSR 303 – Bean Validation 规范,接下来给大家展示下怎么使用

搭建环境

我们这里使用的是Hibernate提供的validator实现

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

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context</artifactId>
  <version>5.0.8.RELEASE</version>
</dependency>

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-webmvc</artifactId>
  <version>5.0.8.RELEASE</version>
</dependency>

该规范中提供的注解

表 1. Bean Validation 中内置的 constraint
Constraint 详细信息
@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(value) 被注解的元素必须符合指定的正则表达式

表 2. Hibernate Validator 附加的 constraint
Constraint 详细信息
@Email 被注解的元素必须是电子邮箱地址
@Length 被注解的字符串的大小必须在指定的范围内
@NotEmpty 被注解的字符串的必须非空
@Range 被注解的元素必须在合适的范围内

演示效果

定义一个JavaBean

@Setter@Getter
public class User {
    @NotNull @Email
    private String email;

    @NotNull @Size(min=4, max=6)
    private String name;

    @NotNull @Min(16) @Max(60)
    private Integer age;

    @NotNull @DecimalMin("100") @DecimalMax("500")
    private BigDecimal price;
}

在Bean中规定了以下内容
email -> 必填并且满足邮箱格式
name -> 必填长度4到6位
age -> 必填值在16到60之间
price -> 必填值在100到200之间

在Spring容器中配置检验器和启动校验功能

    <!-- 指定自己定义的validator -->
    <mvc:annotation-driven validator="validator"/>

    <!-- 以下 validator ConversionService 在使用 mvc:annotation-driven 会自动注册-->
    <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
    </bean>

配置了一个本地校验器工厂Bean,内部使用了Hibernate提供的校验器,注册到Spring mvc中

定义一个控制器

@RestController
public class UserController {

    @RequestMapping("/users")
    public Object get(@Valid User u, BindingResult result) {
        if (result.hasFieldErrors()) { 
            Map<String, String> map = new HashMap<>();
            for (ObjectError objectError : result.getAllErrors()) {
                FieldError e = (FieldError) objectError;
                map.put(e.getField(), e.getDefaultMessage());
            }
            return map;
        }
        return u;
    }
}

@Valid表示这个对象需要校验,并且把校验的结果存储在result对象中,BindingResult对象必须同步出现在需要校验的方法参数中否则不能被访问到,报错400
如果校验的对象有错误,把错误的字段和错误的信息收集起来返回,正常的话我就直接返回该对象,我们一起来看看postman测试的结果:
测试结果