hibernate validator自定义注解实战之《枚举值校验》

本文介绍了如何在Spring项目中利用hibernate validator自定义注解进行枚举值校验。通过创建`EnumValue`注解和对应的校验类,实现了针对枚举字段的有效性检查,简化了代码并提高了可读性。文中提供了代码实现和使用示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

前言

在spring项目中,校验参数功能使用hibernate validator是一个不错的选择,我们的项目中也是使用它来进行校验的,省去了很多难看的校验逻辑,使代码的可读性也大大增加,本章将带你使用hibernate validator自定义注解功能实现一个 枚举值校验的逻辑。

需求

我们先明确下我们的需求,在程序开发过程中,我们经常会有一个对象的属性值只能出现在一组常量中的校验需求,例如:用户性别字段gender只能等于MALE/FEMALE这两个其中一个值,用户账号的状态status只能等于:NORMAL/DISABLED/DELETED其中一个等等,那么我们怎么能更好的校验这个参数呢?我们想拥有一个java注解,把它标记在所要校验的字段上,当开启hibernate validator校验时,就可以校验其字段值是否正确。

实现方案

上面提到的一组常量值,我们第一反应应该是定义一个枚举类,尽量不要放在一个统一的constants类下,这样当系统一旦庞大起来,常量是很难维护和查找的,所以前期代码也应该有一些规范性约束,这里我们约定一组常量值时使用枚举,并把该枚举类放在对应的类对象里(以上述所说的用户功能为例,我们应该把GenerEnum、UserStatusEnum枚举放在User.java下,方便查找)
这里我们定义一个叫EnumValue.java的注解类,其下有两个主要参数一个是enumClass用于指定枚举类,enumMethod指定要校验的方法,下面我们看代码实现。

代码实现

package com.zhuma.demo.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.Payload;

import org.assertj.core.util.Strings;

/**
 * @desc 校验枚举值有效性
 * 
 * @author zhumaer
 * @since 10/17/2017 3:13 PM
 */
@Target({
    ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumValue.Validator.class)
public @interface EnumValue {
   

	String message() default "{custom.value.invalid}";

	Class<?>[] groups() default {
   };

	Class<? extends Payload>[] payload(<
### Java 中校验枚举注解方法 在 Java 的 Bean Validation 框架中,默认提供的注解(如 `@NotNull` 或 `@Pattern`)通常不适用于直接验证枚举类型。这是因为框架本身并未提供专门针对枚举类型的内置约束机制[^3]。 #### 自定义注解实现枚举校验 为了满足这一需求,可以通过创建自定义注解并结合相应的验证器类来完成对枚举类型的校验。以下是具体实现方式: 1. **定义自定义注解** 创建一个新的注解,例如 `@EnumValue`,并通过元注解指定其作用范围以及关联的验证逻辑。 ```java 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; @Target({ElementType.FIELD, ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = EnumValidator.class) // 关联验证器 public @interface EnumValue { String message() default "Invalid enum value"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; // 定义允许的枚举类 Class<? extends Enum<?>> enumClass(); } ``` 2. **编写验证器类** 实现具体的验证逻辑,确保传入的属于目标枚举类型中的合法成员。 ```java import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; public class EnumValidator implements ConstraintValidator<EnumValue, Object> { private Enum<?>[] values; @Override public void initialize(EnumValue constraintAnnotation) { this.values = constraintAnnotation.enumClass().getEnumConstants(); // 获取所有枚举常量 if (this.values == null || this.values.length == 0) { throw new IllegalArgumentException("The given enum is empty!"); } } @Override public boolean isValid(Object value, ConstraintValidatorContext context) { if (value == null) { // 如果字段可以为空,则返回 true return true; } for (Enum<?> e : values) { if (e.name().equals(value.toString())) { // 验证输入是否匹配任意枚举名称 return true; } } return false; // 输入非法 } } ``` 3. **应用自定义注解** 将新定义的注解应用于需要校验的字段上。 ```java public enum CustomerType { INDIVIDUAL, BUSINESS } public class Customer { @EnumValue(enumClass = CustomerType.class, message = "Unsupported customer type") private String customerType; // Getter and Setter methods... } ``` 4. **测试验证功能** 使用 Hibernate Validator 等工具运行验证流程,确认枚举的有效性。 ```java import org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator; import javax.validation.Validation; import javax.validation.ValidatorFactory; import javax.validation.Validator; import javax.validation.ConstraintViolation; public class MainApp { public static void main(String[] args) { ValidatorFactory factory = Validation.byDefaultProvider() .configure() .messageInterpolator(new ResourceBundleMessageInterpolator()) .buildValidatorFactory(); Validator validator = factory.getValidator(); Customer customer = new Customer(); customer.setCustomerType("INVALID_TYPE"); Set<ConstraintViolation<Customer>> violations = validator.validate(customer); for (ConstraintViolation<Customer> violation : violations) { System.out.println(violation.getMessage()); // 输出: Unsupported customer type } } } ``` 以上代码展示了如何通过自定义注解和验证器实现对枚举类型的校验。这种方法不仅灵活而且易于扩展,能够适应多种业务场景的需求[^4]。 ---
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值