Java中jakarta.validation数据校验几个主要依赖包讲解

 更新时间:2024年09月25日 09:03:27   作者:小信丶  
在Java开发中,BeanValidationAPI提供了一套标准的数据验证机制,尤其是通过JakartaBeanValidation(原HibernateValidator)实现,文中通过代码介绍的非常详细,需要的朋友可以参考下

概述

在Java中,数据校验通常依赖于Bean Validation API,特别是Jakarta Bean Validation(以前的Hibernate Validator)。这个API允许你在Java对象上定义和执行约束规则,以确保数据的有效性和一致性。以下是有关jakarta.validation及其相关依赖包的详细讲解:

1. 依赖包

对于使用Bean Validation API的项目,通常需要添加相关的依赖包。以Maven为例,通常会包括以下几个主要依赖:

Jakarta Bean Validation API

这是Bean Validation的API规范定义包,定义了数据校验的基本接口和注解。

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>3.0.2</version> <!-- 版本可能会变化 -->
</dependency>

Hibernate Validator

这是Bean Validation的一个实现,提供了API的具体实现。

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>8.0.1.Final</version> <!-- 版本可能会变化 -->
</dependency>

EL (Expression Language) 实现

Hibernate Validator 可能需要EL实现来处理一些注解的表达式。

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.0</version> <!-- 版本可能会变化 -->
</dependency>

2. 主要注解及其功能

以下是 jakarta.validation 包中一些核心注解的详细讲解:

@NotNull

  • 功能: 确保值不为null
  • 用法:
@NotNull
private String name;

@Size

  • 功能: 验证字符串、集合或数组的长度。
  • 属性:
    • min: 最小长度
    • max: 最大长度
  • 用法:
@Size(min = 2, max = 30)
private String username;

@Min 和 @Max

  • 功能: 用于设置数值的最小值和最大值。
  • 属性:
    • value: 最小值(@Min)或最大值(@Max
  • 用法:
@Min(18)
private int age;

@Max(120)
private int age;

@Email

  • 功能: 验证字符串是否符合电子邮件格式。
  • 用法:
@Email
private String email;

@Pattern

  • 功能: 验证字符串是否符合正则表达式模式。
  • 属性:
    • regexp: 正则表达式
  • 用法:
@Pattern(regexp = "\\d{10}")
private String phoneNumber;

@Positive 和 @Negative

  • 功能: 验证数值是否为正数或负数。
  • 用法:
@Positive
private int positiveNumber;

@Negative
private int negativeNumber;

@Past 和 @Future

  • 功能@Past 验证日期是否在当前日期之前,@Future 验证日期是否在当前日期之后。
  • 用法:
@Past
private LocalDate birthDate;

@Future
private LocalDate expiryDate;

3. 如何使用

配置和使用Validator

使用Bean Validation API通常涉及以下步骤:

1、创建和配置 ValidatorFactory:

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

2、验证对象:

User user = new User();
user.setUsername("A");
user.setAge(17);

Set<ConstraintViolation<User>> violations = validator.validate(user);
for (ConstraintViolation<User> violation : violations) {
    System.out.println(violation.getMessage());
}

3、使用Spring Boot集成:

在Spring Boot应用中,jakarta.validation 与 spring-boot-starter-validation 自动集成。Spring Boot会自动处理带有注解的Java Bean的验证。

示例:

Java Bean:

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public class User {
    @NotNull(message = "Username cannot be null")
    @Size(min = 2, max = 30, message = "Username must be between 2 and 30 characters")
    private String username;

    @NotNull(message = "Age cannot be null")
    @Min(value = 18, message = "Age must be at least 18")
    private Integer age;

    @Email(message = "Email should be valid")
    private String email;

    // Getters and Setters
}

Controller:

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import jakarta.validation.Valid;
import org.springframework.http.ResponseEntity;

@RestController
public class UserController {
    @PostMapping("/users")
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        // 处理有效的user
        return ResponseEntity.ok("User is valid!");
    }
}
  • 在这个示例中,Spring Boot会自动验证请求体中的User对象,并返回相应的验证错误信息(如果有的话)。

4. 定制验证逻辑

你也可以自定义验证逻辑,通过实现 ConstraintValidator 接口来创建自定义注解。

示例:

