Java注解

Java注解

注解实际就是一种元数据 为程序元素设置元数据 并且可以对程序执行没有影响。

元数据

描述数据的数据 元数据可以为程序元素(如方法、类等)上添加额外信息。元数据作用大概可以分为三类：

1. 编写文档：通过代码里标识的元数据生成文档 比如Javadoc
2. 代码分析：通过代码里标识的元数据对代码进行分析 比如利用反射获取代码中的元数据
3. 编译检查：通过代码里标识的元数据可以让编译器实现编译检查 比如Java提供的一些注解SuppressWarnings

Annotation类型

根据使用方法和用途注解可以分为三类：

1. 元注解
2. 系统内置注解
3. 自定义注解

元注解

元注解是注解其他注解的注解。目前Java有5个元注解，他们是：

• Retention

描述注解被保留的时间长短，有三个取值分别是：RetentionPolicy.SOURCE（注解仅存在于源码中）、RetentionPolicy.CLASS（ 默认的保留策略，注解会在class字节码文件中存在）、RetentionPolicy.RUNTIME（在运行时可以通过反射获取到）

如果我们想要通过反射获取注解那么应该使用RetentionPolicy.RUNTIME。

• Target

  描述注解作用的对象范围。

  @Target(ElementType.TYPE) 作用接口、类、枚举、注解
  @Target(ElementType.FIELD) 作用属性字段、枚举的常量
  @Target(ElementType.METHOD) 作用方法
  @Target(ElementType.PARAMETER) 作用方法参数
  @Target(ElementType.CONSTRUCTOR) 作用构造函数
  @Target(ElementType.LOCAL_VARIABLE)作用局部变量
  @Target(ElementType.ANNOTATION_TYPE)作用于注解（@Retention注解中就使用该属性）
  @Target(ElementType.PACKAGE) 作用于包
  @Target(ElementType.TYPE_PARAMETER) 作用于类型泛型，即泛型方法、泛型类、泛型接口 （jdk1.8加入）
  @Target(ElementType.TYPE_USE) 类型使用.可以用于标注任意类型除了 class （jdk1.8加入）

• Documented

作用是能够将注解中的元素包含到 Javadoc 中去。

• Inherited

一个被@Inherited注解了的注解修饰了一个父类，如果他的子类没有被其他注解修饰，则它的子类也继承了父类的注解。

• Repeatable

表示注解可以同时作用一个对象多次，但是每次作用注解又可以代表不同的含义。

系统内置注解

• SuppressWarnings
  告知编译器忽略特定的异常信息 仅保留在源文件中
• Deprecated
  表示该程序元素已过时 用于除注解类型声明之外的所有元素，保留时长为运行时。
• FunctionalInterface
  Java 8 开始支持，标识一个匿名函数或函数式接口。 保留时长为运行时
• override
  覆写父类方法 仅在源文件中保留

Android提供了众多注解比如@Keep、@NonNull、@Nullable、@StringRes等等

自定义注解

可以使用 @interface 自定义注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是 基本类型、Class、String、enum）。可以通过 default 来声明参数的默认值。

注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。

注解应用

• Apt 注解处理器，用来在编译期扫描和处理注解，通过注解来生成 Java 文件
• 插桩，编译后处理筛选
• 运行时注解 反射获取注解

一小时搞明白自定义注解(Annotation)

教你实现一个轻量级的注解处理器（APT）

注解(Annotation)-Android讲解

详尽的Android编译时注解处理器教程

Android中注解的一些总结

字节码插桩--你也可以轻松掌握

Android 自定义注解处理器并生成 json 文件