自定义校验注解validation

这篇博客介绍了Java中注解的创建与使用,特别是UserStatus注解及其对应的UserStatusValidator校验器。通过注解实现了对Integer类型的字段进行特定值的校验,确保状态值只能为1000、1001或1002。同时,文章还展示了如何在实际测试中应用这个校验机制。

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

 1.注解类接口

 

 

​
@Documented
@Constraint(validatedBy = { UserStatusValidator.class}) // 说明当前注解要被谁来完成校验工作
@Target({ FIELD})
@Retention(RUNTIME)
public @interface UserStatus {

    String message() default "status必须是1000/1001/1002";

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

    Class<? extends Payload>[] payload() default { };
}

​

 2.注解实现类

 

public class UserStatusValidator implements ConstraintValidator<UserStatus, Integer>  {


    @Override
    public void initialize(UserStatus constraintAnnotation) {

    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        if ( value == null ) {
            return true;
        }
        Set<Integer> set = new HashSet<>();
        set.add(1000);
        set.add(1001);
        set.add(1002);
        return set.contains(value);
    }
}

3.测试校验

 

### 创建和使用自定义数据校验注解 在 Spring Boot 中实现自定义数据校验注解涉及几个主要步骤,包括创建约束注解、编写验证逻辑以及应用该注解到需要校验的地方。 #### 定义自定义注解 首先,需定义一个新的注解用于标记待检验的属性。此操作可通过 `Constraint` 和其他元注解完成: ```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.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = MyCustomValidator.class) // 指定对应的验证器类 public @interface MyCustom { String message() default "Invalid value"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` 上述代码片段展示了如何声明名为 `MyCustom` 的新注解[^1]。 #### 实现 ConstraintValidator 接口 接着要为这个新的注解提供具体的验证行为,这通常意味着扩展 `ConstraintValidator<A,T>` 类型并重写其方法: ```java import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; public class MyCustomValidator implements ConstraintValidator<MyCustom, String> { @Override public void initialize(MyCustom constraintAnnotation) {} @Override public boolean isValid(String value, ConstraintValidatorContext context) { if (value == null || "".equals(value.trim())) return false; // Add custom validation logic here. return true; // Replace with actual condition check } } ``` 这段程序说明了怎样构建一个简单的字符串有效性检查函数[^2]。 #### 应用自定义注解于实体或 DTO 属性之上 一旦完成了前面两步的工作,则可以直接把刚刚建立好的注解放置在任何希望执行相应规则的位置上: ```java public class UserDTO { private Long id; @MyCustom(message="The username must be valid.") private String userName; // Getters and setters... } ``` 这里展示了一个假设性的场景——即对用户名进行了额外的有效性检测[^3]。 #### 配置与测试 最后一步就是确保应用程序上下文中包含了必要的 Bean 来处理这些新增加的功能;对于大多数情况而言,默认配置已经足够支持基本功能。可以通过单元测试来确认一切正常运作: ```java @SpringBootTest class CustomValidationTests { @Autowired Validator validator; @Test void testValidUserDto(){ UserDTO user = new UserDTO(); Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); assertFalse(violations.isEmpty()); } @Test void testInValidUserDto(){ UserDTO user = new UserDTO(); user.setUserName("validUsername"); Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); assertTrue(violations.isEmpty()); } } ``` 以上示例演示了如何利用 JUnit 测试框架来进行简单有效的集成测试[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值