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 自定义校验注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java中的包、抽象类、接口详解(最新整理)

    Java中的包、抽象类、接口详解(最新整理)

    文章介绍了Java中的包、抽象类、接口以及实现多个接口的概念,包用于组织类,避免命名冲突,抽象类用于定义不能被实例化的类,可以包含抽象方法,接口则定义了一组抽象方法,可以被类实现,实现多个接口可以实现类似多继承的效果,感兴趣的朋友一起看看吧
    2025-02-02
  • restTemplate发送get与post请求并且带参数问题

    restTemplate发送get与post请求并且带参数问题

    这篇文章主要介绍了restTemplate发送get与post请求并且带参数问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • 客户端设置超时时间真的很重要

    客户端设置超时时间真的很重要

    今天小编就为大家分享一篇关于客户端设置超时时间真的很重要,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Java 方法递归的思路详解

    Java 方法递归的思路详解

    程序调用自身的编程技巧称为递归( recursion)。递归做为一种算法在程序设计语言中广泛应用。但是如果没终止条件会造成死循环,所以递归代码里要有结束自调自的条件,接下来讲解一下学习递归的思路
    2022-04-04
  • Spring security权限配置与使用大全

    Spring security权限配置与使用大全

    Spring Security 本质上是借助一系列的 Servlet Filter来提供各种安全性功能,但这并不需要我们手动去添加或者创建多个Filter,本文重点给大家介绍spring-security的配置与使用及实现方式,感兴趣的朋友一起看看吧
    2021-09-09
  • java模仿实现QQ登录界面

    java模仿实现QQ登录界面

    这篇文章主要为大家详细介绍了java模仿实现qq登录界面,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05
  • Java日常练习题,每天进步一点点(29)

    Java日常练习题,每天进步一点点(29)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07
  • Java行为型模式中命令模式分析

    Java行为型模式中命令模式分析

    在软件设计中,我们经常需要向某些对象发送请求,但是并不知道请求的接收者是谁,也不知道被请求的操作是哪个,我们只需在程序运行时指定具体的请求接收者即可,此时可以使用命令模式来进行设计
    2023-02-02
  • SpringBoot详细分析自动装配原理并实现starter

    SpringBoot详细分析自动装配原理并实现starter

    相对于传统意义上的Spring项目,SpringBoot具有开箱即用,简化配置,内置Tomcat等等等等一系列的特点。在这些特点中,最重要的两条就是约定优于配置和自动装配
    2022-07-07
  • Java数据结构之线段树的原理与实现

    Java数据结构之线段树的原理与实现

    线段树是一种二叉搜索树,是用来维护区间信息的数据结构。本文将利用示例详细讲讲Java数据结构中线段树的原理与实现,需要的可以参考一下
    2022-06-06

最新评论