深入理解Java注解

1. 注解的概念

Java 注解（Annotation）是一种用于为代码中的元素（如类、方法、变量等）提供元数据的机制。注解本身不会直接影响代码的执行，但可以通过工具或框架在编译时、类加载时或运行时对这些元数据进行处理，以实现特定的功能。

主要用途：

1. 编译时指示：编译器可以根据注解提供的信息生成警告或错误。例如，@Override 注解可以告诉编译器某个方法是对父类方法的重写，如果没有成功重写，编译器会报错。
2. 运行时处理：在运行时，注解可以通过反射机制被读取，并在程序中触发特定的逻辑操作。例如，Java 的许多框架（如 Spring、JUnit）广泛使用注解来配置和控制对象的行为。
3. 代码生成：注解可以用于代码生成工具，帮助自动生成代码、配置文件或其他资源。例如，@Entity 注解可以用于标记一个类为数据库实体类，并且代码生成工具可以基于此注解自动生成数据库表结构。

基本特性：

• 轻量级：注解的语法简单，使用 @ 符号添加在代码元素上。
• 元数据驱动：注解描述的是关于代码的额外信息，可以帮助工具或框架在不改变代码逻辑的情况下实现特定功能。
• 可扩展性：Java 允许开发者自定义注解，结合框架或工具，提供灵活的配置和功能扩展。

2. Java中的内置注解

1. @Override：定义在 java.lang.Override 中，此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明。
2. @Deprecated：定义在 java.lang.Deprecated 中，此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险，或者存在更好的替代方法。比如JAVA中已废弃的方法。

• @SuppressWarnings：定义在 java.lang.SuppressWarnings 中，用来抑制编译时的警告信息。
  • 注意：与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就好了。
  • 例如：
    • @SuppressWarnings(“all”)
    • @SuppressWarnings(“unchecked”)
    • @SuppressWarnings(value={“unchecked”,“deprecation”})

3.Java中的元注解

1. @Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。
   • ElementType 枚举类定义了 @Target 的 value 属性的可选范围，包括（JDK1.5）：
     • TYPE：声明类、接口、枚举；
     • FIELD：声明成员变量；
     • METHOD：声明方法；
     • PARAMETER：声明形式参数；
     • CONSTRUCTOR：声明构造方法；
     • LOCAL_VARIABLE：声明局部变量；
     • ANNOTATION_TYPE：声明注解；
     • PACKAGE：声明包；
     • TYPE_PARAMETER：声明参数化类型，如泛型，JDK1.8；
     • TYPE_USE：声明任何类型名称，JDK1.8；
2. @Retention：表示需要在什么级别保存该注释信息,用于描述注解的生命周期。
3. @Documented：说明该注解将被包含在javadoc中，编译完成会生成对应的doc文档。
4. @Inherited：用于标记其他的注解，指明标记的注解是可以被子类自动继承的。
   • 注意：此注解只对注解标记的超类有效，对接口是无效的。
   • 示例：假设，我们定义了某个 Annotaion，它的名称是 MyAnnotation，并且 MyAnnotation 被标注为 @Inherited。现在，某个类 Base 使用了MyAnnotation，则 Base 具有了"具有了注解 MyAnnotation"；现在，Sub 继承了 Base，由于 MyAnnotation 是 @Inherited的(具有继承性)，所以，Sub 也 “具有了注解 MyAnnotation”。

4.自定义注解

使用 @interface 自定义注解时，将自动继承了 java.lang.annotation.Annotation 接口。

1. @inierface 用来声明一个注解，格式：

   public @interface 注解名 {
       定义内容 
   }
   

2. 其中的每一个方法实际上是声明了一个配置参数；

3. 方法的名称就是参数的名称；

4. 返回值类型就是参数的类型（返回值只能是基本类型，Class，String，enum）；

5. 可以通过default来声明参数的默认值；

6. 如果只有一个参数成员，一般参数名为value；

7. 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0 作为默认值。

package com.it.annotation;

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

// 声明该注解可以添加在类、接口、枚举、方法上
@Target({ElementType.TYPE, ElementType.METHOD})
// 声明该注解在运行时有效
@Retention(RetentionPolicy.RUNTIME)
// 注解使用@interface关键字表示，一定要有@符号才可以
public @interface MyAnnotation {
    // 该注解有一个name属性，属性的值为String类型
    String name();

    // 该注解有一个age属性，属性的值为int类型，它的默认值为0
    int age() default 0;

    // 该注解有一个book数组属性，数组类型为String，默认值如下：
    String[] book() default {"java", "python", "C++"};
}

5.反射获取注解的值

注解与反射结合使用，可以完成诸如类与表结构映射等高级功能。例如，利用反射可以获取注解的值，并根据注解提供的元数据执行特定操作。

public class ReflectionExample {
    public static void main(String[] args) {
        if (MyClass.class.isAnnotationPresent(MyAnnotation.class)) {
            MyAnnotation annotation = MyClass.class.getAnnotation(MyAnnotation.class);
            System.out.println("Name: " + annotation.name());
            System.out.println("Age: " + annotation.age());
            System.out.println("Books: " + String.join(", ", annotation.book()));
        }
    }
}

@MyAnnotation(name = "ExampleClass", age = 25)
class MyClass {
    // This class uses MyAnnotation
}