Java Bean 校验基础

╰+攻爆jí腚メ 2022-09-04 11:55 13阅读 0赞

### 文章目录 ###

*  1.介绍
 *  2. JSR 380
 *  3.依赖
 *   *  3.1. 校验 API
     *  3.2. 校验 API 参考实现
     *  3.3. 表达式语言依赖
 *  4.使用校验注解
 *  5.程序化校验
 *   *  5.1. 定义 Bean
     *  5.2.校验bean
 *  6.总结

# 1.介绍 #

介绍使用标准框架 JSR 380（也称为 Bean Validation 2.0）校验 Java bean 的基础知识。

在大多数应用程序中，验证用户输入是一个非常普遍的要求。 而 Java Bean Validation 框架已经成为处理这种逻辑的事实标准。

# 2. JSR 380 #

JSR 380 是用于 bean 校验的 Java API 规范，是 Jakarta EE 和 JavaSE 的一部分。 这使用@NotNull、@Min 和@Max 等注解确保bean 的属性满足特定条件。

此版本需要 Java 8 或更高版本，并利用 Java 8 中添加的新功能，例如类型注解和对 Optional 和 LocalDate 等新类型的支持。

# 3.依赖 #

## 3.1. 校验 API ##

根据 JSR 380 规范，validation-api 依赖项包含标准校验 API：

<dependency>
        <groupId>javax.validation</groupId>
        <artifactId>validation-api</artifactId>
        <version>2.0.1.Final</version>
    </dependency>

## 3.2. 校验 API 参考实现 ##

Hibernate Validator 是校验 API 的参考实现。

要使用它，需要添加以下依赖项：

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

说明：hibernate-validator 与 Hibernate 的持久性方面完全分开。 因此，通过将其添加为依赖项，不会将这些持久性方面添加到项目中。

## 3.3. 表达式语言依赖 ##

JSR 380 支持变量插值，允许在违规消息中使用表达式。

为了解析这些表达式，将添加来自 GlassFish 的 javax.el 依赖项，其中包含表达式语言规范的实现：

<dependency>
        <groupId>org.glassfish</groupId>
        <artifactId>javax.el</artifactId>
        <version>3.0.0</version>
    </dependency>

# 4.使用校验注解 #

在这里，使用一个 User bean 并为它添加一些简单的验证：

import javax.validation.constraints.AssertTrue;
    import javax.validation.constraints.Max;
    import javax.validation.constraints.Min;
    import javax.validation.constraints.NotNull;
    import javax.validation.constraints.Size;
    import javax.validation.constraints.Email;
    
    @Data
    public class UserDto { 
        @NotNull(message = "姓名不能为空")
        private String name;
    
        @AssertTrue
        private boolean working;
    
        @Size(min = 10, max = 200, message
                = "关于我在10到200字符")
        private String aboutMe;
    
        @Min(value = 18, message = "年龄最小18岁")
        @Max(value = 150, message = "年龄最大150岁")
        private int age;
    
        @Email(message = "邮箱无效")
        private String email;
    }

示例中使用的所有注释都是标准的 JSR 注释：

*  @NotNull 验证带注解的属性值不为空。
 *  @AssertTrue 验证带注解的属性值是否为真。
 *  @Size 验证带注解的属性值的大小在属性 min 和 max 之间； 可以应用于字符串、集合、映射和数组属性。
 *  @Min 验证带注解的属性的值不小于 value 属性。
 *  @Max 验证带注解的属性的值不大于 value 属性。
 *  @Email 验证带注解的属性是有效的电子邮件地址。

一些注解接受额外的属性，但message属性对所有注解都是通用的。 这是当相应属性的值未通过验证时通常会呈现的消息。

可以在 JSR 中找到的附加注解：

*  @NotEmpty 验证属性不为 null 或为空； 可以应用于字符串、集合、映射或数组值。
 *  @NotBlank 只能应用于文本值并验证该属性不为空或空格。
 *  @Positive 和 @PositiveOrZero 适用于数值并验证它们是严格的正数或正数，包括 0。
 *  @Negative 和 @NegativeOrZero 适用于数值并验证它们是严格负数或负数，包括 0。
 *  @Past 和 @PastOrPresent 验证日期值是过去还是过去，包括现在； 可以应用于日期类型，包括在 Java 8 中添加的日期类型。
 *  @Future 和 @FutureOrPresent 验证日期值是在未来，还是在未来，包括现在。

验证注解也可以应用于集合的元素：

List<@NotBlank String> preferences;

此外，该规范支持 Java 8 中的新 Optional 类型：

private LocalDate dateOfBirth;
    
    public Optional<@Past LocalDate> getDateOfBirth() { 
        return Optional.of(dateOfBirth);
    }

校验框架将自动解包 LocalDate 值并对其进行验证。

# 5.程序化校验 #

某些框架（例如 Spring）具有通过使用注解来触发校验的简单方法。 这主要是为了让编程与校验 API 不进行交互。

现在以编程方式进行设置：

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
    Validator validator = factory.getValidator();

要验证 bean，首先需要一个 Validator 对象，该对象是使用 ValidatorFactory 构建的。

## 5.1. 定义 Bean ##

User user = new User();
    user.setWorking(true);
    user.setAboutMe("来自北京的张三");
    user.setAge(50);

## 5.2.校验bean ##

现在有了一个 Validator，可以通过将它传递给 validate 方法来验证 bean的正确性。

任何违反 User 对象中定义的约束都将作为 Set 返回：

UserDto user = new UserDto();
            user.setWorking(true);
            user.setAboutMe("来自北京的张三");
            user.setAge(50);
            ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
            Validator validator = factory.getValidator();
            Set<ConstraintViolation<UserDto>> violations = validator.validate(user);
            for (ConstraintViolation<UserDto> violation : violations) { 
                System.out.println(violation);
    
            }

> ConstraintViolationImpl\{interpolatedMessage=‘姓名不能为空’, propertyPath=name, rootBeanClass=class com.niugang.javabase.pojo.UserDto, messageTemplate=‘姓名不能为空’\}  
> ConstraintViolationImpl\{interpolatedMessage=‘关于我在10到200字符’, propertyPath=aboutMe, rootBeanClass=class com.niugang.javabase.pojo.UserDto, messageTemplate=‘关于我在10到200字符’\}

# 6.总结 #

本文重点介绍标准 Java 验证 API 的简单传递。 展示了使用 javax.validation 注释和 API 进行 bean 验证的基础知识。