Android 编译时注解 —— 语法详解

@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 方法

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

建议项目中这样编写：

@Override

public Set getSupportedAnnotationTypes() {

Set types = new LinkedHashSet<>();

//需要全类名

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

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

return types;

}

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

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

@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) {

variableElement = (VariableElement) element;

}

}

return true;

}

Element

---

元素，虽有通过注解取得的元素都以 Element 等待处理,它的具体类型与我们通过 @Target 来标记的具有一定的联系。

官方的解释是这样的：

Represents a program element such as a package, class, or method.Each element represents a static, language-level construct

(and not, for example, a runtime construct of the virtual machine)

表示程序元素如包、类或者方法。每个元素代表一个静态语言级构造(例如,而不是运行时构建的虚拟机）

例如：

// 第一步，根据我们自定义的注解拿到 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) {

variableElement = (VariableElement) element;

}

}

Element 的子类

Element 的子类有：

• ExecutableElement

表示某个类或接口的方法、构造方法或初始化程序（静态或实例），包括注释类型元素。

对应@Target(ElementType.METHOD) @Target(ElementType.CONSTRUCTOR)

• PackageElement;

表示一个包程序元素。提供对有关包极其成员的信息访问。

对应@Target(ElementType.PACKAGE)

• TypeElement;

表示一个类或接口程序元素。提供对有关类型极其成员的信息访问。

对应@Target(ElementType.TYPE)

注意：枚举类型是一种类，而注解类型是一种接口。

• TypeParameterElement;

表示一般类、接口、方法或构造方法元素的类型参数。

对应@Target(ElementType.PARAMETER)

• VariableElement;

表示一个字段、enum常量、方法或构造方法参数、局部变量或异常参数。

对应 @Target(ElementType.LOCAL_VARIABLE)

判断 Element 具体属于哪一种子类

我们可以通过 element.getKind(); 来得到 Element 到底是哪一种类别，该方法返回 ElementKind 类型，我们在根据 ElementKind 即可得出 Element 到底是哪种类别。

ElementKind kind = element.getKind();

// 判断该元素是否为类

if (kind == ElementKind.CLASS) {

typeElement = (TypeElement) element;

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

variableElement = (VariableElement) element;

}

看到这里，想起前面的一篇博客 java Type 详解 ，我们需要注意 Type 与 Element 的区别。

Type 是用来处理泛型的，Element 是用来处理注解的。