Jakarta Validation API 技术文档

1. 安装指南

系统要求

• JDK 8

安装步骤

1. 下载源码
   从GitHub仓库克隆Jakarta Validation API的源码：

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

2. 构建项目
   确保你已经安装了JDK 8和Maven 3（>= 3.0.3）。进入项目目录并执行以下命令进行构建：

   mvn clean install
   

3. 验证安装
   构建成功后，你可以在本地Maven仓库中找到生成的JAR文件，路径通常为：

   ~/.m2/repository/jakarta/validation/jakarta.validation-api/3.0.0/
   

2. 项目的使用说明

概述

Jakarta Validation API定义了一个元数据模型和API，用于JavaBean和方法的验证。它允许开发者通过注解或其他方式定义验证规则，并在运行时自动执行这些验证。

基本使用

1. 引入依赖
   在你的项目中引入Jakarta Validation API的依赖：

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

2. 定义验证规则
   使用注解定义JavaBean的验证规则：

   import jakarta.validation.constraints.NotNull;
   import jakarta.validation.constraints.Size;
   
   public class User {
       @NotNull
       @Size(min = 2, max = 30)
       private String name;
   
       // Getters and setters
   }
   

3. 执行验证
   使用Validator接口执行验证：

   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.setName(null);
   
           Set<ConstraintViolation<User>> violations = validator.validate(user);
           for (ConstraintViolation<User> violation : violations) {
               System.out.println(violation.getMessage());
           }
       }
   }
   

3. 项目API使用文档

核心API

• Validator：用于执行验证的核心接口。
• ConstraintViolation：表示验证失败时的错误信息。
• ValidatorFactory：用于创建Validator实例的工厂类。

常用注解

• @NotNull：确保字段不为空。
• @Size：限制字段的长度。
• @Min 和 @Max：限制数值字段的最小值和最大值。
• @Pattern：使用正则表达式验证字段。

自定义验证

你可以通过实现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;

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

public class CustomValidator implements ConstraintValidator<CustomConstraint, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && value.startsWith("custom");
    }
}

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或Gradle，可以直接下载JAR文件并将其添加到项目的类路径中。JAR文件可以在构建成功后在本地Maven仓库中找到。

通过以上步骤，你可以成功安装并使用Jakarta Validation API进行JavaBean和方法的验证。