java 注解校验入参Integer

原创

mob649e816138f5 2024-09-08 06:09:41 ©著作权

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

使用Java注解校验入参Integer

Java的注解机制为我们提供了一种优雅的方法来实现对入参的校验，尤其是在处理整数类型时。接下来，我会通过一个实际的例子来向你展示如何实现这一功能，内容包括整体流程、每一步的具体实现，以及相关代码解析。我们将会创建一个自定义的注解，以便对方法参数进行验证。

整体流程

在实现注解校验之前，我们首先需要明确实现的步骤。以下是整个过程的流程图：

步骤	描述
1	创建自定义注解
2	创建参数校验器
3	创建一个使用注解的示例方法
4	实现反射来处理校验逻辑
5	运行并验证结果

步骤详解

1. 创建自定义注解

首先，我们要创建一个自定义的注解。这个注解的功能是校验一个参数是否在指定的范围内。

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

// 定义一个注解，参数是整型且必须在某个范围内
@Target(ElementType.PARAMETER) // 这个注解用在方法参数上
@Retention(RetentionPolicy.RUNTIME) // 运行时可用
public @interface ValidateInteger {
    int min() default Integer.MIN_VALUE; // 最小值，默认是整型的最小值
    int max() default Integer.MAX_VALUE; // 最大值，默认是整型的最大值
}

2. 创建参数校验器

接下来，我们需要一个校验器来处理这些注解。它会检查实际传入的方法参数是否符合注解的限制。

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;

// 校验器类
public class Validator {

    public static void validateParams(Object... params) throws Exception {
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        String methodName = stackTrace[2].getMethodName(); // 获取调用方法名称
        Method method = findMethod(methodName); // 通过方法名称找到对应的方法
        Parameter[] parameters = method.getParameters(); // 获取方法参数

        for (int i = 0; i < params.length; i++) {
            if (parameters[i].isAnnotationPresent(ValidateInteger.class)) {
                ValidateInteger validate = parameters[i].getAnnotation(ValidateInteger.class);
                int value = (Integer) params[i];

                // 检查值是否在注解指定的范围内
                if (value < validate.min() || value > validate.max()) {
                    throw new IllegalArgumentException("Parameter out of bounds: " + value);
                }
            }
        }
    }

    private static Method findMethod(String methodName) throws NoSuchMethodException {
        return MyClass.class.getMethod(methodName, Integer.class); // 替换为你的类名
    }
}

3. 创建一个使用注解的示例方法

现在，我们来创建一个方法，使用我们定义的注解并做一些实际的参数检查。

public class MyClass {
    
    // 示例方法
    public void myMethod(@ValidateInteger(min=1, max=10) Integer number) throws Exception {
        // 入参校验
        Validator.validateParams(number);
        // 业务逻辑
        System.out.println("Valid number: " + number);
    }
}

4. 实现反射来处理校验逻辑

如上所示，我们在Validator类中实现了反射逻辑以动态获取方法参数和相应的注解。这使得我们可以在运行时校验参数是否符合规则。

5. 运行并验证结果

最后，我们将执行这个方法，看看我们的注解校验是否正常工作。

public class Main {
    public static void main(String[] args) {
        MyClass myClass = new MyClass();
        try {
            myClass.myMethod(5); // 应该运行正常
            myClass.myMethod(15); // 应该抛出异常
        } catch (Exception e) {
            System.out.println(e.getMessage()); // 输出错误信息
        }
    }
}

序列图

接下来的序列图将展示整个过程的调用情况。

sequenceDiagram
    participant User
    participant MyClass
    participant Validator

    User->>MyClass: Call myMethod(5)
    MyClass->>Validator: Validate Params
    Validator-->>MyClass: Validation passed
    MyClass-->>User: Print Valid number: 5

    User->>MyClass: Call myMethod(15)
    MyClass->>Validator: Validate Params
    Validator-->>MyClass: Validation failed
    MyClass-->>User: Print Error message

旅行图

下面是一个旅行图来展示整个流程：

journey
    title Java Annotation Validation
    section Create Annotation
      Create my ValidateInteger annotation: 5: User
      Create min and max properties: 5: User
    section Create Validator
      Create validateParams method: 5: User
      Implement reflection logic: 5: User
    section Create Method
      Annotate method parameters in MyClass: 5: User
    section Run Validation
      Call myMethod with good input: 5: User
      Call myMethod with bad input: 5: User