Java Bean 校验 API

简介: > 本文翻译自[Java Bean Validation Basics](https://www.baeldung.com/javax-validation) ## 概述 在这个文章里,我们简单介绍一如何使用标准校验框架来完成基本的Java Bean校验,该框架即JSR380,也被称为Bean Validation 2.0。 校验用户输入,在大多是应用程序中是超级常见的需求,Ja

本文翻译自Java Bean Validation Basics

概述

在这个文章里,我们简单介绍一如何使用标准校验框架来完成基本的Java Bean校验,该框架即JSR380,也被称为Bean Validation 2.0。

校验用户输入,在大多是应用程序中是超级常见的需求,Java Bean校验框架即是处理这部分逻辑的标准工具。

JSR308-Bean Validation 2.0

JSR 308是JavaBean校验API规范,它是JavaEE和JavaSE的一部分。该规范使用@NotNull,@Min和@Max这样的注解来确保一个Bean的属性符合特定的条件。

这个版本要求使用Java8或更高版本,利用Java8提供的新特性例如类型注解,并且支持新的类型例如Optional和LocalDate。

要获得更完整的信息,可以进一步阅读JSR 308的文档

依赖

  1. JSR 308规范的的标准API包含在validation-api中:

    <dependency>
        <groupId>javax.validation</groupId>
        <artifactId>validation-api</artifactId>
        <version>2.0.1.Final</version>
    </dependency>
  2. Hibernate Validator是validation-api的参考实现:

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

另外,Hibernate Validator还提供了一个注解处理器,利用Java编译时注解处理机制,帮助开发人员发现校验注解使用的错误。仅需要添加如下依赖即可:

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator-annotation-processor</artifactId>
    <version>6.0.2.Final</version>
    <scop>provided</scop>
</dependency>

hibernate-validator与hibernate的持久化框架支持是完全分离的,引入hibnernate-validator依赖并不会间接引入hibernate持久化相关的依赖。

  1. 表达式语言依赖

JSR 308规范支持违约信息的变量解析,并允许使用表达式。

为了解析表达式,我们必须添加表达式语言API和它的某个实现,GlassFish项目提供了表达式语言API的参考实现:

<dependency>
    <groupId>javax.el</groupId>
    <artifactId>javax.el-api</artifactId>
    <version>3.0.0</version>
</dependency>
 
<dependency>
    <groupId>org.glassfish.web</groupId>
    <artifactId>javax.el</artifactId>
    <version>2.2.6</version>
</dependency>

如果没有添加这些依赖到应用中,您会在运行时得到如下错误信息:

HV000183: Unable to load ‘javax.el.ExpressionFactory'. Check that you have the EL dependencies on the classpath, or use ParameterMessageInterpolator instead

使用校验注解

我们在这里使用UserBean作为例子,为它添加一些简单的校验。

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;

public class User {
 
    @NotNull(message = "Name cannot be null")
    private String name;
 
    @AssertTrue
    private boolean working;
 
    @Size(min = 10, max = 200, message 
      = "About Me must be between 10 and 200 characters")
    private String aboutMe;
 
    @Min(value = 18, message = "Age should not be less than 18")
    @Max(value = 150, message = "Age should not be greater than 150")
    private int age;
 
    @Email(message = "Email should be valid")
    private String email;
 
    // standard setters and getters 
}

该例子中使用的所有注解都是标准JSR注解:

  • @NotNull-校验被注解的属性不能为null
  • @AssertTrue-校验被注解的属性值必须为true
  • @Size-校验被注解的属性的尺寸必须在min和max之间,该注解可以在String,Collection,Map和数组属性上使用
  • @Min,@Max-校验备注解的属性值必须大于或小于指定的值
  • @Email-校验备注接的属性必须是有效的emal地址

JSR中还包含其他一些注解:

  • @NotEmpty-校验属性不能为null或空;可以在String,Collection,Map或数组类型属性上使用
  • @NotBlank-只能使用在文本类型的属性上,校验该属性不能为null或空白
  • @Positive,@PositiveOrZero-使用在数值属性上,校验该属性必须为正数或0
  • @Negative,@NegativeOrZero-使用在数值属性上,校验该属性必须为负数或0
  • @Past,@PastOrPresent-校验日期类型值必须是过去的时间或现在;支持Java8中新增加的日期类型,例如LocalDateTime
  • @Future,@FutureOrPresent-校验日期类型值必须在未来或现在

所有注解都可以设置messge属性,这个属性的值在校验失败时被用来渲染违约消息。

Validation-API提供的标准注解的message属性大都有默认值,使用者如无特别需求,无须设置该属性。

校验注解可以施加在集合的元素上

List<@NotBlank String> preferences;

在这个例子中,集合中的的所有元素都会被校验不能为null或空白

规范也支持Java8中新增的Optional类型:

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

这个例子中,校验框架会自动将LocalDate值取出并校验。

编程校验

  1. 一些框架,例如Spring,仅仅使用注解即可出发校验过程。让我们不必直接编程使用校验API。但我们应当对其有所了解,以理解框架的运作原理。

下面让我们来手动编程配置一个校验环境:

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

我们必须首先构建一个校验器(validator)对象,才能校验一个Bean。

  1. 定义一个待校验的Bean

    User user = new User();
    user.setWorking(true);
    user.setAboutMe("Its all about me!");
    user.setAge(50);
  2. 对上面定义的Bean进行校验

    Set<ConstraintViolation<User>> violations = validator.validate(user);

将user对象作为validate方法的参数传递给校验器对象,所有违背User对象定义的约束条件的信息包装为ConstraintViolation对象集合返回。

遍历违约信息,我们可以得到所有的违约消息

for (ConstraintViolation<User> violation : violations) {
    log.error(violation.getMessage()); 
}

在我们的例子中,违约对象集合中只会包含一个违约信息,“Name cannot be null”。

这个违约消息可以通过校验注解的message属性进行定义。

总结

本教程聚焦于标准Java校验API的基本内容,展示了使用基本javax.validation注解和API的使用方法。

所有的示例代码可以在GitHub上获取。

目录
相关文章
|
2月前
|
Java API Maven
如何使用Java开发抖音API接口?
在数字化时代,社交媒体平台如抖音成为生活的重要部分。本文详细介绍了如何用Java开发抖音API接口,从创建开发者账号、申请API权限、准备开发环境,到编写代码、测试运行及注意事项,全面覆盖了整个开发流程。
317 10
|
2月前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
104 2
|
6天前
|
JSON Java 数据挖掘
利用 Java 代码获取淘宝关键字 API 接口
在数字化商业时代,精准把握市场动态与消费者需求是企业成功的关键。淘宝作为中国最大的电商平台之一,其海量数据中蕴含丰富的商业洞察。本文介绍如何通过Java代码高效、合规地获取淘宝关键字API接口数据,帮助商家优化产品布局、制定营销策略。主要内容包括: 1. **淘宝关键字API的价值**:洞察用户需求、优化产品标题与详情、制定营销策略。 2. **获取API接口的步骤**:注册账号、申请权限、搭建Java开发环境、编写调用代码、解析响应数据。 3. **注意事项**:遵守法律法规与平台规则,处理API调用限制。 通过这些步骤,商家可以在激烈的市场竞争中脱颖而出。
|
23天前
|
JSON Java Apache
Java基础-常用API-Object类
继承是面向对象编程的重要特性,允许从已有类派生新类。Java采用单继承机制,默认所有类继承自Object类。Object类提供了多个常用方法,如`clone()`用于复制对象,`equals()`判断对象是否相等,`hashCode()`计算哈希码,`toString()`返回对象的字符串表示,`wait()`、`notify()`和`notifyAll()`用于线程同步,`finalize()`在对象被垃圾回收时调用。掌握这些方法有助于更好地理解和使用Java中的对象行为。
|
1月前
|
算法 Java API
如何使用Java开发获得淘宝商品描述API接口?
本文详细介绍如何使用Java开发调用淘宝商品描述API接口,涵盖从注册淘宝开放平台账号、阅读平台规则、创建应用并申请接口权限,到安装开发工具、配置开发环境、获取访问令牌,以及具体的Java代码实现和注意事项。通过遵循这些步骤,开发者可以高效地获取商品详情、描述及图片等信息,为项目和业务增添价值。
82 10
|
1月前
|
存储 Java 数据挖掘
Java 8 新特性之 Stream API:函数式编程风格的数据处理范式
Java 8 引入的 Stream API 提供了一种新的数据处理方式,支持函数式编程风格,能够高效、简洁地处理集合数据,实现过滤、映射、聚合等操作。
76 6
|
1月前
|
Java API 开发者
Java中的Lambda表达式与Stream API的协同作用
在本文中,我们将探讨Java 8引入的Lambda表达式和Stream API如何改变我们处理集合和数组的方式。Lambda表达式提供了一种简洁的方法来表达代码块,而Stream API则允许我们对数据流进行高级操作,如过滤、映射和归约。通过结合使用这两种技术,我们可以以声明式的方式编写更简洁、更易于理解和维护的代码。本文将介绍Lambda表达式和Stream API的基本概念,并通过示例展示它们在实际项目中的应用。
|
2月前
|
安全 Java API
告别SimpleDateFormat:Java 8日期时间API的最佳实践
在Java开发中,处理日期和时间是一个基本而重要的任务。传统的`SimpleDateFormat`类因其简单易用而被广泛采用,但它存在一些潜在的问题,尤其是在多线程环境下。本文将探讨`SimpleDateFormat`的局限性,并介绍Java 8引入的新的日期时间API,以及如何使用这些新工具来避免潜在的风险。
44 5
|
2月前
|
开发框架 Java 关系型数据库
Java哪个框架适合开发API接口?
在快速发展的软件开发领域,API接口连接了不同的系统和服务。Java作为成熟的编程语言,其生态系统中出现了许多API开发框架。Magic-API因其独特优势和强大功能,成为Java开发者优选的API开发框架。本文将从核心优势、实际应用价值及未来展望等方面,深入探讨Magic-API为何值得选择。
83 2
|
2月前
|
缓存 监控 Java
如何运用JAVA开发API接口?
本文详细介绍了如何使用Java开发API接口,涵盖创建、实现、测试和部署接口的关键步骤。同时,讨论了接口的安全性设计和设计原则,帮助开发者构建高效、安全、易于维护的API接口。
239 4