Java注解

1.1、什么是注解

• Annotation是从JDK5.0开始引入的新技术
• Annotation的作用：
  • 不是程序本身，可以对程序做出一些解释(这一点和注释没有什么区别)
  • 可以被其他程序(如：编译器等)读取
• Annotation
  • 注解是以"@注释名"在代码中存在的 ， 还可以添加一些参数值 , 例如:@SuppressWarnings(value=“unchecked”)
• Annotation使用场景：
  • 可以附加在package , class , method , field 等上面 , 相当于给他们添加了额外的辅助信息
  • 可以通过反射机制实现对这些元数据的访问

1.2、内置注解

• @Override：定义在 java.lang.Override 中 , 此注释只适用于修辞方法 , 表示一个方法声明打算重写超类中的另一个方法声明。
• @Deprecated：定义在java.lang.Deprecated中 , 此注释可以用于修辞方法 , 属性 , 类 , 表示不鼓励程序员使用这样的元素 , 通常是因为它很危险或者存在更好的选择。
• @SuppressWarnings： 定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息 ， 定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息
  • @SuppressWarnings(“all”)
  • @SuppressWarnings(“unchecked”)
  • @SuppressWarnings(value={“unchecked”,“deprecation”})

1.3、元注解

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

• 这些类型和他们所支持的类java.lang.annotation包中可以找到(@Target、@Retention、@Documented、@Inherited)

  • @Target：用于描述注解的使用范围(即：被描述的注解可以用在什么地方)
  • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的声明周期(SOURE < CLASS < RUNTIME)
  • @Documented：说明该注解将被包含在javadoc中
  • @Inherited：说明子类可以继承父类中的该注解

  /**
   * 测试元注解
   */
  public class Test02 {
  
      @MyAnnotation
      public void test() {}
  
  }
  
  
  // 定义一个注解
  // Target：表示我们的注解可以用在哪些地方
  @Target(value = {ElementType.METHOD, ElementType.TYPE})
  
  // Retention表示我们的注解在什么地方才有效
  // SOURE < CLASS < RUNTIME
  @Retention(value = RetentionPolicy.RUNTIME)
  // 表示是否将注解生成在Javadoc中
  @Documented
  
  // Inherited 子类可以继承父类的注解
  @Inherited
  @interface MyAnnotation{
  
  }
  

1.4、自定义注解

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

分析：

• @ interface用来声明一个注解 , 格式 : public @ interface 注解名 { 定义内容 }

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

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

• 返回值类型就是参数的类型 ( 返回值只能是基本类型,Class , String , enum )

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

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

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

  /**
   * 自定义注解
   */
  public class Test03 {
      
      // 注解可以显示赋值，如果没有默认值，则一定要赋值
      @MyAnnotation2(name = "测试", schools = {"国科大"})
      public void test() {
      }
  
  
      // 如果注解只有一个值，可以用value命名，赋值时可以省略
      @MyAnnotation3("测试")
      public void test2() {
      }
      
  }
  
  
  @Target(value = {ElementType.TYPE, ElementType.METHOD})
  @Retention(value = RetentionPolicy.RUNTIME)
  @interface MyAnnotation2{
      // 注解的参数：参数类型 参数名 ();
      // 可以加默认值
      String name() default "";
      int age() default 0;
      int id() default -1;// 如果默认值为-1，代表不存在
      String[] schools() default {"清华", "北大"};
  }
  
  @Target(value = {ElementType.TYPE, ElementType.METHOD})
  @Retention(value = RetentionPolicy.RUNTIME)
  @interface MyAnnotation3{
      String value();
  }
  

注意：
如果类的方法做了AOP切入，这个类就会被代理
正常情况下，我们的class是 com.cxytiandi.eureka_client.controller.ArticleController形式，用了AOP后，就会变成com.cxytiandi.eureka_client.controller.ArticleController$EnhancerBySpringCGLIB$3323dd1e。
这种情况下类上的注解就无法通过class类拿到了，同时拿到的Method也是被代理了的，所以Method上的注解也获取不到
我们可以用Spring里面提供的AnnotationUtils来获取注解