注释 用文字描述程序的,给程序员看的。 注解 说明程序的,给计算机看的,也叫元数据。 一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释 使用注解:@注解名称

Annotation 架构

image.png
从中,我们可以看出:

  • 1 个 Annotation 和 1 个 RetentionPolicy 关联。
    • 可以理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性
  • 1 个 Annotation 和 1~n 个 ElementType 关联。
    • 可以理解为:对于每 1 个 Annotation 对象,可以有若干个 ElementType 属性。
  • Annotation 有许多实现类,包括:Deprecated, Documented, Inherited, Override 等等。

下面,我先介绍框架图的左半边,即 Annotation, RetentionPolicy, ElementType;然后在就 Annotation 的实现类进行举例说明。

Annotation 组成部分

java Annotation 的组成中,有 3 个非常重要的主干类。它们分别是:
Annotation.java

  1. package java.lang.annotation;
  2. public interface Annotation {
  3. boolean equals(Object obj);
  4. int hashCode();
  5. String toString();
  6. Class<? extends Annotation> annotationType();
  7. }

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口(包括注释类型)或枚举声明  */

    FIELD,              /* 字段声明(包括枚举常量)  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中,并且可由JVM读入 */
}
  • Annotation 就是个接口
    • “每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联,并且与 “1~n 个 ElementType” 关联。可以通俗的理解为:每 1 个 Annotation 对象,都会有唯一的 RetentionPolicy 属性;至于 ElementType 属性,则有 1~n 个。
  • ElementType 是 Enum 枚举类型,它用来指定 Annotation 的类型
    • “每 1 个 Annotation” 都与 “1~n 个 ElementType” 关联。当 Annotation 与某个 ElementType 关联时,就意味着:Annotation有了某种用途。例如,若一个 Annotation 对象是 METHOD 类型,则该 Annotation 只能用来修饰方法
  • RetentionPolicy 是 Enum 枚举类型,它用来指定 Annotation 的策略。通俗点说,就是不同 RetentionPolicy 类型的 Annotation 的作用域不同。“每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联
    • a) 若 Annotation 的类型为 SOURCE,则意味着:Annotation 仅存在于编译器处理期间,编译器处理完之后,该 Annotation 就没用了。 例如,” @Override” 标志就是一个 Annotation。当它修饰一个方法的时候,就意味着该方法覆盖父类的方法;并且在编译期间会进行语法检查!编译器处理完后,”@Override” 就没有任何作用了。
    • b) 若 Annotation 的类型为 CLASS,则意味着:编译器将 Annotation 存储于类对应的 .class 文件中,它是 Annotation 的默认行为。
    • c) 若 Annotation 的类型为 RUNTIME,则意味着:编译器将 Annotation 存储于 class 文件中,并且可由JVM读入

这时,只需要记住”每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联,并且与 “1~n 个 ElementType” 关联。学完后面的内容之后,再回头看这些内容,会更容易理解

理解了上面的 3 个类的作用之后,我们接下来可以讲解 Annotation 实现类的语法定义了。

Annotation 通用定义

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation1 {
}

上面的作用是定义一个 Annotation,它的名字是 MyAnnotation1。定义了 MyAnnotation1 之后,我们可以在代码中通过 “@MyAnnotation1” 来使用它。 其它的,@Documented, @Target, @Retention, @interface 都是来修饰 MyAnnotation1 的。下面分别说说它们的含义:

  • @interface
    • 使用 @interface 定义注解时,意味着它实现了 java.lang.annotation.Annotation 接口,即该注解就是一个Annotation。
    • 定义 Annotation 时,@interface 是必须的。
    • 注意:它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后,该注解不能继承其他的注解或接口
  • @Documented
    • 类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该 Annotation,则表示它可以出现在 javadoc 中。
    • 定义 Annotation 时,@Documented 可有可无;若没有定义,则 Annotation 不会出现在 javadoc 中。
  • @Target(ElementType.TYPE)
    • 前面我们说过,ElementType 是 Annotation 的类型属性。而 @Target 的作用,就是来指定 Annotation 的类型属性。
    • @Target(ElementType.TYPE) 的意思就是指定该 Annotation 的类型是 ElementType.TYPE。这就意味着,MyAnnotation1 是来修饰”类、接口(包括注释类型)或枚举声明”的注解。
    • 定义 Annotation 时,@Target 可有可无。若有 @Target,则该 Annotation 只能用于它所指定的地方;若没有 @Target,则该 Annotation 可以用于任何地方。
  • @Retention(RetentionPolicy.RUNTIME)
    • 前面我们说过,RetentionPolicy 是 Annotation 的策略属性,而 @Retention 的作用,就是指定 Annotation 的策略属性。
    • @Retention(RetentionPolicy.RUNTIME) 的意思就是指定该 Annotation 的策略是 RetentionPolicy.RUNTIME。这就意味着,编译器会将该 Annotation 信息保留在 .class 文件中,并且能被虚拟机读取。
    • 定义 Annotation 时,@Retention 可有可无。若没有 @Retention,则默认是 RetentionPolicy.CLASS。

