数据校验规范

Bean Validation

简介

Bean Validation是Java定义的一套基于注解的数据校验规范,目前已经从JSR 303的1.0版本升级到JSR 349的1.1版本,再到JSR 380的2.0版本(2.0完成于2017.08),已经经历了三个版本

"数据校验"是这个比较常见的工作,在日常的开发中贯穿于代码的各个层次,从上层的View层到下底层的数据层,为了保证程序的正确运行以及数据的正确性,开发者通常会在不同层次间做数据校验而且这些校验通常是重复的,为了实现代码的复用性,通常会把校验的逻辑写在被校验对象上。

Bean Validation就是为了解决这样的问题,它定义了一套元数据模型和API对JavaBean实现校验,默认是以注解作为元数据,可以通过XML重写或者拓展元数据,通常来说注解的方式可以实现比较简单逻辑的校验,而复杂校验就需要通过XML来描述。可以说Bean Validation是JavaBean的一个拓展,也就是说它布局于哪一层的代码,不局限于Web应用还是端应用。

Bean Validation 2.0 关注点

使用Bean Validation的最低Java版本为Java 8
支持容器的校验,通过TYPE_USE类型的注解实现对容器内容的约束:List<@Email String>
支持日期/时间的校验,@Past和@Future
拓展元素数据:@Email,@NotEmpty,@NotBlank,@Positive, @PositiveOrZero,@Negative,@NegativeOrZero,@PastOrPresent和@FutureOrPresent

Bean Validation的实现

Bean Validation在2.0之前有两个官方认可的实现:Hibernate Validator和Apache BVal,但如果你想用2.0版本的话,基本上只有Hibernate Validator,而这里我使用的是Hibernate Validator,其他实现不做展开。

使用

安装依赖

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.0.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.1.Final</version>
</dependency>
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.1-b09</version>
</dependency>

Demo-直接使用
一个简单的JavaBean

public class User {
    private String name;
    private String gender;
    @Positive
    private int age;
    private List<@Email String> emails;// getter and setter 
    // ...
}

使用Validator校验

User user = new User();
​
user.setName("seven");
user.setGender("man");
user.setAge(-1);
user.setEmails(Arrays.asList("sevenlin@gmail.com", "sevenlin.com"));
​
Set<ConstraintViolation<User>> result = Validation.buildDefaultValidatorFactory().getValidator().validate(user);
​
List<String> message
    = result.stream().map(v -> v.getPropertyPath() + " " + v.getMessage() + ": " + v.getInvalidValue())
        .collect(Collectors.toList());
​
message.forEach(System.out::println);

校验结果

emails[1].<list element> must be a well-formed email address: sevenlin.com
age must be greater than 0: -1

集成到Spring MVC
配置

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {@Override
    public Validator getValidator(); {
        // ...
    }
}

注意,使用Spring MVC 的时候,Spring会默认注册从classpath下找到的可用Bean Validation,所以如果不需要自定义Validation

在Controller中校验请求参数 使用注解@Valid和@Validated实现对请求参数的校验

@PostMapping(value = "/create")
@ResponseBody
public ResponseEntity<User> create(@RequestBody @Validated UserForm form) {
    User user = userService.create(form);
    return ResponseEntity.ok().body(user);
}

配置统一校验结果处理

@ControllerAdvice
public class ValidationResponseAdvice extends ResponseEntityExceptionHandler {
    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        String message = ex.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage)
                .collect(Collectors.joining(","));
        return ResponseEntity.badRequest().body(message);
    }
}

常见元数据

常见元数据

©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页