一 前言
Java注解（Annotation）又称Java标注，是JDK5.0引入的一种注释机制。网上也有很多关于Java Annotation的文章，看得使人眼花缭乱，很难理解。
那么到底什么是注解，注解有什么作用，我举个栗子先，
《奇葩说》第六季已经开播了，这里面我最喜欢的辩手是陈铭，为人师表，谈吐举止得体，他那独树一帜的辩论风格，令人听了不禁十分感动，因为他那是“站在宇宙中心呼唤爱”，以至于他每次出来，“站在宇宙中心呼唤爱”就立刻出现在我的脑海里，然后继续听他的辩论，果然如此。“站在宇宙中心呼唤爱”就如同一个标签，贴在了陈铭身上。
以同样的方式理解Annotation，Annotation就如同一个标签一样，只不过它是贴在了代码上。单纯的Annotation对程序的运行并无影响，就像“站在宇宙中心呼唤爱”这个标签对于陈铭老师来说，并没有什么影响，但是“站在宇宙中心呼唤爱”可以用来解释陈铭老师，同样Annotation也是对用Annotation注解的程序的解释，不过是要借助工具，就是上一篇文章介绍的APT。
说了那么多，就是为了理解Annotation，Annotation其实也和class，interface一样，属于java的一种类型，只不过在开发中比较少见，为了理解，我们可以假想用标签来理解。
二 注解的语法
（一） 注解的定义
注解使用@interface关键字进行定义，看形式和interface差不多，但是加了一个@符号。
public @interface MyAnnotation {
}
上面的代码创建了一个MyAnnotation的注解，你可以理解为创建了一个MyAnnotation的标签，拿着这个标签，可以给其它的代码贴上次标签。
（二）注解的使用
上面创建了一个注解，但是注解怎么使用呢？
@MyAnnotation
public class MyTest {
}
上面的代码创建了一个注解，然后我们定义了一个类，叫MyTest，在类定义的地方加上@MyAnnotation，就用我们定义的注解，注解到了MyTest类中，你可以简单理解成，在MyTest类上贴了一张MyAnnotation的标签。
（三） 元注解
元注解又是什么呢？
要理解上面定义的注解，就必须要理解元注解，元注解是一种基本的注解，它是可以注解到注解上的注解。元注解主要是起对注解解释说明作用。
元注解有五种，@Retention、@Documented、@Target、@Inherited、@Repeatable 。
① @Retention
Retention意为保留的意思，注解加上@Retention表示注解的存活时间。
它的取值如下：
| 取值 | 意义 |
|---|---|
| RetentionPolicy.SOURCE | 注解只在于源码阶段保留，在编译器进行编译时它将会被丢弃 |
| RetentionPolicy.CLASS | 注解将会保留到编译阶段，但是并不会加载到JVM中 |
| RetentionPolicy.RUNTIME | 注解可以保留到程序运行的时候，它会被加载到JVM中 |
下面对我的注解加上元注解，使我们定义的注解保留到程序运行时。
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
}
② @Documented
这个元注解很简单，表示该注解是否可以生成JavaDoc，加上该注解则可以将该注解生成JavaDoc。
③ @Target
Target意为目标的意思，@Target指定了注解运用的地方，即注解的作用域。
@Target的作用域如下所示：
| 取值 | 作用域 |
|---|---|
| ElementType.TYPE | 给一个类型进行注解，比如类、接口、枚举 |
| ElementType.FIELD | 可以给一个属性进行注解 |
| ElementType.METHOD | 可以给方法进行注解 |
| ElementType.PARAMETER | 可以对一个方法内的参数添加注解 |
| ElementType.CONSTRUCTO | 可以对构造函数添加注解 |
| ElementType.LOCAL_VARIABLE | 可以对局部变量添加注解 |
| ElementType.ANNOTATION_TYPE | 可以对一个注解进行注解 |
| ElementType.PACKAGE | 可以对一个包进行注解 |
＠Target也可以接受一个数组作为参数，设置多个多个注解的作用域。
下面对我们定义的注解加上＠Target元注解，使我们定义的注解可以注解到属性和方法上。
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.METHOD})
public @interface MyAnnotation {
}
④ @Inherited
Inherited意为继承的意思，默认是false，它并不是说注解本身可以继承，而是说如果一个类，被一个有@Inherited的注解注解过，如果它的子类没有被任何注解注解，那么它的子类就继承了它的注解。说起来比较模糊，show me the code!
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.TYPE}
@Inherited
public @interface MyAnnotation {
}
@MyAnnotation
public class MyTest {
}
public class MyTestChild extends MyTest{
}
注解MyAnnotation被@Inherited元注解注解了，
类 MyTest，使用MyAnnotation进行注解，
MyTestChild继承MyTest，并没有任何注解，MyTestChild也拥有了MyAnnotation注解。
（四） 注解的属性
注解的属性，也叫注解的成员变量，注解中只有成员变量，没有方法。
注解的成员变量在注解的定义中，以 无形参的方法 形式声明，方法名就是该成员变量的名字，返回值定义了该成员变量的类型。
下面的注解定义了两个成员变量，分别是int类型的id，和String类型的name。
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Inherited
public @interface MyAnnotation {
int id();
String name();
}
在使用我们自定义的注解时，我们应该对属性进行赋值，赋值的时候，在括号内以value=“”的形式赋值，多个属性用 , 间隔开。
@MyAnnotation(id=1,name="jack")
public class MyTest {
}
定义注解属性的时候，可以有默认值，默认值用default关键字指定。
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Inherited
public @interface MyAnnotation {
int id();
String name() default "frank";
}
（五） Java内置的注解
上面我们自定义了注解，java本身已经提供了一些注解，
- 1 @Override ，这个注解最熟悉了，提示子类中要复写父类中被@Override修饰的方法。
- 2 @Deprecated，用来标记过时的元素，比如过时的方法，过时的类，过时的成员变量等。
- 3 @SuppressWarnings，阻止警告。
- 4 @SafeVarargs，参数安全类型注解。
- 5 @FunctionalInterface，函数式接口注解，函数式接口就是只有一个方法的接口。
三 注解的提取
上面讲了注解的定义和使用，我们在MyTest类加上了我们定义的注解MyAnnotation，
@MyAnnotation(id=1,name="jack")
public class MyTest {
}
那么加上这个注解以后，怎么提取注解的内容呢？
要正确提取注解，需要反射。
注解和反射
注解通过反射获取。
- 1 通过Class对象的isAnnotationPresent()方法判断它是否应用了某个注解。
public boolean isAnnotationPresent(@RecentlyNonNull Class<? extends Annotation> annotationClass) {
throw new RuntimeException("Stub!");
}
- 2 通过getAnnotation()方法来获取Annotation对象。
@Nullable
public <A extends Annotation> A getAnnotation(@NonNull Class<A> annotationClass) {
throw new RuntimeException("Stub!");
}
现在我们来获取MyTest上的注解。
@MyAnnotation(id=1,name="jack")
public class MyTest {
public static void main(String[] args){
boolean hasAnnotation=MyTest.class.isAnnotationPresent(MyAnnotation.class);
if (hasAnnotation){
MyAnnotation myAnnotation=MyTest.class.getAnnotation(MyAnnotation.class);
System.out.println("id=="+myAnnotation.id());
System.out.println("name=="+myAnnotation.name());
}
}
}
运行结果：
四 注解的使用场景
注解在一下三种时机发挥作用：
- 1 程序开发时，在开发程序时，经常用到@Override @Nullable等注解，这些注解和IDE共同作用是提示代码编写过程中的错误，这些注解在编译阶段被编译器丢弃，在class文件中不会出现.
- 2 程序编译时，软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
- 3 程序运行时，当程序运行的时候，我们希望通过获取标注的注解执行不同的逻辑，如EventBus使用不同线程发送消息。
注解并不是代码的一部分，当开发者使用了Annotation注解以后，这些Annotation不会自己生效，必须由开发者提供相应的代码来提取并处理这些Annotation信息。
这些处理Annotation信息的代码，我们统称为APT（Annotation Processing Tool）。想了解APT的可以看下这篇文章。
下一篇文章自己写个注解处理器
通过写一个简单的注解处理器来再次理解注解。
网友评论