通过上面的示例,我们能理解:@interface 用来声明 Annotation,@Documented 用来表示该 Annotation 是否会出现在 javadoc 中, @Target 用来指定 Annotation 的类型,@Retention 用来指定 Annotation 的策略。
理解这一点之后,我们就很容易理解 java 中自带的 Annotation 的实现类,即 Annotation 架构图的右半边。如下图:
image.png

@Deprecated  -- @Deprecated 所标注内容,不再被建议使用。
@Override    -- @Override 只能标注方法,表示该方法覆盖父类中的方法。
@Documented  -- @Documented 所标注内容,可以出现在javadoc中。
@Inherited   -- @Inherited只能被用来标注“Annotation类型”,它所标注的Annotation具有继承性。
@Retention   -- @Retention只能被用来标注“Annotation类型”,而且它被用来指定Annotation的RetentionPolicy属性。
@Target      -- @Target只能被用来标注“Annotation类型”,而且它被用来指定Annotation的ElementType属性。
@SuppressWarnings -- @SuppressWarnings 所标注内容产生的警告,编译器会对这些警告保持静默。

由于 “@Deprecated 和 @Override” 类似,”@Documented, @Inherited, @Retention, @Target” 类似;
下面,我们只对 @Deprecated, @Inherited, @SuppressWarnings 这 3 个 Annotation 进行说明。

@Deprecated
@Deprecated 的定义如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}
  • @interface — 它的用来修饰 Deprecated,意味着 Deprecated 实现了 java.lang.annotation.Annotation 接口;即 Deprecated 就是一个注解。 (02) @Documented — 它的作用是说明该注解能出现在 javadoc 中。
  • @Retention(RetentionPolicy.RUNTIME) — 它的作用是指定 Deprecated 的策略是 RetentionPolicy.RUNTIME。这就意味着,编译器会将Deprecated 的信息保留在 .class 文件中,并且能被虚拟机读取。
  • @Deprecated 所标注内容,不再被建议使用

例如,若某个方法被 @Deprecated 标注,则该方法不再被建议使用。如果有开发人员试图使用或重写被 @Deprecated 标示的方法,编译器会给相应的提示信息。示例如下:

import java.util.Date;
import java.util.Calendar;

public class DeprecatedTest {
    // @Deprecated 修饰 getString1(),表示 它是建议不被使用的函数
    @Deprecated
    private static void getString1(){
        System.out.println("Deprecated Method");
    }

    private static void getString2(){
        System.out.println("Normal Method");
    }

    // Date是日期/时间类。java已经不建议使用该类了
    private static void testDate() {
        Date date = new Date(113, 8, 25);
        System.out.println(date.getYear());
    }
    // Calendar是日期/时间类。java建议使用Calendar取代Date表示"日期/时间"
    private static void testCalendar() {
        Calendar cal = Calendar.getInstance();
        System.out.println(cal.get(Calendar.YEAR));
    }

    public static void main(String[] args) {
        getString1();
        getString2();
        testDate();
        testCalendar();
    }
}

image.png

  • getString1() 被 @Deprecated 标注,意味着建议不再使用 getString1(); 所以 getString1() 的定义和调用时,都会一横线。这一横线是eclipse() 对 @Deprecated 方法的处理。
  • getString2() 没有被 @Deprecated 标注,它的显示正常。
  • testDate() 调用了 Date 的相关方法,而 java 已经建议不再使用 Date 操作日期/时间。因此,在调用 Date的API 时,会产生警告信息,途中的 warnings。
  • testCalendar() 调用了 Calendar 的 API 来操作日期/时间,java 建议用 Calendar 取代 Date。因此,操作 Calendar 不会产生 warning。

