Android 注解处理：生成 Java 源代码

2024-04-10 11:30:04 阅读数 831

前言

在开始实施之前，我们必须制定我们的战略。这将减少命中和试验的次数。

注释处理在处理 Java 注释源代码时提供的东西：

设置<?****extends TypeElement>：它提供注释列表作为包含在正在处理的 Java 文件中的元素。
RoundEnvironment：它通过实用程序提供对处理环境的访问以查询元素。我们将在这个环境中使用的两个主要函数是：processingOver（意味着知道它是否是最后一轮处理）和getRootElements（它提供将被处理的元素列表。其中一些元素将包含我们正在处理的注释感兴趣的。）

所以，我们有一组注释和一个元素列表。我们的库将生成一个包装类，该类将帮助映射活动的视图和点击监听器。

它将具有以下用法：

activity_main.xml定义了一个TextView带有 id的tv_content按钮和两个带有 id 和bt_1的按钮bt_2。我们的注释将映射视图和按钮以删除样板，就像 ButterKnife 一样。

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv_content)
    TextView tvContent;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Binding.bind(this);
    }

    @OnClick(R.id.bt_1)
    void bt1Click(View v) {
        tvContent.setText("Button 1 Clicked");
    }

    @OnClick(R.id.bt_2)
    void bt2Click(View v) {
        tvContent.setText("Button 2 Clicked");
    }
}

我们将使用MainActivity定义通过注释处理自动生成名为MainActivity$Binding的包装类。

注意：我们将在其中使用注解的任何 Activity 都将创建一个名称以 $Binding**结尾的包装类。示例：如果我们有另一个活动，比如**ProfileActivity**，它有`@BindView`或`@OnClick`使用，那么它将导致**ProfileActivity$ Binding Java 源代码文件的创建。

处理后将创建以下类。

@Keep
public class MainActivity$Binding {
  public MainActivity$Binding(MainActivity activity) {
    bindViews(activity);
    bindOnClicks(activity);
  }

  private void bindViews(MainActivity activity) {
    activity.tvContent = (TextView)activity.findViewById(2131165322);
  }

  private void bindOnClicks(final MainActivity activity) {
    activity.findViewById(2131165218).setOnClickListener(new View.OnClickListener() {
      public void onClick(View view) {
        activity.bt1Click(view);
      }
    });
    activity.findViewById(2131165219).setOnClickListener(new View.OnClickListener() {
      public void onClick(View view) {
        activity.bt2Click(view);
      }
    });
  }
}

现在我们知道我们必须生成什么，让我们分析如何使用我们在处理时掌握的信息来创建它。

我们将首先过滤掉那些使用@BindView或@OnClick来自getRootElements方法提供的元素列表的类 (Type) 元素。
然后我们将遍历这些过滤的元素，然后扫描它们的成员和方法，以使用JavaPoet 开发包装类的类模式。最后，我们将该类写入 Java 文件。

对于第 1 步，我们希望提高搜索效率。因此，我们将创建一个具有过滤方法的类ProcessingUtils。

public class ProcessingUtils {

    private ProcessingUtils() {
        // not to be instantiated in public
    }

    public static Set<TypeElement> getTypeElementsToProcess(Set<? extends Element> elements,
                                                            Set<? extends Element> supportedAnnotations) {
        Set<TypeElement> typeElements = new HashSet<>();
        for (Element element : elements) {
            if (element instanceof TypeElement) {
                boolean found = false;
                for (Element subElement : element.getEnclosedElements()) {
                    for (AnnotationMirror mirror : subElement.getAnnotationMirrors()) {
                        for (Element annotation : supportedAnnotations) {
                            if (mirror.getAnnotationType().asElement().equals(annotation)) {
                                typeElements.add((TypeElement) element);
                                found = true;
                                break;
                            }
                        }
                        if (found) break;
                    }
                    if (found) break;
                }
            }
        }
        return typeElements;
    }
}

这里有两点我们需要了解：

element.getEnclosedElements()：封闭元素是包含在给定元素中的元素。在我们的例子中，元素将是MainActivity (TypeElement)，而封闭的元素将是tvContent、onCreate、bt1Click和bt2Click其他继承的成员。
subElement.getAnnotationMirrors()：它将提供子元素上使用的所有注释。示例：@Override对于onCreate，@BindView对于tvContent和@OnClick对于bt1Click。

因此，将MainActivitygetTypeElementsToProcess过滤为我们需要处理的TypeElement 。

