注解的定义
Java注解又称Java标注，是JDK5.0引入的一种注释机制。注解是原数据的一种机制，提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有任何影响。
注解声明
public @interface Extra {
}
这样就声明了一个注解。与声明接口很相似，只不过是在 interface 前面加了个 @ 符号。Java中所有的注解都默认实现 Annotation 接口:
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
元注解
上面我们只是简单的声明了一个注解，可以使用，但是没有任何意义。若想让注解产生作用我们还需要了解什么元注解——
可以对注解类进行注解的注解称为元注解。
1 @Target
Target的中文意思有目标，目的的意思。那么这个元注解的作用就是限定注解作用在什么目标上。其中有一个枚举类 ElementType 限定了可选的目标类型：
- ElementType.TYPE：限定注解可以作用于类或接口、枚举
- ElementType.FIELD：限定注解可以作用于属性
- ElementType.METHOD：限定注解可以作用于方法
- ElementType.PARAMETER：限定注解可以作用于方法参数
- ElementType.CONSTRUCTOR：限定注解可以作用于构造方法
- ElementType.LOCAL_VARIABLE：限定注解可以作用于本地变量
- ElementType.ANNOTATION_TYPE：限定注解可以作用于注解，即自定义元注解
- ElementType.PACKAGE：限定注解可以作用于包
- ElementType.TYPE_PARAMETER：限定注解可以作用于类型参数，即作用于泛型上
- ElementType.TYPE_USE：限定注解可以作用于类型变量，即作用在使用泛型时
@Target(ElementType.FIELD)
public @interface Extra {
}
现在我们的注解就被限定只能作用在属性上了。上面的枚举类型是可以多个使用的，中间是用逗号分开即可：
@Target({ElementType.FIELD,ElementType.CONSTRUCTOR,ElementType.TYPE_PARAMETER})
现在注解就可以作用在属性，构造方法以及泛型上了：
2 @Retention
Retention有保留期的意思，也就是说这个元注解定义了我们的注解的存活时间或者说生命周期。与之相关的也有一个枚举类RetentionPolicy定义了可选的保留时期：
- RetentionPolicy.SOURCE：保留在源码阶段，也就是保留在我们写代码的时候。当编译之后会被编译器忽略
- RetentionPolicy.CLASS：注解由编译器保留，但是会被JVM忽略
- RetentionPolicy.RUNTIME：注解由JVM保留，也就是程序在运行的时候可以使用
总结下来就是注解的生命周期符合RUNTIME > CLASS > SOURCE，也就是RUNTIME包含CLASS和SOURCE，CLASS包含SOURCE。那么我们到底该怎么选择保留策略呢？每种策略又有什么样的应用场景呢？
SOURCE级别：一般在使用APT技术的时候会使用SOURCE级别。一些常用的框架例如ButterKnife、ARouter等都使用了APT技术，虽然这些框架有的可能使用的是CLASS级别，但是如果只需要在编译期生成一些辅助类的话SOURCE是绝对够用的。另外还有IDE语法检查,例如@IntDef。它的源码如下：
@Retention(SOURCE) // 源码级别
@Target({ANNOTATION_TYPE})
public @interface IntDef {
int[] value() default {};
boolean flag() default false;
boolean open() default false;
}
例如我们经常这样来定义方法来限定传入的参数：
enum Season{
SPRING,
SUMMER,
AUTUMN,
WINTER
}
public void setSeason(Season season){ }
可是一个枚举就是一个单例对象，一个对象的大小最少是12个字节加上自身的属性的大小，所以为了节省内存，我们有时会这样定义：
public static final int SPRING = 1;
public static final int SUMMER = 2;
public static final int AUTUMN = 3;
public static final int WINTER = 4;
public void setSeason(int season){ }
可是这样定义的时候如果不按照事先约定好的方式传入又会失去其意义，所以我们就可以使用@IntDef来进行规范：
@IntDef(value = {SPRING, SUMMER, AUTUMN, WINTER})
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.SOURCE)
@interface Season {
}
public void setSeason(@Season int season) { }
这样我们就只能按照注解的约束来使用，即使传入的值 1 就是定义的 SPRING 常量也不可以。
CLASS级别：一般应用于字节码增强技术，说白了就是在字节码中写代码。例如字节码插桩。我们都知道我们编写的java文件经过编译之后会生成class文件，那么CLASS级别的注解就能够用于通过修改Class数据来实现修改代码逻辑的目的。
RUNTIME级别：这个级别的注解一般是和反射结合使用。也就是在程序运行期间通过反射技术动态获取注解及其元素，从而完成不同的逻辑判定。下面使用一个小的例子来展示一下运行时期怎么使用反射加上注解来完成findViewById.
@Target(ElementType.FIELD) // 定义注解作用在属性上
@Retention(RetentionPolicy.RUNTIME) // 定义注解的保留时期为运行时
public @interface BindView {
int id() default -1; // 注解中的值
}
定义一个工具类：
public class InjectUtil {
public static void inject(Activity activity) {
injectView(activity);
}
private static void injectView(Activity activity) {
// 获取Activity的class对象
Class<? extends Activity> clz = activity.getClass();
// 获取Activity中声明的所有属性
Field[] declaredFields = clz.getDeclaredFields();
for (Field field : declaredFields) {
// 判断属性上是否使用了BindView注解
if (field.isAnnotationPresent(BindView.class)) {
// 拿到注解
BindView bindView = field.getAnnotation(BindView.class);
if (bindView != null) {
// 如果是private修饰的要打开访问权限
field.setAccessible(true);
// 获得id
int id = bindView.id();
// 根据id找到对应的view
View view = activity.findViewById(id);
// 赋值
setValue(activity, field, view);
//关闭访问权限
field.setAccessible(false);
}
}
}
}
private static <T> void setValue(Activity activity, Field field,T value) {
try {
field.set(activity, value);
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
下面就是在Activity当中使用了：
public class MainActivity extends AppCompatActivity {
@BindView(id = R.id.tv) // xml布局中定义的id
private TextView textView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
InjectUtil.inject(this);
textView.setText("hello android");
}
}
运行结果
根据运行结果可知，我们成功的运用反射加上注解省去了findViewById的过程。ButterKnife早期的时候也是这样做的。
Tips：当不确定到底使用哪一种保留策略的时候，选择RUNTIME肯定是没有问题的。
3 @Documented
作用是能够将注解中的元素包含到 Javadoc 中去。默认情况下,javadoc是不包括注解的，但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理，所以注解类型信息也会被包括在生成的文档中。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";
public boolean defaultDBValue() default false;
}
4 @Inherited
Inherited是继承的意思，但是并不是说注解可以被继承，而是说如果一个类被打上这个注解，那么它的继承类也会自动被打上这个注解。
@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface InheritedTest {
String value() default "";
}
定义两个具有继承关系的类，并在父类上使用上面定义的注解：
@InheritedTest("User")
public class User{ }
public class Jack extends User{ }
下面是测试代码：
public static void main(String[] args) {
Jack jack = new Jack();
Class<? extends Jack> clz = jack.getClass();
if (clz.isAnnotationPresent(InheritedTest.class)) {
InheritedTest annotation = clz.getAnnotation(InheritedTest.class);
String value = annotation.value();
System.out.println("---------" + value);
}
}
可以看到Jack类虽然没有使用注解，但是获得了父类中注解以及注解的值。这就好比马云著名的一个标签就是富豪，那么马云的儿子也会被称为富豪的道理是一样的。
5 @Repeatable
可重复的，也就是说注解可以被多次的使用在同一个地方。还以马云为例，马云在我们普通人眼中是个富豪，在家中是孩子的父亲，在公司是公司的老总等等，在不同的场合中他有不同的身份。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface JackMa {
RepeatableTest[] value();
}
@Repeatable(value = JackMa.class)
public @interface RepeatableTest {
String role();
}
下面就可以重复使用了：
@RepeatableTest(role = "boss")
@RepeatableTest(role = "father")
@RepeatableTest(role = "teacher")
public class Jack extends User{
}
至于获取的方式和上面的Inherited一样，不再重复。
注解的值
在上面其实已经使用过注解的值了。定义也很简单：
public @interface AnnotationValue {
String value(); // 注解的值
int id() default -1; //可以在后面添加默认值
}
唯一需要注意的是如果使用 value 的话，那么在使用的时候，value不需要写出来(当然也可以写出来),如果是其他，例如上方定义的 id ，那么在使用的时候就需要显示的使用id来赋值，如：id = 1
网友评论