java 遍历类属性的注解

原创

mob649e8161738c 2023-11-20 06:40:26 ©著作权

文章标签 字段 Java java 文章分类 Java 后端开发

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

Java遍历类属性的注解

在Java开发中，注解是一种元数据，它可以为代码提供额外的信息，可以应用于类、方法、变量等。在某些情况下，我们需要在运行时获取类的属性上的注解信息，这时我们就需要通过反射来实现。

反射简介

反射是Java语言的一个特性，它允许我们在运行时获取、操作和修改类的方法、字段、构造函数等信息。反射提供了一种机制，可以使我们在编写代码时不需要事先知道类的结构，而是在运行时动态地获取类的信息。

Java中的反射API主要由以下几个类组成：

Class类：用于表示类的信息，可以获取类的字段、方法、构造函数等信息。
Field类：用于表示类的字段信息，可以获取字段的注解信息。
Method类：用于表示类的方法信息，可以获取方法的注解信息。
Constructor类：用于表示类的构造函数信息，可以获取构造函数的注解信息。

获取类属性上的注解

下面通过一个示例来演示如何遍历类属性上的注解。

首先，我们定义一个注解@ColumnInfo，用于标识类的字段信息：

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ColumnInfo {
    String name();
    String type();
}

然后，我们定义一个被注解标记的类Person，其中包含两个被注解标记的属性：

public class Person {
    @ColumnInfo(name = "id", type = "int")
    private int id;

    @ColumnInfo(name = "name", type = "string")
    private String name;

    // 省略getter和setter方法...
}

现在，我们可以使用反射来获取Person类中的属性上的注解信息：

import java.lang.reflect.Field;

public class AnnotationExample {
    public static void main(String[] args) {
        Class<Person> personClass = Person.class;
        Field[] fields = personClass.getDeclaredFields();

        for (Field field : fields) {
            if (field.isAnnotationPresent(ColumnInfo.class)) {
                ColumnInfo columnInfo = field.getAnnotation(ColumnInfo.class);
                System.out.println("Field: " + field.getName());
                System.out.println("Name: " + columnInfo.name());
                System.out.println("Type: " + columnInfo.type());
                System.out.println();
            }
        }
    }
}

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

Field: id
Name: id
Type: int

Field: name
Name: name
Type: string

在上述代码中，我们使用getDeclaredFields()方法获取类的所有字段，然后使用isAnnotationPresent(ColumnInfo.class)方法判断字段上是否有指定的注解。如果有注解，则使用getAnnotation(ColumnInfo.class)方法获取注解实例，并通过注解实例获取注解中的属性值。