Java—注解

Posted 2021-12-03 超霸霸

注解

一、简介

• 概念：
  说明程序的，给计算机看的
• 注释：
  用文字描述程序的，给程序员看的
• 定义：
  注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后引入的一个特征，于类、接口、枚举在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，也用来对这些元素进行说明，注释
• 概念描述：
  1. JDK1.5之后的新特性
  2. 说明程序的
  3. 使用注解：@注解名称
• 作用分类：
  1. 编写文档：提高代码里标记的注解生成文档【生成文档doc文档】
  2. 代码分析：提高代码里标识的注解对代码进行分析【使用反射】
  3. 编译检查：提高代码里标记的注解让编译器能够实现基本的编译检查【override】

二、JDK中预定义的一些注解

• @Override：检测被该注解标记的方法是否是继承自父类（接口）的
• @Deprecated：该注解标记的内容，表示已过时
• @SuppressWarnings：压制警告
  一般传递参数all

@SuppressWarnings("all")
public class annoDemo1 {

    @Override
    public String toString(){
        return super.toString();
    }

    @Deprecated
    public void show1(){
        //有缺陷
    }
}

三、自定义注解

• 格式：
  元注解

  public @interface 注解名称{`属性列表`}
  

• 本质：注解本质上就是一个接口，该接口默认继承Annotation接口
  public interface MyAnno extends java.lang.annotation.Annotation{}

• 属性：接口中的抽象方法

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

  //MyAnno：
  public @interface MyAnno {
      int age();
      String name() default "张三";
      Person per();
      MyAnno2 anno2();
      String[] strs();
  }
  
  //show2方法：
  @MyAnno(age = 1,per = Person.P1,@MyAnno2,strs = {"dsa","cca"})
  public void show2(){
          
  }
  

• 元注解:用于描述注解的注解

  1. @Target：描述注解能够作用的位置
     • ElementType取值：
       1. TYPE：可以作用于类上
       2. METHOD：可以作用于方法上
       3. FIELD：可以作用于成员变量上
  2. @Retention：描述注解被保留的阶段
     • @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
  3. @Documented：描述注解是否被抽取到api文档中
  4. @Inherited：描述注解是否被子类继承

  @Target({ElementType.TYPE,ElementType.METHOD, ElementType.FIELD})
  @Retention(RetentionPolicy.RUNTIME)
  @Documented
  @Inherited
  public @interface MyAnno3 {
  
  }
  

四、在程序中使用注解：获取注解中定义的属性值

• 获取注解定义的位置的对象（Class，Method，Field）
• 获取指定的注解：getAnnotation(Class)
• 调用注解中的抽象方法获取配置的属性值

小结

• 大多数时候，我们会使用注解而不是自定义注解
• 注解给谁用？
  1. 编译器
  2. 给解析程序用
• 注解不是程序的一部分，可以理解为注解就是一个标签