☕ Java注解-笔记

什么是注解

注解（Annotation）是放在Java源码的类、方法、字段、参数前的一种特殊”注释“。

注释会被编译器直接忽略，注解则可以被编译器打包进入class文件，因此，注解是一种用作标注的“元数据”，一种接口类型。

注解的作用

1. 生成帮助文档。常用有

   @see、@param、 @return

2. 跟踪代码依赖性，实现替代配置文件功能。（常见的是 Spring 2.5 开始的基于注解配置，作用就是减少配置。）
3. 在编译时进行格式检查。

常用注解

• @Override

  ：用来指定方法重写的，只能修饰方法并且只能用于方法重写，不能修饰其它的元素。

• @Deprecated

  ：用来注解类、接口、成员方法和成员变量等，用于表示某个元素（类、方法等）已过时。当其他程序使用已过时的元素时，编译器将会给出警告。
  

  Java 9 为 @Deprecated 注解增加了以下两个属性：

  forRemoval

  ：该 boolean 类型的属性指定该 API 在将来是否会被删除。

• since

  ：该 String 类型的属性指定该 API 从哪个版本被标记为过时。

  public class DeprecatedTest {
  public static void main(String[] args) {
  new Test().print();
  }
  }
  class Test {
  @Deprecated(since="6", forRemoval=true)
  public void print() {
  System.out.println("啊对对对");
  }
  }

@SuppressWarnings

：被该注解修饰的程序元素（及其所有子元素）取消显示指定的编译器警告，且会一直作用于该程序元素的所有子元素。

注解的使用有以下三种：抑制警告关键字

抑制单类型的警告：

@SuppressWarnings("unchecked")

1. 抑制多类型的警告：

   @SuppressWarnings("unchecked","rawtypes")

2. 抑制所有类型的警告：

   @SuppressWarnings("unchecked")

使用

@SuppressWarnings({ "deprecation" })

注解了HelloWorld.java 的 main 方法：

程序代码的警告没有了

@SafeVarargs

定义注解

public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}
// 注解的参数类似无参数方法

元注解

元注解（meta annotation），负责对其它注解进行说明的注解，自定义注解时可以使用元注解。

• @Target

  ：最常用的元注解

  使用

  @Target

  可以定义

  Annotation

  能够被应用于源码的哪些位置：
  类或接口：

  ElementType.TYPE

  ；
• 字段：

  ElementType.FIELD

  ；
• 方法：

  ElementType.METHOD

  ；
• 构造方法：

  ElementType.CONSTRUCTOR

  ；
• 方法参数：

  ElementType.PARAMETER

  。

// 定义注解@Report用在方法上
@Target(ElementType.METHOD)
public @interface Report {
int type() default 0;
...
}

// 定义注解@Report可用在方法或字段上
@Target({
ElementType.METHOD,
ElementType.FIELD
})
public @interface Report {
...
}

@Retention

@Retention

java.lang.annotation.RetentionPolicy

RetentionPolicy

RetentionPolicy.CLASS

@Retention

Annotation

CLASS

Annotation

RUNTIME

@Retention(RetentionPolicy.RUNTIME)

@Inherited

// 3. 用元注解配置注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {  // 1. 用@interface定义注解
// 2. 添加参数、默认值
int type() default 0;
String level() default "info";
String value() default "";
}