快捷導(dǎo)航

Java中jakarta.validation數(shù)據(jù)校驗幾個主要依賴包講解

更新時間：2024年09月25日 09:03:27 作者：小信丶

在Java開發(fā)中,BeanValidationAPI提供了一套標(biāo)準(zhǔn)的數(shù)據(jù)驗證機(jī)制,尤其是通過JakartaBeanValidation（原HibernateValidator）實現(xiàn),文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

概述

在Java中，數(shù)據(jù)校驗通常依賴于Bean Validation API，特別是Jakarta Bean Validation（以前的Hibernate Validator）。這個API允許你在Java對象上定義和執(zhí)行約束規(guī)則，以確保數(shù)據(jù)的有效性和一致性。以下是有關(guān)jakarta.validation及其相關(guān)依賴包的詳細(xì)講解：

1. 依賴包

對于使用Bean Validation API的項目，通常需要添加相關(guān)的依賴包。以Maven為例，通常會包括以下幾個主要依賴：

Jakarta Bean Validation API

這是Bean Validation的API規(guī)范定義包，定義了數(shù)據(jù)校驗的基本接口和注解。

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

Hibernate Validator

這是Bean Validation的一個實現(xiàn)，提供了API的具體實現(xiàn)。

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

EL (Expression Language) 實現(xiàn)

Hibernate Validator 可能需要EL實現(xiàn)來處理一些注解的表達(dá)式。

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

2. 主要注解及其功能

以下是 jakarta.validation 包中一些核心注解的詳細(xì)講解：

@NotNull

功能: 確保值不為null。
用法:

@NotNull
private String name;

@Size

功能: 驗證字符串、集合或數(shù)組的長度。
屬性:
- min: 最小長度
- max: 最大長度
用法:

@Size(min = 2, max = 30)
private String username;

@Min 和 @Max

功能: 用于設(shè)置數(shù)值的最小值和最大值。
屬性:
- value: 最小值（@Min）或最大值（@Max）
用法:

@Min(18)
private int age;

@Max(120)
private int age;

@Email

功能: 驗證字符串是否符合電子郵件格式。
用法:

@Email
private String email;

@Pattern

功能: 驗證字符串是否符合正則表達(dá)式模式。
屬性:
- regexp: 正則表達(dá)式
用法:

@Pattern(regexp = "\\d{10}")
private String phoneNumber;

@Positive 和 @Negative

功能: 驗證數(shù)值是否為正數(shù)或負(fù)數(shù)。
用法:

@Positive
private int positiveNumber;

@Negative
private int negativeNumber;

@Past 和 @Future

功能: @Past 驗證日期是否在當(dāng)前日期之前，@Future 驗證日期是否在當(dāng)前日期之后。
用法:

@Past
private LocalDate birthDate;

@Future
private LocalDate expiryDate;

3. 如何使用

配置和使用Validator

使用Bean Validation API通常涉及以下步驟：

1、創(chuàng)建和配置 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應(yīng)用中，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對象，并返回相應(yīng)的驗證錯誤信息（如果有的話）。

4. 定制驗證邏輯

你也可以自定義驗證邏輯，通過實現(xiàn) ConstraintValidator 接口來創(chuàng)建自定義注解。

示例:

自定義注解:

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;
    }
}

應(yīng)用自定義注解:

public class Example {
    @CustomConstraint
    private String customField;
}

總結(jié)

jakarta.validation 包及其實現(xiàn)如 Hibernate Validator 提供了一個強(qiáng)大的數(shù)據(jù)驗證框架，能夠有效地在Java應(yīng)用中確保數(shù)據(jù)的有效性。通過注解、接口和自定義驗證邏輯，你可以靈活地實現(xiàn)數(shù)據(jù)校驗，并與Spring Boot等框架集成，以提高應(yīng)用程序的健壯性和用戶體驗。

到此這篇關(guān)于Java中jakarta.validation數(shù)據(jù)校驗幾個主要依賴包講解的文章就介紹到這了,更多相關(guān)Java jakarta.validation數(shù)據(jù)校驗依賴包內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: