java 注解数据校验报错提醒

原创

mob64ca12f37e8a 2024-09-01 03:30:34 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12f37e8a的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 注解数据校验与报错提醒

在 Java 开发中，数据校验是一个重要的环节。尤其在处理用户输入时，通过注解驱动的校验机制可以有效减少错误和不一致的数据。本文将详细介绍如何实现 Java 注解数据校验及其报错提醒。

整体流程

我们将通过以下几个步骤来完成这个任务：

步骤	描述
1	创建自定义注解
2	实现数据校验逻辑
3	创建校验处理器
4	测试数据校验

步骤详解

步骤 1：创建自定义注解

我们需要先定义一个自定义注解，用于标识需要校验的字段。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 注解的目标是字段
@Target(ElementType.FIELD) 
@Retention(RetentionPolicy.RUNTIME) // 保留到运行时
public @interface NotNull {
    String message() default "字段不能为空"; // 默认提示信息
}

步骤 2：实现数据校验逻辑

我们需要创建一个数据模型，并结合自定义注解来标识需要校验的字段。

public class User {

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

    @NotNull // 使用默认消息
    private String password;

    // 构造函数
    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }

    // 省略getter和setter方法
}

步骤 3：创建校验处理器

我们需要创建一个校验处理器，用于解析注解并执行实际的校验工作。

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

// 校验处理器
public class Validator {

    public static List<String> validate(Object obj) {
        List<String> errors = new ArrayList<>();

        // 获取对象的所有字段
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(NotNull.class)) { // 判断该字段是否被@NotNull注解标记
                field.setAccessible(true); // 需要访问私有字段
                try {
                    Object value = field.get(obj);
                    if (value == null || value.toString().trim().isEmpty()) { // 校验逻辑
                        // 获取注解信息
                        NotNull notNull = field.getAnnotation(NotNull.class);
                        errors.add(notNull.message()); // 记录错误信息
                    }
                } catch (IllegalAccessException e) {
                    e.printStackTrace(); // 异常处理
                }
            }
        }
        return errors;
    }
}

步骤 4：测试数据校验

最后，我们将测试我们的校验功能，看看是否能够准确识别出未填写的字段。

import java.util.List;

public class Main {
    public static void main(String[] args) {
        User user = new User(null, "password"); // 创建一个用户名为空的 User 对象
        List<String> errors = Validator.validate(user); // 进行校验

        // 输出校验结果
        if (errors.isEmpty()) {
            System.out.println("校验通过");
        } else {
            System.out.println("校验未通过，错误信息：");
            errors.forEach(System.out::println); // 打印所有错误信息
        }
    }
}

类图

下面是使用 mermaid 语法描绘的类图：

classDiagram
    class User {
        +String username
        +String password
        +User(String username, String password)
    }
    
    class NotNull {
        +String message()
    }
    
    class Validator {
        +List<String> validate(Object obj)
    }

    User --> NotNull
    Validator -- User