如何在-Android-中完成一个-APT-项目的开发？，受益匪浅

最新推荐文章于 2023-10-12 17:21:00 发布

m0_61417918

最新推荐文章于 2023-10-12 17:21:00 发布

阅读量299

点赞数

分类专栏： Android 文章标签： android java 移动开发

本文链接：https://blog.csdn.net/m0_61417918/article/details/120189139

版权

Android 专栏收录该内容

29 篇文章 0 订阅

订阅专栏

####4.Elements

Elements可以理解为一个工具类，它的功能就是操作Element对象，对Element对象进行一些处理或取值。

####5.TypeElement

TypeElement是Element子类，它表示这个元素是一个类或者接口。当Element满足条件时候，可以强转为一个TypeElement对象。

####6.VariableElement

VariableElement是Element子类，它表示这个元素是一个变量、常量、方法、构造器、参数等。当Element满足条件时候，可以强转为一个VariableElement对象。

####7.Filer

Filer是一个文件操作的接口，它可以创建或写入一个Java文件。主要针对的是Java文件对象，和一般文件的区别在于这是专门处理Java类文件的，以.java或.class为后缀的文件。在APT过程中，如果我们自动化代码生成完毕，需要生成一个.java或.class文件的时候，就需要用到Filer。

####8.Name

Name类是CharSequence的子类，主要表示类名、方法名。大部分情况下可以认为它和String等价。

####9.Types

Types可以理解为一个工具类，是类型操作工具，在APT阶段，我们需要知道一个变量是int还是boolean，那将需要通过Types相关类处理。它可以操作TypeMirror对象。

####10.TypeMirror

TypeMirror表示数据类型。比如基本类型int、boolean，也可以表示复杂数据类型，比如自定义类、数组、Parcelable等。

####11.Modifier

即修饰词。比如声明一个变量时候，private static final这些均为修饰词。大部分被Android Studio标示为蓝色的都是修饰词（除了class int interface这些）。

注：如果一个类中的变量缺省作用范围，那么修饰词为default。

####12.RoundEnvironment

当我们在子类中复写了AbstractProcessor的process方法时，其参数就是一个RoundEnvironment对象。可以通过RoundEnvironment对象获取到我们在代码中设置了相关注解的Element。

###APT处理过程拆解

下面将以上文中所举出的场景，逐步对APT处理过程进行拆解，最终获取到我们需要的属性，为生成自动化代码做准备。

在TestActivity中的变量上设置注解：

@AutoBundle
public int id;
@AutoBundle
public String name;
@AutoBundle
public boolean is;

其中AutoBundle注解是我们自己定义的注解类。

初步设计好后，我们需要在process方法中重写我们的逻辑：

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

第一步：

获取所有被AutoBundle注解所声明的元素。这里我们知道，其实只有三个变量；

for (Element element : roundEnvironment.getElementsAnnotatedWith(AutoBundle.class)) {

}

第二步：

对每个循环中的Element对象，获取其数据信息；

