BeanValidation2.0(JSR 380)的简单使用方法

概述

本文简单介绍BeanValidation 2.0简单的使用,包含注解使用和如何应用。BeanValidation2.0之前还有1.1(JSR 349)和1.0(JSR303)
兼容性表格:

Bean Validation Hibernate Validation JDK Spring Boot
1.1 5.4 + 6+ 1.5.x
2.0 6.0 + 8+ 2.0.x

JSR 380

JSR 380规范是bean验证的java api规范,javaEE和javaSE的一部分,使用注解如@NotNull, @Min, and @Max,确保bean属性符合一定条件。
jsr380需要java8或以上版本,利用java8中新增的特性,如注解类型,支持新的类如:Optional 和 LocalDate。点击查看完整jsr380规范.

Maven配置

<dependency>
    <groupId>javax.validationgroupId>
    <artifactId>validation-apiartifactId>
    <version>2.0.1.Finalversion>
dependency>
<dependency>
  <groupId>org.hibernate.validatorgroupId>
  <artifactId>hibernate-validatorartifactId>
  <version>6.0.16.Finalversion>
dependency>

hibernate-validator是jsr380的实现

注解

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) 被注释的元素必须符合指定的正则表达式
@Email 被注释的元素必须是邮箱地址
@FutureOrPresent 被注释的元素必须是一个将来(含当前)的日期
@PastOrPresent 被注释的元素必须是一个过去(含当前)的日期
@Negative 被注释的元素必须是负数
@NegativeOrZero 被注释的元素必须是负数或者0
@Positive 被注释的元素必须是正数
@PositiveOrZero 被注释的元素必须是正数或者0
@NotBlank 被注释的元素必须不能是空串或者只含空格的字符串
@NotEmpty 被注释的元素必须不能是空串

工具类


import lombok.Getter;
import lombok.Setter;

import javax.validation.*;
import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.groups.ConvertGroup;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import static com.google.common.collect.Iterables.getFirst;

/**
 * @author hk
 * @date 2019/8/15
 */
public class ValidateUtil {
    public interface Insert{};
    public interface Update{};
    public interface Other{};


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

    /**
     * 验证某个bean的参数
     *
     * @param object 被校验的参数
     */
    public static<T> ConstraintViolation<T> getValidateConstraintViolation(T object,Class... groups) {
        //获得验证器
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        //执行验证
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(object,groups);
        //如果有验证信息,则将第一个取出来包装成异常返回
        ConstraintViolation<T> constraintViolation = getFirst(constraintViolations, null);
        return constraintViolation;
    }

    /**
     * 验证某个bean的参数
     *
     * @param object 被校验的参数
     */
    public static<T> String getValidateMsg(T object,Class... groups) {
        //获得验证器
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        //执行验证
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(object,groups);
        //如果有验证信息,则将第一个取出来包装成异常返回
        ConstraintViolation<T> constraintViolation = getFirst(constraintViolations, null);
        if (constraintViolation != null) {
            return constraintViolation.getMessage();
        }else{
            return null;
        }
    }

    @Getter
    @Setter
    public static class Demo {

        @NotNull(message = "不能为空",groups = Insert.class)
        private String name;
        private List<@Email String> emails;
        //级联验证只要在相应的字段上加@Valid即可,会进行级联验证;@ConvertGroup的作用是当验证Demo的分组是Insert时,那么验证User的分组是Other,即分组验证的转换。
        @Valid
        @ConvertGroup(from=Insert.class, to=Other.class)
        private User user;

    }
    @Getter
    @Setter
    public static class User{
        @NotBlank(message = "名字不能为空",groups = Other.class)
        private String name;

    }


    public static void main(String[] args) {
        Demo demo = new Demo();
        List<String> emails = new ArrayList<>();
        emails.add("[email protected]");
        demo.setEmails(emails);
        User user = new User();
        user.setName("  ");
        demo.setUser(user);
        System.out.println(getValidateMsg(demo,Insert.class));
    }
}


结语:BeanValidation也可以和springMVC结合使用,注解的用法一致,网上例子很多请自行百度。

参考链接:

  1. javax.validation 效验工具(validation-api组件)使用教程
  2. 深入了解数据校验:Bean Validation 2.0(JSR380)
  3. SpringMVC 使用JSR-303进行校验Bean Validation------级联验证

你可能感兴趣的:(BeanValidation2.0(JSR 380)的简单使用方法)