JavaSE之注解

Java 注解

概念：

• 说明程序的。给计算机看的

定义：

• 注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

作用分类

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

---

JDK中预定义的一些注解

• @Override : 检测被该注解标注的方法是否是继承自父类(接口)的
• @Deprecated：该注解标注的内容，表示已过时
• @SuppressWarnings：压制警告

@SuppressWarnings("all")

---

自定义注解

本质：

• 注解本质上就是一个接口，该接口默认继承Annotation接口

属性：

• 接口中的抽象方法

要求：

• 属性的返回值类型有下列取值

  • 基本数据类型
  • String
  • 枚举
  • 注解
  • 以上类型的数组

• 定义了属性，在使用时需要给属性赋值

  • 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。

  public @interface myAnno {
      String show2() default "张无忌";
  }
  ----------------------------------
  @myAnno()
  

  • 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。

  public @interface myAnno {
      String value();
  }
  -----------------------------------
  @myAnno("张无忌")
  

  • 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

  public @interface myAnno {
      String[] strs();
  }
  -----------------------------------
  @myAnno(strs = {"张无忌","张三丰"})
  

---

元注解：用于描述注解的注解

• @target : 描述注解能够作用的位置

public @interface Target {
    ElementType[] value();
}

通过底层代码发现，注解@Target中只有一个属性：ElementType[] value();

追踪ElementType[] 发现，他是一个枚举类。

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    //可以作用于类上
    TYPE,
    /** Field declaration (includes enum constants) */
    可以作用于成员变量上
    FIELD,
    /** Method declaration */
    可以作用于方法上
    METHOD,
    /** Formal parameter declaration */
    PARAMETER,
    /** Constructor declaration */
    CONSTRUCTOR,
    /** Local variable declaration */
    LOCAL_VARIABLE,
    /** Annotation type declaration */
    ANNOTATION_TYPE,
    /** Package declaration */
    PACKAGE,
    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,
    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE,
    /**
     * Module declaration.
     *
     * @since 9
     */
    MODULE
}

自定义注解

@Target(value = {ElementType.TYPE})   //表示该注解只能加在类上
public @interface myAnno2 {}
------------------------------------------------------------
@Target(value = {ElementType.METHOD})   //表示该注解只能加在方法上
public @interface myAnno3 {}
------------------------------------------------------------
@Target(value = {ElementType.TYPE，ElementType.METHOD})   
    //表示该注解能在类和方法上
public @interface myAnno4 {}   

测试类

@myAnno2
public class Test {
    public void eat(){}
}
------------------------------ 
public class Test {
    @myAnno3
    public void eat(){}
}
------------------------------
@myAnno4
public class Test {
    @myAnno4
    public void eat(){}
}

---

• @Retention : 描述注解被保留的阶段

@Retention(RetentionPolicy.RUNTIME)
public @interface myAnno {}
//@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到

• @Documented : 描述注解是否被抽取到API文档中( ==也就是当加上@Documented 注解后，生成的API文档中就会有这个注解==）
• @Inherited ： 描述注解是否被子类继承