自定义注解:

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Constraint(validatedBy = CustomValidator.class)
@Target({ ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomConstraint {
    String message() default "Custom validation failed";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

自定义验证器:

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

public class CustomValidator implements ConstraintValidator<CustomConstraint, String> {
    @Override
    public void initialize(CustomConstraint constraintAnnotation) {}

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 自定义验证逻辑
        return value != null && value.length() > 5;
    }
}

应用自定义注解:

public class Example {
    @CustomConstraint
    private String customField;
}

总结

jakarta.validation 包及其实现如 Hibernate Validator 提供了一个强大的数据验证框架,能够有效地在Java应用中确保数据的有效性。通过注解、接口和自定义验证逻辑,你可以灵活地实现数据校验,并与Spring Boot等框架集成,以提高应用程序的健壮性和用户体验。

到此这篇关于Java中jakarta.validation数据校验几个主要依赖包讲解的文章就介绍到这了,更多相关Java jakarta.validation数据校验依赖包内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现Fast DFS、服务器、OSS上传功能

    Java实现Fast DFS、服务器、OSS上传功能

    这篇文章主要介绍了Java实现Fast DFS、服务器、OSS上传功能,在实际的业务中,可以根据客户的需求设置不同的文件上传需求,支持普通服务器上传+分布式上传(Fast DFS)+云服务上传OSS(OSS),需要的朋友可以参考下
    2024-04-04
  • SpringBoot中基于JWT的单token授权和续期方案步骤详解

    SpringBoot中基于JWT的单token授权和续期方案步骤详解

    在前后端分离架构中,用户登录后,后端生成JWT Token返给前端存于LocalStorage,每次请求携带Token验证身份,后端校验其有效性,本文给大家介绍SpringBoot中基于JWT的单token授权和续期方案步骤详解,感兴趣的朋友一起看看吧
    2024-09-09
  • 详解Java的日期时间新特性

    详解Java的日期时间新特性

    随着时间的不断推移,现实的需求也在不断更新,原先的一些API已经难以满足开发需求了,从JDK 8之后,为了满足更多的开发需求,Java给我们增加了不少关于日期时间的新特性,接下来就带各位来看看这些新特性有哪些,需要的朋友可以参考下
    2023-06-06
  • Java设计模式之抽象工厂模式简析

    Java设计模式之抽象工厂模式简析

    这篇文章主要介绍了Java设计模式之抽象工厂模式简析, 抽象工厂模式是工厂方法模式的升级版本,他用来创建一组相关或者相互依赖的对象,他与工厂方法模式的区别就在于,工厂方法模式针对的是一个产品等级结构,需要的朋友可以参考下
    2023-12-12
  • Java BigDecimal类用法详解

    Java BigDecimal类用法详解

    BigDecimal 由任意精度的整数非标度值 和32 位的整数标度 (scale) 组成。如果为零或正数,则标度是小数点后的位数。如果为负数,则将该数的非标度值乘以 10 的负scale 次幂。
    2016-06-06
  • 浅谈一下RabbitMQ、Kafka和RocketMQ消息中间件对比

    浅谈一下RabbitMQ、Kafka和RocketMQ消息中间件对比

    这篇文章主要介绍了浅谈一下RabbitMQ、Kafka和RocketMQ消息中间件对比,消息中间件属于分布式系统中一个字系统,关注于数据的发送和接收,利用高效可靠的异步信息传递机制对分布式系统中的其余各个子系统进行集成,需要的朋友可以参考下
    2023-05-05
  • SpringBoot 创建容器的实现

    SpringBoot 创建容器的实现

    这篇文章主要介绍了SpringBoot 创建容器的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • JPA使用乐观锁应对高并发方式

    JPA使用乐观锁应对高并发方式

    这篇文章主要介绍了JPA使用乐观锁应对高并发方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • 浅析非对称加密在接口参数中的实现

    浅析非对称加密在接口参数中的实现

    接口层做数据加密应该算是老生常谈的一件事了,业界用的比较多的,不外乎是对称加密,非对称加密以及两者的结合。本文就来聊聊非对称加密在接口参数中的实现,希望对大家有所帮助
    2023-02-02
  • springboot数据访问和数据视图的使用方式详解

    springboot数据访问和数据视图的使用方式详解

    这篇文章主要为大家介绍了springboot数据访问和数据视图的使用方式详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06

最新评论