android自定义注解之Element详解

基本介绍

element指的是一系列与之相关的接口集合，用于建模java编程语言元素的接口，它们位于javax.lang.model.element包下面

element是代表程序的一个元素，这个元素可以是：包、类/接口、属性变量、方法/方法形参、泛型参数。element是java-apt(编译时注解处理器)技术的基础，因此如果要编写此类框架，熟悉element是必须的。

Element及其子接口

各种element所代表的元素类型，如下图

Element接口族与Type接口族区别

Element所代表的元素只在编译期可见，用于保存元素在编译期的各种状态，而Type所代表的元素是运行期可见，用于保存元素在运行期的各种状态。

简单例子

要在编译期得到工程的Element信息，我们需要采用apt技术(以Android开发为例，在Android studio中)

1.创建注解

在单独的一个java module中创建注解

//注解的声明周期声明为source，意即只在编译源文件的过程中有效
@Retention(RetentionPolicy.SOURCE)
//通常一个注解只注释类，方法，或者变量，这样可以使结构更清晰。
//这里为了演示不同的element，把这个注解的使用对象定义为类，变量，参数，方法
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.PARAMETER,ElementType.METHOD})
public @interface AAAA {
    String value();
}

2.在目标类中使用注解(主app-module)

@AAAA("this is class")
public class Test<T> {
    @AAAA("this is a field")
    String hello;
    @AAAA("this is a method")
    public String say( @AAAA("this is a parameter")String value){
        return "hello world";
    }
}

3.创建处理器Processor(单独的一个java-module)

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //依赖包
    implementation 'com.google.auto:auto-common:0.10'
    implementation 'com.google.auto.service:auto-service:1.0-rc4'
    implementation 'com.squareup:javapoet:1.11.1'
}

