Java注解（Annotation）

注解（Annotation）

1. Annotation是JDK5.0引入的

2. Annotation的作用：

   ~ 不是程序本身，可以对程序作出解释（这点与注释（comment）类似）
   ~ 可以被其他程序（编译器）读取

3. Annotation的格式：注解是以“@注解名”的形式在代码中存在的，还可以添加一些参数值，例：@SuppressWarnings("all")

4. Annotation用在哪里？可以附加在package、class、method、field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

 

常见的内置注解

• @Override：定义在java.lang.Override中，此注解只适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明。

• @Deprecated：定义在java.lang.Deprecated中，此注释可以用于修饰方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或是存在更好的选择。

• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。

  • 与前两个注解有所不同，使用的时候需要添加参数，同时这些参数又都是定义好了的。

  • @SuppressWarnings("all")

  • @SuppressWarnings("unchecked")

  • @SuppressWarnings(value = {"unchecked"})

  • @SuppressWarnings(value = {"unchecked","Deprecattion"})

 

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明。

• 这些类型和它们所支持的类在java.lang.annotation包中可以找到。（@Target、@Retention、@Documented、@lnherited)

  • @Target：用于描述注解的使用范围(即:描述注解可以用在什么地方)

    @Target(value = {ElementType.METHOD,ElementType.TYPE})

  • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（表示注解在什么地方还有效）

    (SOURCE < CLASS < RUNTIME)

    @Retention(value = RetentionPolicy.RUNTIME)

  • @Document：说明该注解将被包含在javadoc中

  • @lnherited：说明子类可以继承父类中的该注解

 

自定义注解

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

• @ interface用来声明一个注解，格式：public @interface注解名{定义内容}（public可视情况去掉）

• 其中的每一个方法实际上是声明了一个配置参数。

• 方法的名称就是参数的名称。

• 返回值类型就是参数的类型（返回值只能是基本类型 Class、String、enum)。

• 可以通过default来声明参数的默认值。

• 如果只有一个参数成员，一般参数名为value。

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

  package Annotation;
  ​
  import java.lang.annotation.*;
  ​
  @myAnnotation(name = "aai", age = 0)
  public class TestMyAnnotation {
      @myAnnotation(age = 1, name = "bbi")
      @myAnnotation2("cci")
      public void test() {
      }
  ​
      @myAnnotation(age = 1, name = "bbi", tel = 12345)
      public void test2() {
      }
  }
  ​
  @Target({ElementType.METHOD, ElementType.TYPE})
  @Retention(RetentionPolicy.RUNTIME)
  @Inherited
  @interface myAnnotation {
      //参数类型 参数名()
      String name();
  ​
      int age();
  ​
      int tel() default 10000;
  ​
      //默认值为-1 代表不存在
      int other() default -1;
  ​
      String[] where() default {"广东","广州"};
  }
  ​
  @Target({ElementType.METHOD})
  @Retention(RetentionPolicy.RUNTIME)
  @interface myAnnotation2 {
      //如果只有一个值的时候 可以将这个值的名字设置为value
      //届时在使用注解的时候就可以省略掉值的名字
      //@myAnnotation2("cci")
      String value();
  }