Java中@Constraint实现自定义校验注解

 更新时间:2025年05月22日 10:14:55   作者:月轩居士  
本文主要介绍了Java中@Constraint实现自定义校验注解,需配合ConstraintValidator实现校验逻辑,适用于HibernateValidator等框架,感兴趣的可以了解一下

@Constraint 是 Java 中用于定义自定义校验注解的一个元注解。它通常与 Hibernate Validator 或其他基于 JSR 380(Bean Validation 2.0)的校验框架一起使用。通过 @Constraint 注解,你可以创建自己的校验逻辑,并将其应用到实体类的字段上

1. 创建自定义校验注解

首先,定义一个自定义校验注解。假设我们想创建一个注解 @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. 创建校验器

接下来,创建一个实现 ConstraintValidator 接口的类,用于实现具体的校验逻辑。

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("校验失败");
        }
    }
}

输出
运行上述代码后,如果 username 的长度在1到20个字符之间,输出将是:
校验通过
如果 username 的长度超过20个字符或小于1个字符,输出将是:
长度必须在1到20个字符之间
校验失败

总结

  • 自定义校验注解:使用 @Constraint 注解定义自定义校验注解。
  • 校验器:实现 ConstraintValidator 接口,编写具体的校验逻辑。
  • 应用注解:在实体类的字段上使用自定义校验注解。
  • 测试校验:使用 Validator 对象进行校验,并处理校验结果。

到此这篇关于Java中@Constraint实现自定义校验注解的文章就介绍到这了,更多相关Java 自定义校验注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot实现添加邮件发送及压缩功能

    springboot实现添加邮件发送及压缩功能

    这篇文章主要介绍了springboot实现添加邮件发送及压缩功能 ,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07
  • Java进程cpu占用过高问题解决

    Java进程cpu占用过高问题解决

    这篇文章主要介绍了Java进程cpu占用过高问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • 关于Java中避免空指针的方法

    关于Java中避免空指针的方法

    这篇文章主要介绍了关于Java中避免空指针的方法,空指针异常就是我们在对空对象进行的任何操作都会报空指针异常,所谓的指针,就是java中的对象的引用,比如String s;这个就是指针,需要的朋友可以参考下
    2023-07-07
  • SpringBoot3通过GraalVM生成exe执行文件问题

    SpringBoot3通过GraalVM生成exe执行文件问题

    文章介绍了如何安装GraalVM和Visual Studio,并通过Spring Boot项目将Java应用程序封装成可执行文件(.exe)
    2024-12-12
  • Mybatis多线程下如何使用Example详解

    Mybatis多线程下如何使用Example详解

    这篇文章主要给大家介绍了关于Mybatis多线程下如何使用Example的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Mybatis具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-12-12
  • Spring手写简化版MVC流程详解

    Spring手写简化版MVC流程详解

    Spring MVC是Spring Framework的一部分,是基于Java实现MVC的轻量级Web框架。本文将通过简单示例带大家掌握SpringMVC简化版手写方法,感兴趣的可以了解一下
    2022-11-11
  • Java依赖包漏洞检测命令详解

    Java依赖包漏洞检测命令详解

    这篇文章主要介绍了Java依赖包漏洞检测命令,你可以在修复漏洞后快速进行依赖项的安全检查,并生成新的报告,而不需要等待 CVE 数据库的下载和更新,这样可以显著提高扫描的效率,需要的朋友可以参考下
    2024-11-11
  • Spring 依赖注入的几种方式详解

    Spring 依赖注入的几种方式详解

    本篇文章主要介绍了Spring 依赖注入的几种方式详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • 详解Spring Boot中整合Sharding-JDBC读写分离示例

    详解Spring Boot中整合Sharding-JDBC读写分离示例

    这篇文章主要介绍了详解Spring Boot中整合Sharding-JDBC读写分离示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • 关于SpringBoot静态资源路径管理问题

    关于SpringBoot静态资源路径管理问题

    这篇文章主要介绍了SpringBoot静态资源路径管理,主要包括默认静态资源路径,增加静态资源路径前缀的相关操作,本文给大家介绍的非常详细,需要的朋友可以参考下
    2022-05-05

最新评论