Android注解协议,Android 注解

本文是对网络中相关文章的总结，再加上自己的相关见解得出的，若有侵权请及时联系

学习博客链接：

Java 注解(Annotation)

元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。元注解分以下5类：

@Retention - 标识这个注解怎么保存

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。

Retention的取值如下：

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视

RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中

RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

每一个Annotation对象，都会有唯一的RetentionPolicy属性。

@Documented - 标记这些注解是否包含在用户文档中。

顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target - 标记这个注解应该是哪种 Java 成员。

Target 是目标的意思，@Target 指定了注解运用的地方。

你可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

@Target 有下面的取值：

ElementType.ANNOTATION_TYPE 可以给一个注解进行注解

ElementType.CONSTRUCTOR 可以给构造方法进行注解

ElementType.FIELD 可以给属性进行注解

ElementType.LOCAL_VARIABLE 可以给局部变量进行注解

ElementType.METHOD 可以给方法进行注解

ElementType.PACKAGE 可以给一个包进行注解

ElementType.PARAMETER 可以给一个方法内的参数进行注解

ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

对于每 1 个 Annotation 对象，可以有若干个 ElementType 属性

@Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何父类)

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类(是一个类，不是注解)被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

子类可以拥有父类被标明了@Inherited的注解

@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性(所以有些地方说元注解只有4个，其实往后还有添加新的)

被标明了@Repeatable的注解可以重复使用，多次修饰一个注解

内置的注解

@Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。

@Deprecated - 标记过时方法。如果使用该方法，会报编译警告。

@SuppressWarnings - 指示编译器去忽略注解中声明的警告，他的相关参数(也就是下面说到的注解的属性)如下：(使用形式如下：@SuppressWarnings(value={"deprecation"}))

deprecation -- 使用了不赞成使用的类或方法时的警告

unchecked -- 执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型。

fallthrough -- 当 Switch 程序块直接通往下一种情况而没有 Break 时的警告。

path -- 在类路径、源文件路径等中有不存在的路径时的警告。

serial -- 当在可序列化的类上缺少 serialVersionUID 定义时的警告。

finally -- 任何 finally 子句不能正常完成时的警告。

all -- 关于以上所有情况的警告。

@SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

@FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。

注解的基本语法

annotation通用定义

@Documented

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface MyAnnotation1 {

}

@interface ---> 注解的定义关键字

使用 @interface 定义注解时，意味着它实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。

定义 Annotation 时，@interface 是必须的。

注意：它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后，该注解不能继承其他的注解或接口。

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

实例分析：

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestAnnotation {

int id();

String msg();

}

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。

赋值的方式是在注解的括号内以 value=”” 形式，多个属性之前用 ，隔开。

@TestAnnotation(id=3,msg="hello annotation")

public class Test {}

需要注意的是，在注解中定义属性时它的类型必须是 8 种基本数据类型 外加 类、接口、注解及它们的数组。

注解中属性可以有默认值，默认值需要用 default 关键值指定。比如：

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestAnnotation {

public int id() default -1;

public String msg() default "Hi";

}

另外，还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接属性值填写到括号内。如：@Check("hi")

注解与反射

注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解：

public boolean isAnnotationPresent(Class extends Annotation> annotationClass) {}

然后通过 getAnnotation() 方法来获取 Annotation 对象：

public A getAnnotation(Class annotationClass) {}

或者是 getAnnotations() 方法：

public Annotation[] getAnnotations() {}

以上方法的使用场景：

编写AOP的时候，获取注解中的具体参数

注解的作用

注解有许多用处，主要如下：

提供信息给编译器：编译器可以利用注解来探测错误和警告信息

编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。

运行时的处理： 某些注解可以在程序运行的时候接受代码的提取

值得注意的是，注解不是代码本身的一部分。

Android - AOP