用APT为你的代码添加编译时魔法

2023-09-10 18:47:58

APT简介

APT的全称为Annotation Processing Tool，顾名思义，它是一种处理注解的工具。在Java中，注解是一种元数据，它可以为代码提供额外的信息。APT可以读取这些注解，并根据注解的内容生成代码。

APT的原理并不复杂，它会在编译过程中对代码进行扫描，找出所有带有注解的元素。然后，APT会调用相应的注解处理器来处理这些注解。注解处理器是一个特殊的Java类，它实现了javax.annotation.processing.Processor接口。

注解处理器的作用是生成代码。它可以根据注解的内容，生成新的Java源文件、字节码文件，甚至可以修改现有代码。

APT的使用方法

要使用APT，你需要在你的项目中添加相应的依赖。如果你使用Maven，可以在pom.xml中添加如下依赖：

<dependency>
  <groupId>com.google.auto.service</groupId>
  <artifactId>auto-service</artifactId>
  <version>1.0-rc7</version>
</dependency>

然后，你就可以开始编写自己的注解处理器了。注解处理器的编写方法与普通的Java类编写方法基本相同，不过你需要实现javax.annotation.processing.Processor接口。

在Processor接口中，你需要实现两个方法：

process(): 这个方法是注解处理器的主方法，它会在编译过程中被调用。在这个方法中，你可以读取注解的内容，并生成相应的代码。
getSupportedAnnotationTypes(): 这个方法返回注解处理器的支持的注解类型。

举个简单的例子，我们来编写一个注解处理器，它会在编译时为带有@ToString注解的类生成toString()方法。

首先，我们需要定义@ToString注解：

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface ToString {}

然后，我们就可以编写注解处理器了：

import javax.annotation.processing.*;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.JavaFileObject;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Set;

@SupportedAnnotationTypes("ToString")
public class ToStringProcessor implements Processor {

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Set.of("ToString");
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement annotation : annotations) {
            // 遍历带有@ToString注解的类
            for (Element element : roundEnv.getElementsAnnotatedWith(annotation)) {
                // 为每个类生成一个toString()方法
                String className = element.getSimpleName().toString();
                String toStringMethod = "public String toString() {\n" +
                        "  return \"" + className + " [\" + \n" +
                        "    \"id=\" + id + \n" +
                        "    \", name=\" + name + \n" +
                        "    \"]\";\n" +
                        "}";
                // 将生成的toString()方法写入一个新的Java文件中
                try {
                    JavaFileObject sourceFile = processingEnv.getFiler().createSourceFile(className + "ToString");
                    PrintWriter out = new PrintWriter(sourceFile.openWriter());
                    out.println(toStringMethod);
                    out.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return true;
    }
}

最后，我们在pom.xml中添加如下配置，以便在编译时启用注解处理器：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.1</version>
      <configuration>
        <annotationProcessorPaths>
          <path>
            <groupId>com.example</groupId>
            <artifactId>apt-compiler</artifactId>
            <version>1.0</version>
          </path>
        </annotationProcessorPaths>
      </configuration>
    </plugin>
  </plugins>
</build>