java自定义注解获取方法上的入参

原创

mob649e8164659f 2024-02-04 07:24:45 ©著作权

文章标签 自定义注解 Java System 文章分类 Java 后端开发

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

Java自定义注解获取方法上的入参

1. 引言

在Java开发中，我们经常使用注解来为代码添加额外的信息，以便于在运行时进行一些特定的处理。注解可以应用于类、方法、字段等各种代码元素，它们提供了一种灵活而强大的方式来扩展Java语言的功能。

本文将介绍如何使用Java自定义注解来获取方法上的入参。我们将首先了解什么是自定义注解，然后介绍如何定义和使用自定义注解，并且展示如何通过反射机制获取方法的参数信息。

2. 自定义注解

自定义注解是一种特殊的Java接口，它们使用@interface关键字进行定义。自定义注解可以包含成员变量、方法和其他注解。成员变量可以通过default关键字设置默认值，方法可以用于访问或操作注解的成员变量。

下面的示例演示了如何定义一个自定义注解@MethodInfo，并且使用了两个成员变量author和version。

public @interface MethodInfo {
    String author() default "Unknown";
    int version() default 1;
}

3. 使用自定义注解

要使用自定义注解，我们需要将其应用于代码中的某个元素。在方法上使用注解时，我们可以通过反射机制在运行时获取到方法的参数信息。

下面的示例展示了如何在方法上使用@MethodInfo注解，并且获取到方法的参数类型和参数名。

public class Example {
    @MethodInfo(author = "John", version = 2)
    public void doSomething(String name, int age) {
        // 方法实现
    }
    
    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Example.class.getMethod("doSomething", String.class, int.class);
        MethodInfo annotation = method.getAnnotation(MethodInfo.class);
        
        System.out.println("Author: " + annotation.author());
        System.out.println("Version: " + annotation.version());
        
        Parameter[] parameters = method.getParameters();
        System.out.println("Parameters:");
        System.out.println("| 参数类型 | 参数名 |");
        System.out.println("| --- | --- |");
        for (Parameter parameter : parameters) {
            System.out.println("| " + parameter.getType().getSimpleName() + " | " + parameter.getName() + " |");
        }
    }
}

以上示例中，我们首先使用getMethod方法获取到doSomething方法的Method对象。然后通过getAnnotation方法获取到MethodInfo注解的实例，并且可以通过访问注解的成员变量来获取到注解的值。

接下来，我们使用getParameters方法获取到方法的参数数组，并通过遍历参数数组来获取到每个参数的类型和名称。

运行以上代码，输出的结果如下：

Author: John
Version: 2
Parameters:
| 参数类型 | 参数名 |
| --- | --- |
| String | name |
| int | age |

可以看到，我们成功获取到了方法上注解的值，并且获取到了方法的参数信息。

4. 类图

下面是示例代码中的类图表示，使用mermaid语法中的classDiagram来描述类之间的关系。

classDiagram
    class Example {
        +doSomething(name: String, age: int): void
    }
    
    interface MethodInfo {
        +author(): String
        +version(): int
    }
    
    Example --|> MethodInfo