快捷導航

Java中@Constraint實現(xiàn)自定義校驗注解

更新時間：2025年05月22日 10:14:55 作者：月軒居士

本文主要介紹了Java中@Constraint實現(xiàn)自定義校驗注解,需配合ConstraintValidator實現(xiàn)校驗邏輯,適用于HibernateValidator等框架,感興趣的可以了解一下

@Constraint 是 Java 中用于定義自定義校驗注解的一個元注解。它通常與 Hibernate Validator 或其他基于 JSR 380（Bean Validation 2.0）的校驗框架一起使用。通過 @Constraint 注解，你可以創(chuàng)建自己的校驗邏輯，并將其應用到實體類的字段上

1. 創(chuàng)建自定義校驗注解

首先，定義一個自定義校驗注解。假設(shè)我們想創(chuàng)建一個注解 @ValidLength，用于校驗字符串的最大長度為20位。

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

@Constraint(validatedBy = ValidLengthValidator.class)
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidLength {
    String message() default "長度必須在1到20個字符之間";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    int min() default 1;
    int max() default 20;
}

2. 創(chuàng)建校驗器

接下來，創(chuàng)建一個實現(xiàn) ConstraintValidator 接口的類，用于實現(xiàn)具體的校驗邏輯。

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class ValidLengthValidator implements ConstraintValidator<ValidLength, String> {

    private int min;
    private int max;

    @Override
    public void initialize(ValidLength constraintAnnotation) {
        this.min = constraintAnnotation.min();
        this.max = constraintAnnotation.max();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 允許為空
        }
        return value.length() >= min && value.length() <= max;
    }
}

3. 應用自定義校驗注解

在實體類中使用自定義校驗注解。

import javax.validation.constraints.NotNull;

public class User {

    @NotNull
    @ValidLength(min = 1, max = 20)
    private String username;

    // Getters and Setters
    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }
}

4. 測試校驗

編寫一個測試類來驗證校驗邏輯是否按預期工作。

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import javax.validation.ConstraintViolation;
import java.util.Set;

public class Main {
    public static void main(String[] args) {
        User user = new User();
        user.setUsername("12345678901234567890"); // 20位，合法

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

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

        if (violations.isEmpty()) {
            System.out.println("校驗通過");
        } else {
            System.out.println("校驗失敗");
        }
    }
}