@AutoService(Processor.class)
public class TestProcessor extends AbstractProcessor {
    /**
     * 可用于编译时，信息打印
     */
    private Logger mLogger;
    /**
     * 用于{@link Element}处理的工具类
     */
    private Elements mElementUtils;
    /**
     * 用于文件创建
     */
    private Filer mFiler;
    /**
     * 用来处理TypeMirror的工具类；
     */
    private Types mTypeUtils;
    Messager messager;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        mTypeUtils = processingEnv.getTypeUtils();
        mLogger = new Logger(processingEnvironment.getMessager());
        mElementUtils = processingEnvironment.getElementUtils();
        mFiler = processingEnvironment.getFiler();
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {

        if (set != null && !set.isEmpty()) {
            //扫描整个工程,找出含有AAAAA注解的元素
            Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith(AAAA.class);
            for (Element element : elements) {
                //获取element元素上的注解
                AAAA aaaa = element.getAnnotation(AAAA.class);
                //类、接口、注解

                if (element instanceof TypeElement) {

                    mLogger.info("****************************TypeElement*****************************");
                    //打印包信息
                    PackageElement packageElement = mElementUtils.getPackageOf(element);
                    mLogger.info("=======================print package info======================");
                    //简单包名
                    mLogger.info("...........getSimpleName()............" + packageElement.getSimpleName().toString() + ".......................");
                    //返回此包的完全限定名称。
                    mLogger.info("............getQualifiedName()..........." + packageElement.getQualifiedName() + ".......................");
                    //打印泛型信息
                    mLogger.info("=======================print genericity info======================");
                    List<? extends TypeParameterElement> typeParameters = ((TypeElement) element).getTypeParameters();
                    for (TypeParameterElement typeParameter : typeParameters) {
                        mLogger.info("...........getTypeParameters()>getSimpleName()............" + typeParameter.getSimpleName().toString() + ".......................");
                    }


                } else if (element instanceof VariableElement) {
                    mLogger.info("****************************VariableElement*****************************");
                    mLogger.info("......................." + aaaa.value() + ".......................");
                } else if (element instanceof ExecutableElement) {
                    mLogger.info("****************************ExecutableElement*****************************");
                    mLogger.info("......................." + aaaa.value() + ".......................");
                }
            }
            return true;
        }
        return false;
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> annotations = new LinkedHashSet<>();
        annotations.add(AAAA.class.getCanonicalName());
        return annotations;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

}

Gradle Console 打印结果：

注: TESTELEMENT::Processor >>> ****************************TypeElement*****************************
注: TESTELEMENT::Processor >>> =======================print package info======================
注: TESTELEMENT::Processor >>> ...........getSimpleName()............testelement.......................
注: TESTELEMENT::Processor >>> ............getQualifiedName()...........baijunyu.com.testelement.......................
注: TESTELEMENT::Processor >>> =======================print genericity info======================
注: TESTELEMENT::Processor >>> ...........getTypeParameters()>getSimpleName()............T.......................
注: TESTELEMENT::Processor >>> ****************************VariableElement*****************************
注: TESTELEMENT::Processor >>> .......................this is a field.......................
注: TESTELEMENT::Processor >>> ****************************ExecutableElement*****************************
注: TESTELEMENT::Processor >>> .......................this is a method.......................
注: TESTELEMENT::Processor >>> ****************************VariableElement*****************************
注: TESTELEMENT::Processor >>> .......................this is a parameter.......................

通过type的一系列方法获得元素信息，可以在运行期间获取注解信息，再通过反射和动态代理实现AOP设计。而element类编译期可见，可以在编译期获取元素的各类信息，结合apt技术实现动态的代码生成。这也是我们研究Element的主要目的，所以我们来学习下使用apt技术实现动态的代码生成，所涉及的Element的主要api。

Element类图

Element接口方法

• TypeMirror asType()

返回一个TypeMirror是元素的类型信息，包括包名，类(或方法，或参数)名/类型，在生成动态代码的时候，我们往往需要知道变量/方法参数的类型，以便写入正确的类型声明

示例代码：

for (Element element : elements) {
            if (element instanceof TypeElement) {

                TypeName typeName = ClassName.get(element.asType());

                TypeSpec typeSpec = TypeSpec.classBuilder("GenerateTest")
                        .addField(typeName, "test")
                       //添加泛型信息
                       .addTypeVariable(TypeVariableName.get(((TypeElement) element).getTypeParameters().get(0)))
                        .build();

                try {
                    JavaFile.builder("com.test", typeSpec)
                            .build()
                            .writeTo(processingEnv.getFiler());
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

生成的类：

package com.test;
//通过ClassName包装之后，在生成对应代码中会自动导入类型的包
import com.lu.aptdemo.Test;

class GenerateTest<T> {
  Test<T> test;
}

• List<? extends AnnotationMirror> getAnnotationMirrors()

获取该元素上的注解的类型信息，AnnotationMirror类似于TypeMirror

• List<? extends Element> getEnclosedElements()

返回该元素直接包含的子元素,通常对一个PackageElement而言，它可以包含TypeElement；对于一个TypeElement而言，它可能包含属性VariableElement，方法ExecutableElement

• Element getEnclosingElement()

返回包含该element的父element，与上一个方法相反，VariableElement，方法ExecutableElement的父级是TypeElemnt，而TypeElemnt的父级是PackageElment

• ElementKind getKind()

返回element的类型，判断是哪种element

public enum ElementKind {
    PACKAGE,
    ENUM,
    CLASS,
    ANNOTATION_TYPE,
    INTERFACE,
    ENUM_CONSTANT,
    FIELD,
    PARAMETER,
    LOCAL_VARIABLE,
    EXCEPTION_PARAMETER,
    METHOD,
    CONSTRUCTOR,
    STATIC_INIT,
    INSTANCE_INIT,
    TYPE_PARAMETER,
    OTHER,
    RESOURCE_VARIABLE;

    private ElementKind() {
    }

    public boolean isClass() {
        return this == CLASS || this == ENUM;
    }

    public boolean isInterface() {
        return this == INTERFACE || this == ANNOTATION_TYPE;
    }

    public boolean isField() {
        return this == FIELD || this == ENUM_CONSTANT;
    }
}

• Set getModifiers()

获取修饰关键字,入public static final,abstract等关键字

public enum Modifier {
    PUBLIC,
    PROTECTED,
    PRIVATE,
    ABSTRACT,
    DEFAULT,
    STATIC,
    FINAL,
    TRANSIENT,
    VOLATILE,
    SYNCHRONIZED,
    NATIVE,
    STRICTFP;

    private Modifier() {
    }

    public String toString() {
        return this.name().toLowerCase(Locale.US);
    }
}

• Name getSimpleName()

获取名字，不带包名

• Name getQualifiedName()

这个方法是element的子接口所带的方法，element本身并不指代具体的元素，因此没有改方法。获取全限定名，如果是类的话，包含完整的报名路径

ExecutableElement

• List<? extends VariableElement> getParameters()

用于获取方法的参数元素，每个元素是一个VariableElement

• TypeMirror getReturnType()

获取方法元素的返回值，返回类型TypeMirror表示

VariableElement

• Object getConstantValue()

如果属性变量被final修饰，则可以使用该方法获取它的值

出在：https://blog.csdn.net/baiaihan/article/details/88038201