利用Java的注解实现自定义校验器

2023-12-19 18:23:54 浏览数 (1)

Java的注解是一种可用于将元数据信息与程序源代码中的各个部分进行关联的机制。而校验器则是在开发过程中必不可少的一部分,它可以用来保证系统或者接口输入参数的有效性和准确性。利用Java的注解实现自定义校验器可以提高开发效率,减少代码维护的工作量,并且能够更加规范化地管理项目代码。

一、Java自带的注解方式

Java 8 API中包含了常用的注解方式,如@NotNull、@Size、@Pattern等常见的五大注解(Null、Digits、Size、Min、Max)。使用这些注解可以非常便捷地对JavaBean中属性值进行校验。

示例:

代码语言:javascript复制
public class User {
    @NotNull
    private String name;
 
    @Digits(integer = 3, fraction = 0)
    private Integer age;
}

上述代码通过使用Java 8提供的注解方式,对用户对象的name属性设置了@NotNull注解,以表明该属性不能为空;同时,对age属性设置了@Digits注解,以表明该属性必须为三位数字。

二、自定义注解方式

如果以上注解方式已经不能满足项目需求,或者需要定制复杂的业务校验规则时,就需要自定义注解来实现。

定义Annotation使用@interface关键字,并在其中定义相关的成员变量和方法等,其具体流程如下:

1、定义Annotation

代码语言:javascript复制
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
@Inherited  
public @interface CustomValidation {  
    String value() default "";  
}

2、校验器实现

在Annotation中定义校验规则之后,需要编写对应的校验器。校验器通常会提供针对不同类型的校验方法,每个方法会接收一个或多个参数,并通过逻辑判断来确定输入是否合法。如果参数不符合校验规则,则校验器需要抛出自定义异常信息。

示例:

代码语言:javascript复制
public class CustomValidator {
    
    public static void validate(Object obj) throws CustomValidateException {
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(CustomValidation.class)) {
                CustomValidation customValidation = field.getAnnotation(CustomValidation.class);
                String regex = customValidation.value();
                field.setAccessible(true);
                Object value;
                try {
                    value = field.get(obj);
                } catch (IllegalAccessException e) {
                    throw new CustomValidateException("Illegal access to parameter "   field.getName(), e);
                }
                if (!(value instanceof String)) {
                    continue;
                }
                String str = (String) value;
                if (!str.matches(regex)) {
                    throw new CustomValidateException(customValidation.errorMessage());
                }
            }
        }
    }
 
}
 
public class CustomValidateException extends Exception{
    
    private static final long serialVersionUID = 1740078840867426842L;
     
    public CustomValidateException(String message) {
        super(message);
    }
     
    public CustomValidateException(String message, Throwable e) {
        super(message, e);
    }
     
}

3、测试案例

在完成了Annotation和Validator的开发后,需要写查询Test Case进行测试;这里仅提供一个简单的示例:

代码语言:javascript复制
public class UserTest {
 
    @Test
    public void testValidation() throws Exception{
        User user = new User();
        user.setName(null);
        user.setAge(101); 
        CustomValidator.validate(user);
    }
    
}

在执行上述代码前提下,校验器会根据User对象中的@CustomValidation注解检查name属性是否为空,并且age是否超过上限100。如果任意一项校验不通过,则会抛出指定的校验异常。

0 人点赞