Java静态元编程

Question

我想实现注释处理器，它将根据现有的“原型”类生成新类。

import java.util.List

@MyAnnotation
class MySuperClassPrototype {
    static MySuperClassPrototype createInstance() {
      return new MySuperClassPrototype();
    }
}

作为下面代码的结果。将生成以下新源文件（编译单元）：

import java.util.List

class MySuperClass {
    static MySuperClass createInstance() {
      return new MySuperClass();
    }
    public void specialAddedMethod() {
      /*...*/
    }
}

我想复制所有顶级导入语句和静态成员，而不是原型类的静态成员。我已经在编译器树 API (com.sun.source.tree) 方面取得了很大进展。我可以打印出 Tree 数据类型，同时用新的类名替换旧的类名。但有些问题看起来相当困难。

如果我在树中获得 Tree.Kind.IDENTIFIER ，我如何找到它引用的实际类。我需要用 MySuperClass 标识符替换所有出现的 MySuperClassPrototype 标识符，然后打印出整个树。

可行吗？

同样，我需要过滤掉 @MyAnnotation 注释，并再次用 Tree.Kind.IDENTIFIER 或 Tree.Kind.MEMBER_SELECT 表示。

如何找到该标识符引用的实际注释类？

另一个问题是打印树。如果我使用 toString 方法，我会得到不错的结果，但构造函数会打印为带有“”的方法名称而不是与其类同名的方法，因此我需要手动打印每种树节点。

您可以查看我在此处提供的代码

Answer 1

是的，这是可能的，而且我至少知道两种方法。

首先，“传统”方法是编写 ant 任务/maven 插件/命令行 java 实用程序，扫描给定的文件路径并调用每个类，例如 Class.forName(className).getAnnotations(MyAnnotation.class).如果这不为空，则使用反射发现类并执行您需要的操作。

其他方法稍微困难一些，但更强大。
您可以实现自己的 Processor（实现 javax.annotation.processing.Processor 或什至更好地扩展 javax.annotation.processing.AbstractProcessor）。
您的处理器只需放置到编译器类路径中，它就会在编译器运行时自动运行。您甚至可以配置 IDE（例如 Eclipse）来运行您的处理器。它是java编译器的一种扩展。因此，每次 Eclipse 构建您的项目时，它都会运行处理器并根据您添加的新注释创建所有新类。

请查看此项目作为参考。

Answer 2

8年了，还没回复。因此，我会尽力回答，让您满意。

我进一步关注问题的静态部分。

TL;DR：

您不会在此答案中找到复制和粘贴代码。

可行吗？

是的，绝对是。

如何找到此标识符引用的实际注释类？

您必须使用注释处理器中的 RoundEnvironment 来获取 TypeElement。

静态元编程

静态元编程（您要求的）是在编译时完成的元编程。作者：Kontrast：动态元编程是在运行时完成的元编程。元编程本身就是程序的设计，将其他程序作为数据处理。

Pfeh，有很多东西需要了解。如果您对这个主题感兴趣，或多或少有一个不错的来源是 维基百科。

您的目标是在编译时生成一个类。对于运行时，可以使用 cglib 之类的东西来完成。但是，由于您选择静态（并且出于所有正确的原因），我不会解释这一点。

您正在寻找的概念是注释处理器。该链接是 Baeldung 的链接，他们在那里完全按照您的需求进行操作，只考虑了构建器模式。您会很高兴听到，这种情况受到高度鼓励，并且可以使用注释处理器 API 轻松实现。它甚至允许您生成代码，该代码再次传递到同一个或另一个注释处理器，而无需您执行任何操作。

在开始之前，尝试用 google 搜索一下“Java Annotation Processing”。那里有很多好的资源，它们会对您有所帮助。太多了，在此一一列举。请注意，注释处理器中的编码与正常编码不同。差别不大，但您正在处理的类尚未创建。所以请记住这一点，不要灰心！

使用注释处理器

您的基本注释处理器将如下所示：

@SupportedAnnotationTypes("package.of.MyAnnotation")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
@AutoService(Processor.class)
public class BuilderProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, 
                           RoundEnvironment roundEnv) {
        // First let's find all annotated elements
        Set<? extends Element> annotatedElements = roundEnv.getElementsAnnotatedWith(MyAnnotation.class);
        // Handle all the annotated classes
        return false;
    }
}

AutoService Annotation 用于动态注册您的注释处理器。它来自外部源，这样您就不会想知道为什么此代码无法编译。

在处理所有带注释的类部分中，您有带注释的元素（它们是带注释的类）。您现在必须验证它们是类而不是接口或其他注释。这是因为 @Target(ElementType.Type) 针对任何类型，包括接口和注释。此外，您需要验证您需要的任何内容是否存在，或者使用 消息发送器。

如果您在此处打印错误（例如），您将停止编译，并且在大多数现代 IDE 中都会看到该错误。可以通过调用 roundEnv.getMessager() 来实现。

之后您可以生成一个新类并将其作为 .java 文件写入编译器的输入。这可以通过使用 Filer。

StackOverflow 中的答案确实没有公正地对待这个主题。我强烈建议查看 Baeldung 示例并试图从那里揭开一些事情。这个 API 与 Java 6 一样古老，但仍然没有得到广泛使用。我鼓励读者您亲自尝试一下:)

Answer 3

看看https://github.com/rzwitserloot/lombok/，它添加了方法作为你描述的。
如

• @Getter 根据字段添加 getter 方法
• @Setter
• @ToString 根据字段添加 toString() 方法