现在，我们将扫描所有过滤后的元素以创建相应的包装类。

要点：

查找元素的包：（elementUtils.getPackageOf(typeElement).getQualifiedName().toString()在我们的例子中：com.mindorks.annotation.processing.example）
获取元素的简单名称：（typeElement.getSimpleName().toString()在我们的例子中为 MainActivity）
我们需要ClassName来使用注解 API：（ClassName.get(packageName, typeName)它将为 MainActivity 创建一个 ClassName）
我们必须为包装类MainActivity$Binding创建一个ClassName ，以便我们可以定义它的成员和方法。

注意：为了便于名称维护和良好的编码习惯，我们将创建一个名为NameStore的类。它将包含我们在定义 Binding 类时需要的所有类、变量和方法名称。

public final class NameStore {

    private NameStore() {
        // not to be instantiated in public
    }

    public static String getGeneratedClassName(String clsName) {
        return clsName + BindingSuffix.GENERATED_CLASS_SUFFIX;
    }

    public static class Package {
        public static final String ANDROID_VIEW = "android.view";
    }

    public static class Class {
        // Android
        public static final String ANDROID_VIEW = "View";
        public static final String ANDROID_VIEW_ON_CLICK_LISTENER = "OnClickListener";
    }

    public static class Method {
        // Android
        public static final String ANDROID_VIEW_ON_CLICK = "onClick";

        // Binder
        public static final String BIND_VIEWS = "bindViews";
        public static final String BIND_ON_CLICKS = "bindOnClicks";
        public static final String BIND = "bind";
    }

    public static class Variable {
        public static final String ANDROID_ACTIVITY = "activity";
        public static final String ANDROID_VIEW = "view";
    }
}

此外，您会发现在binder-annotations库的 ( internal -> BindingSuffix)类中添加了$Binding后缀。这样做有两个目的。

我们希望名称是可配置的，即我们可以将其从$Binding更改为_Binder或其他任何名称。
它将用于在binder和binder-compiler库中查找生成的类。

JavaPoet 速成课程：

JavaPoet使定义类结构并在处理时编写它变得非常简单。它创建非常接近手写代码的类。它提供了自动推断导入以及美化代码的工具。

要使用 JavaPoet，我们需要将以下依赖项添加到binder-compiler模块中。

dependencies {
    implementation project(':binder-annotations')
    implementation 'com.squareup:javapoet:1.11.1'
}

注意：使用JavaFileObject是非常不切实际和麻烦的。所以，我们甚至不会谈论它。

本教程所需的JavaPoet的基本用法（任何提前了解都可以从其<u style="text-decoration: none; border-bottom: 1px solid rgb(68, 68, 68);">GitHub Repo</u>中获得。）

TypeSpec.Builder：定义类模式。
addModifiers（修饰符）：添加私有、公共或受保护的关键字。
addAnnotation：向元素添加注释。示例：在我们的例子中，@ Override方法或@Keep方法。
TypeSpec.Builder -> addMethod：向类添加方法。示例：构造函数或其他方法。
MethodSpec -> addParameter：为方法添加参数类型及其名称。示例：在我们的例子中，我们希望将带有变量名activity的MainActivity类型传递给方法。
MethodSpec -> addStatement：它将在方法中添加代码块。在这个方法中，我们首先定义语句的占位符，然后传递参数来映射这些占位符。示例：（addStatement("$N($N)", "bindViews", "activity") 这将生成代码bindViews(activity)）。PlaceHolders : $N -> names** , **$ T -> type (ClassName), $L -> literals (long etc.)。

其余的东西可以参考这个JavaPoet的基本介绍很容易理解。我把休息留给你自己弄清楚。我就是这样学习的。

最后一步：编写java源代码。

使用 JavaPoet 编写定义的类模式非常简单。

// write the defines class to a java file
try {
    JavaFile.builder(packageName,
            classBuilder.build())
            .build()
            .writeTo(filer);
} catch (IOException e) {
    messager.printMessage(Diagnostic.Kind.ERROR, e.toString(), typeElement);
}

它将在文件夹中生成源代码。/app/build/generated/source/apt/debug

在我们的例子中：/app/build/generated/source/apt/debug/com/mindorks/annotation/processing/example/MainActivity$Binding.java

作者：Janishar Ali
链接：Android Annotation Processing Tutorial: Part 3: Generate Java Source Code