@Inherited

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}
  • @interface — 它的用来修饰 Inherited,意味着 Inherited 实现了 java.lang.annotation.Annotation 接口;即 Inherited 就是一个注解。
  • @Documented — 它的作用是说明该注解能出现在 javadoc 中。
  • (@Retention(RetentionPolicy.RUNTIME) — 它的作用是指定 Inherited 的策略是 RetentionPolicy.RUNTIME。这就意味着,编译器会将 Inherited 的信息保留在 .class 文件中,并且能被虚拟机读取。
  • @Target(ElementType.ANNOTATION_TYPE) — 它的作用是指定 Inherited 的类型是 ANNOTATION_TYPE。这就意味着,@Inherited 只能被用来标注 “Annotation 类型”。
  • @Inherited 的含义是,它所标注的Annotation将具有继承性。

假设,我们定义了某个 Annotaion,它的名称是 MyAnnotation,并且 MyAnnotation 被标注为 @Inherited。现在,某个类 Base 使用了MyAnnotation,则 Base 具有了”具有了注解 MyAnnotation”;现在,Sub 继承了 Base,由于 MyAnnotation 是 @Inherited的(具有继承性),所以,Sub 也 “具有了注解 MyAnnotation”。

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

/**
 * 自定义的Annotation。
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@interface Inheritable{
}

@Inheritable
class InheritableFather
{
    public InheritableFather() {
        // InheritableBase是否具有 Inheritable Annotation
        System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class));
    }
}

/**
 * InheritableSon 类只是继承于 InheritableFather,
 */
public class InheritableSon extends InheritableFather
{
    public InheritableSon() {
        super();    // 调用父类的构造函数
        // InheritableSon类是否具有 Inheritable Annotation
        System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class));
    }

    public static void main(String[] args)
    {
        InheritableSon is = new InheritableSon();
    }
}

/*  
InheritableFather:true
InheritableSon:true
*/

注释掉 “Inheritable 的 @Inherited 注解”。输出

/*  
InheritableFather:true
InheritableSon:false
*/

@SuppressWarnings

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}
  • @interface — 它的用来修饰 SuppressWarnings,意味着 SuppressWarnings 实现了 java.lang.annotation.Annotation 接口;即 SuppressWarnings 就是一个注解。
  • @Retention(RetentionPolicy.SOURCE) — 它的作用是指定 SuppressWarnings 的策略是 RetentionPolicy.SOURCE。这就意味着,SuppressWarnings 信息仅存在于编译器处理期间,编译器处理完之后 SuppressWarnings 就没有作用了。
  • @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) — 它的作用是指定 SuppressWarnings 的类型同时包括TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE。
    • TYPE 意味着,它能标注”类、接口(包括注释类型)或枚举声明”。
    • FIELD 意味着,它能标注”字段声明”。
    • METHOD 意味着,它能标注”方法”。
    • PARAMETER 意味着,它能标注”参数”。
    • CONSTRUCTOR 意味着,它能标注”构造方法”。
    • LOCAL_VARIABLE 意味着,它能标注”局部变量”。
  • String[] value(); 意味着,SuppressWarnings 能指定参数
  • SuppressWarnings 的作用是,让编译器对”它所标注的内容”的某些警告保持静默。例如,”@SuppressWarnings(value={“deprecation”, “unchecked”})” 表示对”它所标注的内容”中的 “SuppressWarnings 不再建议使用警告”和”未检查的转换时的警告”保持沉默。示例如下: ```kotlin import java.util.Date;

public class SuppressWarningTest {

//@SuppressWarnings(value={"deprecation"})
public static void doSomething(){
    Date date = new Date(113, 8, 26);
    System.out.println(date);
}

public static void main(String[] args) {
    doSomething();
}

}

![image.png](https://cdn.nlark.com/yuque/0/2021/png/604921/1638425960786-0d51d0fd-9536-4322-92c2-dc3bcd3f7af3.png#clientId=ue1cd4314-17ef-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=475&id=uc91f6acd&name=image.png&originHeight=475&originWidth=823&originalType=binary&ratio=1&rotation=0&showTitle=false&size=244074&status=done&style=none&taskId=ufee4a89c-1c19-4182-8adc-1a64e0b9032&title=&width=823)<br />![image.png](https://cdn.nlark.com/yuque/0/2021/png/604921/1638425985267-b9177ee3-0a86-456a-9f04-afe82dda4f66.png#clientId=ue1cd4314-17ef-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=459&id=u940e1fa6&name=image.png&originHeight=459&originWidth=824&originalType=binary&ratio=1&rotation=0&showTitle=false&size=191486&status=done&style=none&taskId=u15d0d544-974a-436a-b04e-f5d028af6e4&title=&width=824)

- 没有使用 @SuppressWarnings(value={"deprecation"}) , 而 Date 属于 java 不再建议使用的类。因此,调用 Date 的 API 时,会产生警告。
- 使用了 @SuppressWarnings(value={"deprecation"})。因此,编译器对"调用 Date 的 API 产生的警告"保持沉默。

补充:SuppressWarnings 常用的关键字的表格
```kotlin
deprecation  -- 使用了不赞成使用的类或方法时的警告
unchecked    -- 执行了未检查的转换时的警告,例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型。
fallthrough  -- 当 Switch 程序块直接通往下一种情况而没有 Break 时的警告。
path         -- 在类路径、源文件路径等中有不存在的路径时的警告。
serial       -- 当在可序列化的类上缺少 serialVersionUID 定义时的警告。
finally      -- 任何 finally 子句不能正常完成时的警告。
all          -- 关于以上所有情况的警告。

