徒手撸一个框架 - ButterKnife 三步走

2024-01-19 02:25:55

在这瞬息万变的科技时代，框架的运用已成为软件开发中不可或缺的一环。它们为我们提供了构建复杂系统所需的结构和工具，使我们能够专注于业务逻辑，而不是重复且容易出错的任务。

剖析 ButterKnife 框架

作为 Android 开发中广泛使用的框架之一，ButterKnife 以其简单性和灵活性而著称。它简化了视图绑定，使我们能够快速、轻松地找到和操作 UI 元素。为了深入了解 ButterKnife 的工作原理，让我们亲手构建一个属于自己的框架。

三步走构建自定义框架

1. 创建注释处理程序

任何框架的核心都是注释处理程序，它负责扫描我们的代码，在编译时生成所需的代码。对于 ButterKnife，我们首先需要在 annotation_compiler 模块下创建一个名为 AnnotationCompiler 的类。

2. 获取 Filer 对象

Filer 对象允许我们生成新源文件。在我们的 AnnotationCompiler 类中，我们需要声明一个 Filer 对象并通过 process() 方法获取它。

3. 重写关键方法

AnnotationCompiler 必须重写两个关键方法：

getSupportedAnnotationTypes()： 指定框架要处理的注释类型。
getSupportedSourceVersion()： 指示支持的 Java 源版本。

代码示例

以下代码片段展示了 AnnotationCompiler 类的实现：

import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.TypeSpec;

import java.io.IOException;
import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import javax.tools.JavaFileObject;

@AutoService(Processor.class)
public class AnnotationCompiler extends AbstractProcessor {

    private Filer filer;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        filer = processingEnv.getFiler();
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Set.of("com.example.annotations.BindView");
    }

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

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(BindView.class)) {
            try {
                // 根据注释生成代码
                TypeSpec typeSpec = TypeSpec.classBuilder(element.getSimpleName() + "Binding").build();
                JavaFile javaFile = JavaFile.builder(element.getEnclosingElement().toString(), typeSpec).build();
                JavaFileObject sourceFile = filer.createSourceFile(javaFile.packageName + "." + javaFile.typeSpec.name);
                sourceFile.openWriter().write(javaFile.toString());
            } catch (IOException e) {
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage(), element);
            }
        }

        return true;
    }
}