23

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

处理环境提供了一个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;
}

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

真正的问题是编译器会自发地被输出目录中的第二个源文件（“错误：重复类”）弄乱，现在我被卡住了。

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

4

3 回答 3

20

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

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

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

InputImpl.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();
    }
}

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

我不太确定你的问题是什么，但我希望这能对你的问题有所启发。

于 2012-12-20T20:38:01.497 回答
1

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

于 2020-01-08T08:30:40.103 回答
0

我不知道这个提示是否符合您的需求，但您的想法将与依赖注入（例如 Spring）结合使用。

  1. 为类型和保留“SOURCE”创建一个自定义注释，它将被 Spring 忽略。
  2. 对注释处理器中的代码进行所需的更改，并将 Spring 的 @Component 注释添加到生成的 Java-Type 中，并将其保存为原始类型的子类型，其类名与原始类型不同。
  3. 当 Spring 创建上下文时，它将根据您的处理结果而不是原始结果加载类。

相反，Lombok 直接操作抽象源代码树，这比生成源代码复杂得多。这里的问题是，Java-Compiler-Module 被暴露（拼图）。

Another alternative could be to use some bytecode-api like ByteBuddy, to proxy the original class at runtime. This will also require dependency-injection if you do not want to write code for instantiatig the class. Here the magic is an autowired field of type collection inside a Configuration class. Let me know, if this is interesting to you. Then I will add more details, here.

于 2021-10-09T12:58:35.670 回答