我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版，欢迎购买。点击进入详情

介绍

Annotation，又叫注解，是附加在代码上的元信息（用于标记属性）。
Annotation适用于IDE工具在编译、运行时对其解析和使用，起到配置的作用。
我们最常见的Annotation：

@Override
    public void onCreate() {
        super.onCreate();
    }

Override表明这个方法是一个重写的方法，需要IDE协助检查这个方法是否是父类的方法，如果不是则会报错提醒。如果不加Override，这个方法名不是父类的话，IDE也不会报错提醒。

从上面Override的例子我们可以看到，annotation更像是一个标签，它不仅仅可以附着在方法上面，还可以在包、类、字段、方法的参数、局部变量等上面进行标记。

自定义注解

还是用Override这个注解为例，我们看下源码：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

这里要提到元注解的概念。什么是元注解？元注解就是注解上的注解，也就是注解上的标签。比如我们在自定义注解的时候，@Target、@Retention这些都是元注解。
那元注解有什么用的呢？我看不妨来看一下元注解的作用：
@Retention：注解生命周期范围。
@Target：注解对象的作用范围。
@Inherited：@Inherited标明子类是否可以继承该父类的注解。
@Documented：javadoc工具的文档化。

@Retention的值：
@Retention(RetentionPolicy.SOURCE) ：注释仅存在源码中，class文件中不包含；
@Retention(RetentionPolicy.CLASS)：默认策略，class文件中包含，运行时遗弃；
@Retention(RetentionPolicy.RUNTIME)：class文件包含，运行时通过反射也可以获得；

@Target有很多值，就像上面提到的，注释不仅可以用在方法上，也可以用在包、类、字段等等其它上面。像@Override的@Target(ElementType.METHOD)标明注解的作用范围是方法。

注解的应用：反射

通过反射获取注解是一个很常用的方法，但是需要注意的是，如果通过反射获取Annotation，那么这个Annotation的@Retention策略需要是RUNTIME的。这样就导致了反射获取注解应用范围有限。
定义一个@ByString的注解：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ByString {
    int value();
}

在源码中标记这个注解：

@ByString(R.string.annotation_reflection)
    private String text;

通过反射获取field：

Field[] fields = clazz.getDeclaredFields();
if (fields != null) {
    for (Field field : fields) {
	...
		}
}

找到这个注解：

ByString stringById = field.getAnnotation(ByString.class);
        if (stringById != null) {
            int stringId = stringById.value();
}

最后通过field的set方法进行赋值。

注解的应用：APT

APT(Annotation Processing Tool)，它可以对源码进行扫描检测，找出其中的Annotation，并且自动生成相应的代码，并且将这些代码保存在额外的文件中(.class文件)，最终这些.class文件一并参与apk的编译。
一个完整的APT包含：
1、AbstractProcessor：注解处理器，这是一个抽象类，一般需要自己实现一个。

public class TagBinderProcessor extends AbstractProcessor { ...}

2、处理器注册（AutoService）：

@AutoService(Processor.class)
public class TagBinderProcessor extends AbstractProcessor { ...}

我们自定义了一个叫TagBinderProcessor的注解处理器，需要通过@AutoService注册一下。
3、代码自动生成（javaPoet）
根据注解，我们需要生成代码。而 JavaPoet 就是用来生成 Java 代码的一个 Java Library。
使用的时候需要引入：

implementation ‘com.squareup:javapoet:1.10.0’

我们看一段JavaPoet用法：

class AnnotatedClass {

    private ArrayList<BindTagField> mFields;

    AnnotatedClass() {
        mFields = new ArrayList<>();
    }

    void addField(BindTagField field) {
        mFields.add(field);
    }

    JavaFile generateFile() {
        //方法参数类型
        ParameterizedTypeName parameterizedTypeName = ParameterizedTypeName.get(
                ClassName.get(Map.class),
                ClassName.get(String.class),
                ClassName.get(TagInfo.class));
        ParameterSpec params = ParameterSpec.builder(parameterizedTypeName, "params").build();

        MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder("load")
                .addModifiers(Modifier.PUBLIC)
                .addAnnotation(Override.class)
                .addParameter(params);

        for (BindTagField item : mFields) {
            String key = item.getTypeName().toString();
            TagInfo.Type type = item.getType();
            String[] value = item.getTag();
            String description = item.getDescription();
            // 添加方法内容
            methodBuilder.addStatement("params.put($S,$T.build($T.$L,$S,$S,$S))",
                    key,
                    ClassName.get(TagInfo.class),
                    ClassName.get(TagInfo.Type.class),
                    type,
                    key,
                    Arrays.toString(value),
                    description);
        }
        //生成类
        TypeSpec finderClass = TypeSpec.classBuilder("TagService")
                .addSuperinterface(ClassName.get("com.androidwind.annotation.core", "ILoad"))
                .addModifiers(Modifier.PUBLIC)
                .addMethod(methodBuilder.build())
                .build();

        return JavaFile.builder("com.androidwind.annotation", finderClass).build();
    }
}

Ctrl+B，项目Build一下，看见在如下目录下有一个TagService文件生成：

打开看一下里面的内容：

public class TagService implements ILoad {
  @Override
  public void load(Map<String, TagInfo> params) {
    params.put("la.xiong.androidquick.demo.features.architecture.mvc.MVCActivity",TagInfo.build(TagInfo.Type.ACTIVITY,"la.xiong.androidquick.demo.features.architecture.mvc.MVCActivity","[MVC]","Activity + MVC实例"));
    params.put("la.xiong.androidquick.demo.features.architecture.mvp.activity.MVPActivity",TagInfo.build(TagInfo.Type.ACTIVITY,"la.xiong.androidquick.demo.features.architecture.mvp.activity.MVPActivity","[MVP]","Activity + MVP实例"));
}
}

这个就是通过JavaPoet生成的代码内容。

其它

除了上面提到注解的应用，其实注解在很多场景下都能看到它的身影，比如AOP（面向切面编程），后续会有专门的文章来介绍这个。