一：理解

  1. 注解(Annotation)也被称为元数据(Metadata)，用于修饰解释 包、类、方法、属性、构造器、局部变量等数据信息
  2. 和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。

  3. 在 JavaSE 中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在 JavaEE 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替 java EE 旧版中所遗留的繁冗代码和XML 配置等。

    二：基本Annotation介绍

    用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素。
    三个基本的Annotion：

  4. @Override: 限定某个方法，是重写父类方法, 该注解只能用于方法

  5. @Deprecated: 用于表示某个程序元素(类, 方法等)已过时
  6. @SuppressWarnings: 抑制编译器警告

    三：基本Annotation应用案例

    1：@Override 注解的案例

    :::info 限定某个方法，是重写父类的方法，该注解只能用于方法 :::
  • @Override 注解放在 Say 方法上，表示子类的 Say 方法时重写了父类的 Say
  • 这里如果没有写 @Override 还是会构成重写

  • 如果你写了@Override 注解，编译器就会去检查该方法是否真的重写了父类的方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误 ```java public class Test { public static void main(String[] args) {

    } } class A { public void Say(){

    1.   System.out.println("类A中的Say方法");

    }

} class B extends A{ @Override public void Say() { System.out.println(“类B中的Say方法”); } }

  1. > @interface 表示一个注解类而不是接口
  3. ```java
  4. @Target(ElementType.METHOD)
  5. @Retention(RetentionPolicy.SOURCE)
  6. public @interface Override {
  7. }

2：@Deprecated 注解的案例

:::info 用于表示某个程序元素（类，方法）已经过时了 :::

  • 可以修饰方法，类，字段, 包, 参数 等等
  • @Deprecated 可以做版本升级过渡使用 ```java @Deprecated class A { @Deprecated public void Say(){
    1.   System.out.println("类A中的Say方法");
    }

}

  1. ```java
  2. @Documented
  3. @Retention(RetentionPolicy.RUNTIME)
  4. @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
  5. public @interface Deprecated {
  6. }

3：@SuppressWarnings

:::info 抑制编译器的警告 :::

  • 当我们不希望看到这些警告的时候，可以使用 SuppressWarnings 注解来抑制警告信息
  • 在{“”} 中，可以写入你希望抑制(不显示)警告信息
  • 关于 SuppressWarnings 作用范围是和你放置的位置相关
    • 比如 @SuppressWarnings 放置在 main 方法，那么抑制警告的范围就是 main
      1. public class Test {
      2. public static void main(String[] args) {
      3.    @SuppressWarnings("ALL")
      4.    int num = 1;
      5. }
      6. }
      :::info all，抑制所有警告
      boxing，抑制与封装/拆装作业相关的警告
      cast，抑制与强制转型作业相关的警告
      dep-ann，抑制与淘汰注释相关的警告
      deprecation，抑制与淘汰的相关警告
      fallthrough，抑制与switch陈述式中遗漏break相关的警告
      finally，抑制与未传回finally区块相关的警告
      hiding，抑制与隐藏变数的区域变数相关的警告
      incomplete-switch，抑制与switch陈述式(enum case)中遗漏项目相关的警告
      javadoc，抑制与javadoc相关的警告
      nls，抑制与非nls字串文字相关的警告
      null，抑制与空值分析相关的警告
      rawtypes，抑制与使用raw类型相关的警告
      resource，抑制与使用Closeable类型的资源相关的警告
      restriction，抑制与使用不建议或禁止参照相关的警告
      serial，抑制与可序列化的类别遗漏serialVersionUID栏位相关的警告
      static-access，抑制与静态存取不正确相关的警告
      static-method，抑制与可能宣告为static的方法相关的警告
      super，抑制与置换方法相关但不含super呼叫的警告
      synthetic-access，抑制与内部类别的存取未最佳化相关的警告
      sync-override，抑制因为置换同步方法而遗漏同步化的警告
      unchecked，抑制与未检查的作业相关的警告
      unqualified-field-access，抑制与栏位存取不合格相关的警告
      unused，抑制与未用的程式码及停用的程式码相关的警告 :::
      1. @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
      2. @Retention(RetentionPolicy.SOURCE)
      3. public @interface SuppressWarnings {
      4. String[] value();
      5. }
      6. //放置的位置就是 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE
      7. //该注解类有数组 String[] values() 设置一个数组比如 {"rawtypes", "unchecked"}

      四：JDK的元Annotation

      1：元注解的基本介绍

      JDk的元Annotation用于修饰其它Anntation
      元注解： 本身作用不大，但是看源码时，可以知道他是干什么

      2：元注解的种类

  1. Retention //指定注解的作用范围，三种 SOURCE , CLASS , RUNTIME
  2. Target // 指定注解可以在哪些地方使用
  3. Documented //指定该注解是否会在 javadoc 体现

  4. Inherited //子类会继承父类注解

    3：@Retention注解

    :::info 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值 ::: @Retention 的三种值

  5. RetentionPolicy.SOURCE : 编译器使用后，直接丢弃这种策略的注释

  6. RetentionPolicy.CLASS : 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。这是默认值
  7. RetentionPolicy.RUNTIME : 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注解. 程序可以 通过反射获取该注解
    1. @Target(ElementType.METHOD)
    2. @Retention(RetentionPolicy.SOURCE)
    3. public @interface Override {
    4. }
    5. //说明 : Override的作用域在SOURCE，当编译器编译时生效，不会写入到.class 文件
    6. //也不会再runtime(运行时)生效

    4：@Target

    :::info 用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素.@Target也包含一个名为value的成员变量。 ::: ```java @Documented @Retention(RetentionPolicy.RUNTIME) //它的作用范围是Runtime @Target(ElementType.ANNOTATION_TYPE) //这里的ANNOTATION_TYPE说明只能修饰注释 public @interface Target { //说明它是注释 /**
    • Returns an array of the kinds of elements an annotation type
    • can be applied to.
    • @return an array of the kinds of elements an annotation type
    • can be applied to */ ElementType[] value(); }
  1. <a name="jdrca"></a>
  2. #### 5：@Documented
  3. :::info
  4. **_用于指定被该元 Annotation修饰的Annotation类将被javadoc工具提取成文档,即在生成文档时，可以看到该注解。_**<br />**_说明：定义为Documented的注解必须设置Retention值为RUNTIME._**
  5. :::
  6. ```java
  7. //个Deprecated注解@Documented，则javadoc会看到Deprecated
  8. @DocumentedDeprecated
  9. @Retention(RetentionPolicy.RUNTIME)
  10. @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
  11. public @interface Deprecated {
  12. }

6：@Inherited注解

:::info 被它修饰的 Annotation将具有继承性.如果某个类使用了被@Inherited修的 Annotation,则其子类将自动具有该注解
说明：实际应用较少，了解即可 :::