使用注释处理器替换代码

java code-generation annotation-processing

2022-09-01 23:36:22

我正在尝试编写一个注释处理器来在类上插入方法和字段...文档非常稀疏。我没有走远，我不知道我是否正确地接近了它。

处理环境提供了一个 Filer 对象，该对象具有用于创建新的源文件和类文件的便捷方法。这些工作正常，但后来我试图弄清楚如何读取现有的源文件，它提供的只是“getResource”。因此，在我的处理器实现中，我完成了此操作：

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    try {
        for (TypeElement te : annotations) {
            for (Element element : roundEnv.getElementsAnnotatedWith(te)) {
                FileObject in_file = processingEnv.getFiler().getResource(
                    StandardLocation.SOURCE_PATH, "",
                    element.asType().toString().replace(".", "/") + ".java");

                FileObject out_file = processingEnv.getFiler().getResource(
                    StandardLocation.SOURCE_OUTPUT, "",
                    element.asType().toString().replace(".", "/") + ".java");

                //if (out_file.getLastModified() >= in_file.getLastModified()) continue;

                CharSequence data = in_file.getCharContent(false);

                data = transform(data); // run the macro processor

                JavaFileObject out_file2 = processingEnv.getFiler().createSourceFile(
                    element.asType().toString(), element);
                Writer w = out_file2.openWriter();
                w.append(data);
                w.close();
            }
        }
    } catch (Exception e) {
        e.printStackTrace();
        processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage());
    }
    return true;
}

我的第一个困境是，我不禁觉得（获取限定的类型名称并将其转换为包和源文件路径）不是解决问题的好方法。API的其余部分过于复杂，但似乎没有一种方便的方法来检索原始源代码。element.asType().toString().replace(".", "/") + ".java"

真正的问题是，然后编译器被输出目录中的第二个源文件（“error：duplicate class”）自发地弄乱，现在我被困住了。

我已经写了剩下的部分 - 一个宏词法分析器和解析器，以及用于计算一些数据和插入字段值和方法的东西 - 但它作为编译器外部的初始步骤运行。除了原始文件不能具有.java扩展名（以防止编译器看到它们）之外，这工作得很好。然后我听说注释可以进行代码生成，我认为这会更合适，更方便，但我找不到太多的指导。

答案 1

注释处理器背后的意图是允许开发人员添加新类，而不是替换现有类。话虽如此，有一个错误允许您向现有类添加代码。Project Lombok 利用这一点将 getter 和 setter（以及其他内容）添加到已编译的 java 类中。

我采用的“替换”方法/字段的方法是从输入类扩展或委托到输入类。这允许您重写/转移对目标类的调用。

因此，如果这是您的输入类：

输入.java：

public class InputImpl implements Input{
    public void foo(){
        System.out.println("foo");
    }
    public void bar(){
        System.out.println("bar");
    }
}

您可以生成以下内容来“替换”它：

InputReplacementImpl.java：

public class InputReplacementImpl implements Input{

    private Input delegate;

    //setup delegate....

    public void foo(){
        System.out.println("foo replacement");
    }
    public void bar(){
        delegate.bar();
    }
}

这就引出了一个问题，你如何引用而不是.您可以生成更多代码来执行包装，也可以直接调用预期生成的代码的构造函数。InputReplacementImplInputImpl

我不太确定你的问题是什么，但我希望这能阐明你的问题。

答案 2

:)有点晚，但一种解决方案可能是使用Byte Buddy的转换器作为构建过程的一部分。参见例如 https://github.com/raphw/byte-buddy/tree/master/byte-buddy-maven-plugin。