編譯時動態生成代碼技術之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

• Set getModifiers()

獲取修飾關鍵字,入public static final等關鍵字

• Name getSimpleName()

獲取名字，不帶包名

• Name getQualifiedName()

這個方法是element的子接口所帶的方法，element本身並不指代具體的元素，因此沒有改方法。獲取全限定名，如果是類的話，包含完整的報名路徑

ExecutableElement

• List<? extends VariableElement> getParameters()

用於獲取方法的參數元素，每個元素是一個VariableElement

• TypeMirror getReturnType()

獲取方法元素的返回值，返回衣蛾TypeMirror表示

VariableElement

• Object getConstantValue()

如果屬性變量被final修飾，則可以使用該方法獲取它的值