Java注解（Annotation）详解：定义、元注解、自定义注解

翻滚的胖子
2023-05-26 17:26:45
后端技术
Java

Java注解（Annotation）是Java 5开始引入的一种注释机制，是一种元数据，能够以注解的形式声明代码的一些特定信息，与Javadoc不同，注解可以通过反射获取到注解内容，因此注解也被称为元数据。

1. 注解的定义

Java 提供了四种元注解，专门负责注解其他的注解，分别是：

@Retention：注解的保留位置，有 SOURCE、CLASS、RUNTIME 三个参数，分别表示注解只保留在源文件中、class 文件中或者运行时可通过反射获取。
@Documented：注解是否将包含在 JavaDoc 中。
@Target：注解的作用目标，取值有 METHOD、TYPE、CONSTRUCTOR、FIELD 等等。
@Inherited：是否允许子类继承该注解。

除了这四个元注解，Java 还提供了一些用于声明注解的元素的注解，包括：

@interface：声明一个注解。
@Deprecated：标识过时的方法或类。
@Override：标识子类中的方法覆盖了父类中的方法。
@SuppressWarnings：压制特定类型的警告。

2. 常用注解

Java中内置的一些注解，如：

@Override：用于标识方法覆盖父类中的方法。
@Deprecated：用于标识方法或类已经过时，不推荐使用。
@SuppressWarnings：用于压制编译器发出的警告信息。

3. 自定义注解

除了内置注解，Java还支持自定义注解，可以通过 @interface 关键字定义注解，如下所示：

public @interface MyAnnotation {
    String value() default "";
}

其中，value() 方法是注解的一个元素，可以通过 MyAnnotation 注解来访问该元素，如下所示：

@MyAnnotation("hello")
public class MyClass {
    ...
}

自定义注解还可以有默认值，如下所示：

public @interface MyAnnotation {
    String value() default "";
    int age() default 18;
}

在使用时，可以直接使用默认值，也可以设置成自己想要的值，如下所示：

@MyAnnotation
public class MyClass {
    ...
}

@MyAnnotation(value = "hello", age = 20)
public class MyClass2 {
    ...
}

4. 注解的使用

使用注解可以给代码添加更多的信息，比如给方法添加相应的注释：

public class Test {
    @MyAnnotation(value = "hello")
    public void sayHello() {
        System.out.println("Hello World!");
    }
}

也可以给类添加注解：

@MyAnnotation(value = "hello")
public class Test {
    ...
}

在程序中，可以使用反射获取到类、方法或者字段中的注解信息，如下所示：

// 获取类上的注解
MyAnnotation annotation = Test.class.getAnnotation(MyAnnotation.class);

// 获取方法上的注解
MyAnnotation annotation = Test.class.getMethod("sayHello").getAnnotation(MyAnnotation.class);

// 获取字段上的注解
MyAnnotation annotation = Test.class.getDeclaredField("name").getAnnotation(MyAnnotation.class);