image
一、经常看到代码片段中有一些这样的标识:为什么要这么使用,这样使用的好处在哪。
@BindView(R.id.btn),@OnClick({R.id.image}),@Override等等还有很多就不一一列举。
二、关键字:
元注解,注解类型元素,@IntDef、APT
三、为什么要使用注解:
在处理代码时想定位到某个元素并对之做处理,就可以给它打个标记,然后再写处理它的逻辑。
四、注解的掌握要点:
注解声明
Java中所有的注解,默认实现 Annotation 接口:
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode(); String toString();
Class<? extends Annotation> annotationType();
}
与声明一个"Class"不同的是,注解的声明使用 @interface 关键字。一个注解的声明如下:
public @interface potato { }
元注解
在定义注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类,我们称之为 metaannotation(元注解)。一般的,我们在定义自定义注解时,需要指定的元注解有两个 :
1、@Target
注解标记另一个注解,以限制可以应用注解的 Java 元素类型。目标注解指定以下元素类型之一作为其值:
(1)ElementType.ANNOTATION_TYPE 可以应用于注解类型。
(2)ElementType.CONSTRUCTOR 可以应用于构造函数。
(3)ElementType.FIELD 可以应用于字段或属性。
(4)ElementType.LOCAL_VARIABLE 可以应用于局部变量。
(5)ElementType.METHOD 可以应用于方法级注解。
(6)ElementType.PACKAGE 可以应用于包声明。
(7)ElementType.PARAMETER 可以应用于方法的参数。
(8)ElementType.TYPE 可以应用于类的任何元素。
2、@Retention
注解指定标记注解的存储方式:
(1)RetentionPolicy.SOURCE - 标记的注解仅保留在源级别中,并被编译器忽略。
(2)RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留,但 Java 虚拟机(JVM)会忽略。
(3)RetentionPolicy.RUNTIME - 标记的注解由 JVM 保留,因此运行时环境可以使用它。
@Retention 三个值中 SOURCE < CLASS < RUNTIME,即CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。下文会介绍他们不同的应用场景。
说了这么多概念看看具体怎么使用的:
@Target({ElementType.FIELD, ElementType.PARAMETER})//用于局部变量和方法参数使用
@Retention(RetentionPolicy.SOURCE)//标记的注解仅保留在源级别中,并被编译器忽略
public @interface potato {
}
注解类型元素
在上文元注解中,允许在使用注解时传递参数。我们也能让自定义注解的主体包含 annotation type element (注解 类型元素) 声明,它们看起来很像方法,可以定义可选的默认值。
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.SOURCE)
public @interface potato {
String value(); //无默认值
int age() default 1; //有默认值
}
注意:在使用注解时,如果定义的注解中的类型元素无默认值,则必须进行传值。
@potato ("帅") //如果只存在value元素需要传值的情况,则可以省略:元素名=
@potato (value="帅",age = 18)
int i;
APT注解处理器
APT全称为:"Anotation Processor Tools",意为注解处理器。顾名思义,其用于处理注解。编写好的Java源文件,需要经过 javac 的编译,翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工具,用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。 注册的注解处理器由 javac调起,并将注解信息传递给注解处理器进行处理。
注解处理器是对注解应用最为广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARouter等等常用框架中都有注解处理器的身影。但是你可能会发现,这些框架中对注解的定义并不是 SOURCE 级别,更多的是 CLASS 级别,别忘了:CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。
(1)、CLASS
定义为 CLASS 的注解,会保留在class文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作。如:AspectJ、热修复Roubust中应用此场景。所谓字节码操作即为,直接修改字节码Class文件以达到修改代码执行逻辑的目的。
(2)、RUNTIME
注解保留至运行期,意味着我们能够在运行期间结合反射技术获取注解中的所有信息。
(3)、SOURCE
RetentionPolicy.SOURCE ,作用于源码级别的注解,可提供给IDE语法检查、APT等场景使用
@Cat
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
InitViewUtils.initView(this);
}
}
在类中使用 SOURCE 级别的注解,其编译之后的class中会被丢弃。
网友评论