Annotation 的作用

Annotation 是一个辅助类,它在 Junit、Struts、Spring 等工具框架中被广泛使用。
我们在编程中经常会使用到的 Annotation 作用有:

辅助查看代码

通过 @Override, @Deprecated 等,我们能很方便的了解程序的大致结构。
另外,我们也可以通过自定义 Annotation 来实现一些功能。

编译检查

Annotation 具有”让编译器进行编译检查的作用”。
例如,@SuppressWarnings, @Deprecated 和 @Override 都具有编译检查作用。关于 @SuppressWarnings 和 @Deprecated,已经在”第3部分”中详细介绍过了。这里就不再举例说明了。

  • 若某个方法被 @Override 的标注,则意味着该方法会覆盖父类中的同名方法。如果有方法被 @Override 标示,但父类中却没有”被 @Override 标注”的同名方法,则编译器会报错。示例如下:

    public class OverrideTest {
    
      /**
       * toString() 在java.lang.Object中定义;
       * 因此,这里用 @Override 标注是对的。
       */
      @Override
      public String toString(){
          return "Override toString";
      }
    
      /**
       * getString() 没有在OverrideTest的任何父类中定义;
       * 但是,这里却用 @Override 标注,因此会产生编译错误!
       */
      @Override
      public String getString(){
          return "get toString";
      }
    
      public static void main(String[] args) {
      }
    }
    

    image.png
    上面是该程序在 eclipse 中的截图。从中,我们可以发现 “getString()” 函数会报错。这是因为 “getString() 被 @Override 所标注,但在OverrideTest 的任何父类中都没有定义 getString1() 函数”。
    “将 getString() 上面的 @Override注释掉”,即可解决该错误

生成帮助文档

通过给 Annotation 注解加上 @Documented 标签,能使该 Annotation 标签出现在 javadoc 中。

在反射中使用 Annotation

在反射的 Class, Method, Field 等函数中,有许多于 Annotation 相关的接口。
这也意味着,我们可以在反射中解析并使用 Annotation。

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Method;

/**
 * Annotation在反射函数中的使用示例
 */
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String[] value() default "unknown";
    int[] age() default 0;
}

/**
 * Person类。它会使用MyAnnotation注解。
 */
class Person {
    /**
     * empty()方法同时被 "@Deprecated" 和 "@MyAnnotation(value={"a","b"})"所标注
     * (01) @Deprecated,意味着empty()方法,不再被建议使用
     * (02) @MyAnnotation, 意味着empty(),方法对应的MyAnnotation的value值是默认值"unknown"
     */
    @MyAnnotation
    @Deprecated
    public void empty() {
        System.out.println("\nempty");
    }

    /**
     * sombody() 被 @MyAnnotation(value={"Ken","一缕清风"})
     * 所标注, @MyAnnotation(value={"Ken","一缕清风"}),
     * 意味着MyAnnotation的value值是{"Ken","一缕清风"}
     */
    @MyAnnotation(value = {"Ken", "一缕清风"}, age = 18)
    public void getUserInfo(String name, int age) {
        System.out.println("\ngetUserInfo: " + name + ", " + age);
    }
}



public class AnnotationTest {
    public static void main(String[] args) throws Exception {
        Person person = new Person(); // 新建Person
        Class<Person> c = Person.class; // 获取Person的Class实例
        // 获取 getUserInfo() 方法的Method实例
        Method mSomebody = c.getMethod("getUserInfo", new Class[]{String.class, int.class});
        mSomebody.invoke(person, new Object[]{"唐昊", 40}); // 执行该方法
        iteratorAnnotations(mSomebody);

        // 获取 getUserInfo() 方法的Method实例
        Method mEmpty = c.getMethod("empty", new Class[]{});
        mEmpty.invoke(person, new Object[]{}); // 执行该方法
        iteratorAnnotations(mEmpty);
    }

