Java基础（12）注解

分手后的思念是犯贱 2024-05-06 23:23 9阅读 0赞

Java注解（Annotations）是自Java 5以来的一个重要特性，它为Java源代码添加了获取程序元数据的能力。注解本身不直接影响代码的操作，但它们可以被编译器或运行时环境用于各种类型的处理，如编译检查、代码分析、或在运行时进行配置等。

#### 注解的基本概念 ####

注解是一种特殊的接口，使用`@interface`关键字进行定义。它可以应用于其他的声明上，如类、方法或字段等。注解中的方法可以被视为特殊类型的成员变量，其“值”可用于注解的“属性”。

#### 定义注解 ####

定义一个简单的注解`@MyAnnotation`，它可以应用于方法上：

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Retention(RetentionPolicy.RUNTIME) // 注解在运行时保留
    @Target(ElementType.METHOD) // 注解可应用于方法上
    public @interface MyAnnotation {
        
        String description() default "This is my annotation"; // 带默认值的注解属性
    }

#### 使用注解 ####

接下来，我们使用这个注解来标注一个方法：

public class MyAnnotatedClass {
        
    
        @MyAnnotation(description = "This is an example method")
        public void myMethod() {
        
        }
    }

#### 注解的处理 ####

注解的处理分为编译时处理和运行时处理，接下来我们将重点讨论运行时处理。

##### 运行时处理 #####

要在运行时处理注解，我们需要使用反射（Reflection）。下面是如何检索`MyAnnotation`注解信息的示例：

import java.lang.reflect.Method;
    
    public class AnnotationProcessor {
        
        public static void main(String[] args) {
        
            for(Method method : MyAnnotatedClass.class.getDeclaredMethods()) {
        
                // 检查方法上是否存在MyAnnotation注解
                if(method.isAnnotationPresent(MyAnnotation.class)) {
        
                    MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
                    System.out.println("Method: " + method.getName() + ", Description: " + myAnnotation.description());
                }
            }
        }
    }

这段代码会遍历`MyAnnotatedClass`类中所有方法，检查这些方法是否使用了`MyAnnotation`注解，并打印注解的`description`属性。

#### 注解的元注解 ####

注解的定义可以通过使用称为元注解的特殊注解来增强。我们已经在`@MyAnnotation`的定义中使用了两个元注解`@Retention`和`@Target`：

*  `@Retention`指定注解的保留策略，例如`RetentionPolicy.RUNTIME`表示注解在运行时保留，因此可以通过反射访问。
 *  `@Target`指定注解可以应用的Java元素，例如`ElementType.METHOD`表示注解仅可应用于方法上。

其他元注解包括`@Documented`（标记这些注解应被javadoc工具记录）和`@Inherited`（指示注解类型会被自动继承）。

#### 注解的内部原理 ####

在Java中，注解本质上是通过接口实现的。编译器将注解处理为一种特殊的接口，注解的属性变成了接口中的方法。当你查询一个注解的属性时，实际上是在调用一个方法。

#### 小结 ####

Java注解是一种用于提供元数据的强大机制，可以被用于编译时处理，如检查和生成代码，或者在运行时用于获取关于类、方法或字段的信息。通过元注解，可以进一步控制注解的行为。反射API使得在运行时处理注解成为可能，从而为动态配置、测试和其他需要在运行时读取类信息的场景提供了便利。透过注解和反射，Java开发者可以编写出更为灵活和强大的代码。