java 中的注解@是什么

个人博客

什么是注解（Annotation）？

注解（Annotation）是Java中的一种元数据形式，用于在代码中添加额外的信息，这些信息可以在编译时或运行时通过反射机制进行读取。注解不会直接影响代码的执行逻辑，但可以用于描述代码的某些属性或行为，例如指示编译器执行特定操作、生成代码文档、在运行时提供配置数据等。

Java中的注解是一个特殊的接口，其语法类似于接口声明，但使用了 @ 符号。例如：

@interface MyAnnotation {
    String value();
}

注解的使用方式

注解可以用在以下：

1. 类、接口、枚举：

   @MyAnnotation(value = "Class Level")
   public class MyClass {
       // ...
   }
   

2. 方法：

   @MyAnnotation(value = "Method Level")
   public void myMethod() {
       // ...
   }
   

3. 字段：

   @MyAnnotation(value = "Field Level")
   private String myField;
   

4. 参数：

   public void myMethod(@MyAnnotation(value = "Parameter Level") String param) {
       // ...
   }
   

5. 局部变量：

   public void myMethod() {
       @MyAnnotation(value = "Local Variable Level") String localVar = "value";
   }
   

6. 注解：注解也可以用于另一个注解上（称为元注解）。

   @Retention(RetentionPolicy.RUNTIME)
   @Target(ElementType.TYPE)
   public @interface MyAnnotation {
       String value();
   }
   

常见的元注解

元注解用于定义注解的行为，它们包括：

1. @Retention：指定注解的保留策略，有三个值：

   • RetentionPolicy.SOURCE：只在源代码中存在，编译时被丢弃。
   • RetentionPolicy.CLASS：在编译时存在于类文件中，但运行时不会加载到JVM中。
   • RetentionPolicy.RUNTIME：在运行时保留，可以通过反射访问。

   @Retention(RetentionPolicy.RUNTIME)
   public @interface MyAnnotation {
       String value();
   }
   

2. @Target：指定注解可以应用的目标（类、方法、字段等）。常见的值有：

   • ElementType.TYPE：类、接口、枚举、注解。
   • ElementType.FIELD：字段。
   • ElementType.METHOD：方法。
   • ElementType.PARAMETER：方法参数。
   • ElementType.CONSTRUCTOR：构造函数。
   • ElementType.LOCAL_VARIABLE：局部变量。
   • ElementType.ANNOTATION_TYPE：注解类型。
   • ElementType.PACKAGE：包。

   @Target(ElementType.METHOD)
   public @interface MyAnnotation {
       String value();
   }
   

3. @Inherited：允许子类继承父类的注解。

   @Inherited
   @Retention(RetentionPolicy.RUNTIME)
   @Target(ElementType.TYPE)
   public @interface MyAnnotation {
       String value();
   }
   

4. @Documented：指示注解应包含在Javadoc中。

   @Documented
   @Retention(RetentionPolicy.RUNTIME)
   @Target(ElementType.TYPE)
   public @interface MyAnnotation {
       String value();
   }
   

常见的标准注解

Java中有一些常见的标准注解，用于特定的目的：

1. @Override：表示该方法重写了超类中的方法。编译器会检查该方法是否确实是一个重写。

   @Override
   public String toString() {
       return "MyClass";
   }
   

2. @Deprecated：标记该方法、类或字段已过时，不建议使用。编译器会生成警告。

   @Deprecated
   public void oldMethod() {
       // Old implementation
   }
   

3. @SuppressWarnings：指示编译器忽略指定的警告。

   @SuppressWarnings("unchecked")
   public void myMethod() {
       // Suppressed warning code
   }
   

4. @SafeVarargs：用于消除使用可变参数时的泛型类型安全警告，通常用于泛型方法。

   @SafeVarargs
   public final <T> void print(T... args) {
       for (T arg : args) {
           System.out.println(arg);
       }
   }
   

5. @FunctionalInterface：表示该接口是一个函数式接口，即仅有一个抽象方法的接口。此注解不是必须的，但标记它可以确保接口符合函数式接口的定义。

   @FunctionalInterface
   public interface MyFunctionalInterface {
       void doSomething();
   }
   

自定义注解

你可以根据需要定义自己的注解。例如，定义一个简单的注解 MyAnnotation：

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    String value() default "default value";
}

然后，可以将其应用到方法上，并通过反射在运行时获取注解的信息：

public class MyClass {

    @MyAnnotation(value = "Custom Annotation Example")
    public void myMethod() {
        // Method implementation
    }

    public static void main(String[] args) throws Exception {
        MyClass obj = new MyClass();
        MyAnnotation annotation = obj.getClass()
                                     .getMethod("myMethod")
                                     .getAnnotation(MyAnnotation.class);
        System.out.println(annotation.value());  // 输出: Custom Annotation Example
    }
}

运行时处理注解

在运行时，使用反射可以获取和处理注解。例如：

import java.lang.reflect.Method;

public class AnnotationProcessor {

    public static void main(String[] args) throws Exception {
        Method method = MyClass.class.getMethod("myMethod");

        if (method.isAnnotationPresent(MyAnnotation.class)) {
            MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
            System.out.println("Value: " + annotation.value());
        }
    }
}