if (element.getKind() == ElementKind.FIELD) {
    // 可以安全地进行强转，将Element对象转换为一个VariableElement对象
    VariableElement variableElement = (VariableElement) element; 
    // 获取变量所在类的信息TypeElement对象
    TypeElement typeElement = (TypeElement) variableElement.getEnclosingElement();

variableElement中包含的数据包括修饰词、类型、变量名等；

typeElement中包含的数据包括类名、包名等。

 // 获取类名
 String className = typeElement.getSimpleName().toString();
 
 // 获取包名
 String packageName = elements.getPackageOf(typeElement).getQualifiedName().toString();
 
 // 获取变量上的注解信息
 AutoBundle autoBundle = variableElement.getAnnotation(AutoBundle.class);
 boolean require = autoBundle.require();

// 获取变量名
Name name = variableElement.getSimpleName();

// 获取变量类型
TypeMirror type = variableElement.asType();

对于我们上文定义的某个变量，比如：

@AutoBundle(require = true)
public int id;

那么获取到数据后：

require = true
name = “id”
type = int.class

其他两个变量同理。

三次循环将获取到我们需要的所有信息。

包括三个变量的注解值、变量名、类型。同时我们也获取到了TestActivity的类名和包名。可以对这些数据进行一些封装和缓存。接下来就可以自动化生成代码了。

我将上述变量值封装为ClassHoder与FieldHolder类中，ClassHolder保存了类名、包名等信息，FieldHolder保存了每个变量类型、变量名、注解等信息。下面将用这些保存好的数据，通过JavaPoet生成代码。

###JavaPoet代码自动化生成

JavaPoet是Java代码自动生成框架，是一个github上的开源项目，地址：https://github.com/square/javapoet 。

JavaPoet简化了Java代码生成的开发难度，通过建造者模式，使调用更加人性化，可读性提升。具有自动import的功能，不需要再手动指定。

JavaPoet中，大部分数据类型使用了APT中通用的类型，结合APT自动化产生代码非常方便快速。

1.TypeSpec.Builder

TypeSpec.Builder是类的构建类，这里的类是广义上的，可以是一个class、interface、annotation等。

示例代码：

TypeSpec.Builder contentBuilder = TypeSpec.classBuilder("yourClassName")

2.MethodSpec.Builder

MethodSpec.Builder是方法的构建类。

示例代码：

MethodSpec.Builder bindMethodBuilder = MethodSpec.methodBuilder("yourMethodName")

3.FieldSpec.Builder

FieldSpec.Builder是变量的构建类。

示例代码：

FieldSpec.Builder fieldBuilder = FieldSpec.builder(ClassName.get(field.getType()), "yourFieldName", Modifier.PRIVATE)

4.JavaFile.Builder

示例代码：

JavaFile javaFile = JavaFile.builder(classHolder.getPackageName(), contentBuilder.build())
javaFile.writeTo(mFiler);

5.各类Builder的方法

6.代码生成示例

构造代码与生成结果示例1：

for (FieldHolder field : fields) {
    FieldSpec f = FieldSpec.builder(ClassName.get(field.getType()), field.getName(), Modifier.PRIVATE)
            .build();
contentBuilder.addField(f);

private int id;
private String name;
private boolean is;

构造代码与生成结果示例2：

MethodSpec.Builder buildMethodBuilder = MethodSpec.methodBuilder("build")
         .addModifiers(Modifier.PUBLIC)
         .returns(ClassName.get("android.content", "Intent"));
 
 buildMethodBuilder.addParameter(ClassName.get("android.content", "Context"), "context");
 
 buildMethodBuilder.addStatement(String.format("Intent intent = new Intent(context, %s.class)", classHolder.getClassName()));
 
 for (FieldHolder field : fields) {
    buildMethodBuilder.addStatement(String.format("intent.putExtra(\"%s\", %s)", field.getName(), field.getName()));
}

buildMethodBuilder.addCode("if (!(context instanceof $T)) {\n", ClassName.get("android.app", "Activity"));

buildMethodBuilder.addStatement("intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)");

buildMethodBuilder.addCode("}\n");

buildMethodBuilder.addStatement("return intent");

contentBuilder.addMethod(buildMethodBuilder.build());

public Intent build(Context context) {
   Intent intent = new Intent(context, TestActivity.class);
   intent.putExtra("id", id);
   intent.putExtra("name", name);
   intent.putExtra("is", is);
   if (!(context instanceof Activity)) {
   intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
   }
   return intent;
}

构造代码与生成结果示例3：

String fieldTypeName = field.getType().toString();
 
 3if (int.class.getName().equals(fieldTypeName)
         || Integer.class.getName().equals(fieldTypeName)) {
 
     builder.addStatement(String.format("target.%s = intent.getIntExtra(\"%s\", 0)", field.getName(), field.getName()));
 
 } else if (String.class.getName().equals(fieldTypeName)) {
 
    builder.addStatement(String.format("target.%s = intent.getStringExtra(\"%s\")", field.getName(), field.getName()));

} else if (boolean.class.getName().equals(fieldTypeName)
        || Boolean.class.getName().equals(fieldTypeName)) {

    builder.addStatement(String.format("target.%s = intent.getBooleanExtra(\"%s\", false)", field.getName(), field.getName()));

}

public void bind(TestActivity target, Intent intent) {
  target.id = intent.getIntExtra("id", 0);
  target.name = intent.getStringExtra("name");
  target.is = intent.getBooleanExtra("is", false);
}

7.将生成好的代码写入文件

JavaFile javaFile = JavaFile.builder(classHolder.getPackageName(), contentBuilder.build()).build();

try {
    javaFile.writeTo(mFiler);
} catch (IOException e) {
    e.printStackTrace();
}

构建一个JavaFile对象，将构造好的TypeSpecBuilder内容放入，并写入到Filer中即可。编译后此类文件便生成在对应包下，如图所示，自动生成文件在build/generated/source/kapt下（使用kapt指令编译）。

生成代码：

###开发流程总结

pecBuilder内容放入，并写入到Filer中即可。编译后此类文件便生成在对应包下，如图所示，自动生成文件在build/generated/source/kapt下（使用kapt指令编译）。

[外链图片转存中…(img-qAvQes8A-1631107128743)]

生成代码：

[外链图片转存中…(img-CE8H8BG6-1631107128744)]

[外链图片转存中…(img-ySxOAUTC-1631107128744)]

###开发流程总结

[外链图片转存中…(img-Z9OIEgRW-1631107128745)]

m0_61417918

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
如何在-Android-中完成一个-APT-项目的开发？，受益匪浅

####4.ElementsElements可以理解为一个工具类，它的功能就是操作Element对象，对Element对象进行一些处理或取值。####5.TypeElementTypeElement是Element子类，它表示这个元素是一个类或者接口。当Element满足条件时候，可以强转为一个TypeElement对象。####6.VariableElementVariableElement是Element子类，它表示这个元素是一个变量、常量、方法、构造器、参数等。当Element满足条件时候，
复制链接

扫一扫