Jakarta Validation API 技术文档

Jakarta Validation API 技术文档

validation Jakarta Validation 项目地址: https://gitcode.com/gh_mirrors/validation2/validation

1. 安装指南

系统要求

• JDK 8
• Maven 3 (>= 3.0.3)

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/jakartaee/validation
   

2. 构建项目： 进入项目目录并执行以下命令：

   mvn clean install
   

3. 验证安装： 构建成功后，您可以在本地 Maven 仓库中找到生成的 JAR 文件。

2. 项目使用说明

概述

Jakarta Validation API 定义了一个元数据模型和用于 JavaBean 和方法验证的 API。它允许您通过注解定义约束，并提供 API 来验证对象和对象图。

示例代码

以下是一个简单的示例，展示了如何使用 Jakarta Validation API 进行 JavaBean 验证：

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

public class User {
    private String email;

    @NotNull
    @Email
    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

验证方法

您可以使用 Validator API 手动触发验证：

import jakarta.validation.Validation;
import jakarta.validation.Validator;
import jakarta.validation.ValidatorFactory;

public class Main {
    public static void main(String[] args) {
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();

        User user = new User();
        user.setEmail("invalid-email");

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

3. 项目 API 使用文档

Validator API

Validator 接口是 Jakarta Validation API 的核心接口，用于执行验证操作。

主要方法

• validate(T object, Class<?>... groups): 验证给定的对象。
• validateProperty(T object, String propertyName, Class<?>... groups): 验证对象的特定属性。
• validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups): 验证特定属性的值。

ConstraintViolation API

ConstraintViolation 接口表示验证过程中发现的约束违规。

主要方法

• getMessage(): 获取违规消息。
• getRootBean(): 获取验证的根对象。
• getPropertyPath(): 获取违规属性的路径。

4. 项目安装方式

Maven 依赖

在您的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>3.0.0</version>
</dependency>

Gradle 依赖

在您的 build.gradle 文件中添加以下依赖：

implementation 'jakarta.validation:jakarta.validation-api:3.0.0'

手动下载

您也可以从 Maven 中央仓库 手动下载 JAR 文件，并将其添加到您的项目中。

---

通过以上步骤，您可以成功安装并使用 Jakarta Validation API 进行 JavaBean 和方法的验证。如果您有任何问题或需要进一步的帮助，请参考项目的 官方网站 或 GitHub 仓库。

validation Jakarta Validation 项目地址: https://gitcode.com/gh_mirrors/validation2/validation