    public static void iteratorAnnotations(Method method) {
        // 判断 getUserInfo() 方法是否包含MyAnnotation注解
        if (method.isAnnotationPresent(MyAnnotation.class)) {
            // 获取该方法的MyAnnotation注解实例
            MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
            System.out.print("获取 myAnnotation的值,并打印出来:");
            String[] values = myAnnotation.value();
            for (String str : values)
                System.out.printf(str + ", ");
            System.out.println("");
        }

        // 获取方法上的所有注解,并打印出来
        Annotation[] annotations = method.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println("获取方法上的所有注解,并打印出来:" + annotation);
        }
    }
}


/*
getUserInfo: 唐昊, 40
获取 myAnnotation的值,并打印出来:Ken, 一缕清风, 
获取方法上的所有注解,并打印出来:@MyAnnotation(value=[Ken, 一缕清风], age=[18])

empty
获取 myAnnotation的值,并打印出来:unknown, 
获取方法上的所有注解,并打印出来:@MyAnnotation(value=[unknown], age=[0])
获取方法上的所有注解,并打印出来:@java.lang.Deprecated()
*/

注解作用分类

编写文档 通过代码里标识的注解生成文档【生成文档doc文档】
代码分析 通过代码里标识的注解对代码进行分析【使用反射】
编译检查 通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

/**
 * 注释javadoc演示
 * 
 * @author Ken
 * @version 1.0.0
 * @since 1.5
 */
public class Demo {

  public static void main(String[] args) {
    System.out.println(new Demo().add(1, 2));
  }


  /**
   * 计算两数的和
   * 
   * @param num1
   * @param num2
   * @return 两数之和
   */
  private int add(int num1, int num2) {
    return num1 + num2;
  }
}

可以使用 javadoc xxxx.java 生成文档doc文档

JDK中预定义的一些注解

Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。

作用在代码的注解

注解 说明
@Override 检测被该注解标注的方法是否是继承自父类(接口)的
检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
@Deprecated 该注解标注的内容,表示已过时。如果使用该方法,会报编译警告。
@SuppressWarnings 压制警告,指示编译器去忽略注解中声明的警告。
一般传递参数all @SuppressWarnings(“all”)

作用在描述注解的元注解

注解 说明
@Target 描述注解能够作用的位置
标记这个注解应该是哪种 Java 成员
ElementType取值
- TYPE 可以作用于类上
- METHOD 可以作用于方法上
- FIELD 可以作用于成员变量上
@Retention 描述注解被保留的阶段
标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问
@Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
@Documented 描述注解是否被抽取到api文档中
标记这些注解是否包含在用户文档中
@Inherited 描述注解是否被子类继承
标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

从 Java 7 开始,额外添加了 3 个注解:

  • @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
  • @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
  • @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

编译和反编译

编译

class Main {
  public @interface A{ }
}

javac Main.java 得到 Main.class 文件

反编译

javap Main.class 后得到的内容

public interface A extends java.lang.annotation.Annotation {}

生成文档doc文档

javadoc javac Main.java

自定义注解

//元注解
public @interface 注解名称{
       属性列表;
 }

通过反编译可知道,注解本质上就是一个接口,该接口默认继承Annotation接口

public interface MyAnno extends java.lang.annotation.Annotation {}

接口中的抽象方法

  • 属性的返回值类型有下列取值
    • 基本数据类型
    • String
    • 枚举
    • 注解
    • 数组
    • 以上类型的数组
  • 定义了属性,在使用时需要给属性赋值
    • 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值
    • 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可
    • 数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略 ```java enum Person { p1, p2 }

@interface Annoface { }

@interface myAnnoface { int value() default 1; String methodString(); Person methodPersonEnum(); Annoface methodAnnoface(); String[] methodStringArr(); }

public class Demo { public static void main(String[] args) { }

@myAnnoface( value = 2, methodPersonEnum=Person.p1, methodAnnoface = @Annoface, methodStringArr = “我”, methodString = “Ken” ) public static void method() { } }



<a name="jG2Gl"></a>
### 在程序使用(解析)注解获取注解中定义的属性值
```java
import java.lang.annotation.*;

@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@interface pro {
  String className();

  String methodName();
}

public class Demo {
  public static void main(String[] args) throws Exception {
    pro an = Main.class.getAnnotation(pro.class);
    String className = an.className();
    String methodName = an.methodName();
    Class<?> cls = Class.forName(className);
    Object o = cls.getConstructor().newInstance();
    Object invoke = cls.getMethod(methodName).invoke(0);
    System.out.println(invoke);
  }
}

案例

简单的测试框架

注解案例.png