实现基于自定义注解和反射的属性验证框架

题目

实现基于自定义注解和反射的属性验证框架

信息

• 类型：问答
• 难度：⭐⭐

考点

自定义注解定义,反射API使用,注解处理器设计,属性验证逻辑

快速回答

实现步骤：

1. 定义@NotNull和@Range注解
2. 创建验证工具类通过反射获取字段注解
3. 根据注解类型执行验证逻辑
4. 收集并返回验证结果

核心代码片段：

// 获取字段所有注解
Annotation[] annos = field.getDeclaredAnnotations();
// 根据注解类型执行验证
if (anno instanceof NotNull) {
    // 空值检查逻辑
} else if (anno instanceof Range) {
    // 范围检查逻辑
}

问题背景

在业务系统中，经常需要对Java对象的属性进行验证（如非空检查、数值范围等）。使用注解+反射可以实现声明式的验证框架，避免重复代码。

解决方案

1. 定义自定义注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface NotNull {
    String message() default "Field cannot be null";
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {
    int min() default 0;
    int max() default Integer.MAX_VALUE;
    String message() default "Value out of range";
}

2. 实现验证处理器

public class Validator {
    public static List<String> validate(Object obj) {
        List<String> errors = new ArrayList<>();
        Class<?> clazz = obj.getClass();

        for (Field field : clazz.getDeclaredFields()) {
            field.setAccessible(true);

            // 处理@NotNull注解
            if (field.isAnnotationPresent(NotNull.class)) {
                try {
                    Object value = field.get(obj);
                    if (value == null) {
                        errors.add(field.getName() + ": " + 
                                  field.getAnnotation(NotNull.class).message());
                    }
                } catch (IllegalAccessException e) {
                    errors.add("Access error for " + field.getName());
                }
            }

            // 处理@Range注解
            if (field.isAnnotationPresent(Range.class)) {
                try {
                    Object value = field.get(obj);
                    if (value instanceof Number) {
                        Range range = field.getAnnotation(Range.class);
                        double num = ((Number) value).doubleValue();
                        if (num < range.min() || num > range.max()) {
                            errors.add(field.getName() + ": " + range.message() + 
                                      " [" + range.min() + "-" + range.max() + "]");
                        }
                    }
                } catch (IllegalAccessException e) {
                    errors.add("Access error for " + field.getName());
                }
            }
        }
        return errors;
    }
}

3. 使用示例

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;

    @Range(min = 18, max = 60, message = "年龄必须在18-60之间")
    private int age;

    // 构造方法及getter/setter
}

// 测试验证
User user = new User(null, 16);
List<String> errors = Validator.validate(user);
// 输出: [username: 用户名不能为空, age: 年龄必须在18-60之间 [18-60]]

核心原理

• 注解保留策略：@Retention(RetentionPolicy.RUNTIME)确保注解在运行时可通过反射获取
• 反射API：Class.getDeclaredFields()获取所有字段，Field.getAnnotation()读取注解信息
• 类型检查：使用instanceof确保字段值类型符合预期

最佳实践

1. 性能优化：缓存类的字段和注解信息，避免重复反射
2. 扩展性：定义Validator接口，支持添加多种验证器
3. 错误处理：使用setAccessible(true)访问私有字段，并捕获IllegalAccessException
4. 链式调用：返回验证结果对象而非简单列表，包含字段路径和错误详情

常见错误

扩展知识

• JSR 380：Java验证标准（Bean Validation 2.0），推荐使用Hibernate Validator实现
• 注解处理器：编译时处理注解（APT），如Lombok的原理
• 性能对比：反射比直接调用慢100倍，但在框架中可接受
• 替代方案：字节码增强（ASM/CGLIB）或动态代理实现类似功能