Android 编译时注解 —— 语法详解，kotlin从入门到项目实战

• 自定义注解 （自己实现的的注解）

元注解

---

元注解 解析说明

• @Documented 是否会保存到 Javadoc 文档中

• @Retention 保留时间，可选值， 默认为 CLASS

SOURCE（源码时），CLASS（编译时），RUNTIME（运行时）

• @Target 可以用来修饰哪些程序元素，如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等，未标注则表示可修饰所有

ANONOTATION_TYPE(注解类型声明），

PACKAGE（包）

TYPE （类，包括enum及接口，注解类型）

METHOD （方法）

CONSTRUCTOR （构造方法）

FIFLD （成员变量）

PARAMATER （参数）

LOCAL_VARIABLE （局部 变量）

• @Inherited 是否可以被继承，默认为 false

需要注意的是注解是不可以继承的，@Inherited 的意思是 假如我们把注解应用到 A 类中，B 类继承 A ，那么 B 可以扫描到 A 的注解。

注解的继承”（依赖倒置？）

这里讲的继承并不是通过@Inherited修饰的注解。

这个“继承”是一个注解的使用技巧，使用上的感觉类似于依赖倒置，来自于ButterKnife源码。

先看代码。

@Target(METHOD)

@Retention(CLASS)

@ListenerClass(

targetType = “android.view.View”,

setter = “setOnClickListener”,

type = “butterknife.internal.DebouncingOnClickListener”,

method = @ListenerMethod(

name = “doClick”,

parameters = “android.view.View”

)

)

public @interface OnClick {

/** View IDs to which the method will be bound. */

int[] value() default { View.NO_ID };

}

这是ButterKnife的OnClick 注解。特殊的地方在于@OnClick修饰了注解@ListenerClass，并且设置了一些只属于@OnClick的属性。

那这样的作用是什么呢？

凡是修饰了@OnClick的地方，也就自动修饰了@ListenerClass。类似于@OnClick是@ListenerClass的子类。而ButterKnife有很多的监听注解@OnItemClick、@OnLongClick等等。

这样在做代码生成时，不需要再单独考虑每一个监听注解，只需要处理@ListenerClass就OK。如 @interface OnItemClick 等。

@Target(METHOD)

@Retention(CLASS)

@ListenerClass(

targetType = “android.widget.AdapterView<?>”,

setter = “setOnItemClickListener”,

type = “android.widget.AdapterView.OnItemClickListener”,

method = @ListenerMethod(

name = “onItemClick”,

parameters = {

“android.widget.AdapterView<?>”,

“android.view.View”,

“int”,

“long”

}

)

)

public @interface OnItemClick {

/** View IDs to which the method will be bound. */

@IdRes int[] value() default { View.NO_ID };

}

---

自定义注解

---

一个简单的自定义注解例子

@Documented()

// 表示是基于编译时注解的

@Retention(RetentionPolicy.CLASS)

// 表示可以作用于成员变量，类、接口

@Target({ElementType.FIELD, ElementType.TYPE})

public @interface Seriable {

}

指定默认值

@Documented()

// 表示是基于编译时注解的

@Retention(RetentionPolicy.CLASS)

// 表示可以作用于成员变量，类、接口

@Target({ElementType.FIELD, ElementType.TYPE})

public @interface Seriable {

int id();

String name() default “test”;

}

//使用

@Seriable(id = 1) //name有默认值可以不写

class Test{

}

关于怎样自定义一个注解，可以参看这一篇博客，Android 自定义编译时注解1 - 简单的例子

---

处理器类Processor编写

---

自定义注解后，需要编写Processor类处理注解。Processor 继承自 AbstractProcessor 的类。我们主要需要处理以下连个方法。

• public Set getSupportedAnnotationTypes()

• public abstract boolean process(Set<? extends TypeElement >annotations，RoundEnvironment roundEnv);

getSupportedAnnotationTypes 方法

重写 getSupportedAnnotationTypes 方法：告知Processor哪些注解需要处理。返回一个Set集合，集合内容为 自定义注解的包名+类名。

建议项目中这样编写：

@Override

public Set getSupportedAnnotationTypes() {

Set types = new LinkedHashSet<>();

//需要全类名

types.add(Seriable.class.getCanonicalName());

types.add(Println.class.getCanonicalName());

return types

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

浏览器打开：qq.cn.hn/FTe 免费领取

;

}

另外如果注解数量很少的话，可以通过另一种方式实现：

//在只有一到两个注解需要处理时，可以这样编写：

@SupportedAnnotationTypes({“com.example.Seriable”})

@SupportedSourceVersion(SourceVersion.RELEASE_7)

public class JsonProcessor extends AbstractProcessor {

}

process 方法

process 方法，这个方法是所有方法中最关键的一个方法，他用来处理注解的相关信息，比如提取注解的信息，存进 map 集合或者生成代码等。

@Override

public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {

return false;

}

public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {

// 第一步，根据我们自定义的注解拿到 elememts set 集合

Set<? extends Element> elememts = roundEnv.getElementsAnnotatedWith(Seriable.class);

TypeElement typeElement;

VariableElement variableElement;

// 第二步： 根据 element 的类型做相应的处理，并存进 map 集合

for (Element element : elememts) {

ElementKind kind = element.getKind();

// 判断该元素是否为类

if (kind == ElementKind.CLASS) {

typeElement = (TypeElement) element;

// 判断该元素是否为成员变量

} else if (kind == ElementKind.FIELD) {