将注释处理器集成到同一个项目中

Question

是否可以在定义它的同一个项目中使用注释处理器？

例子：

• src/

  • MyAnnotation.java
  • path_to_MyAnnotationProcessor.MyAnnotationProcessor.java
  • 其他类
• 资源
  • META-INF/services/javax.annotation.processing.Processor
• pom

当我运行mvn clean install 时，我希望我的处理器将处理使用 MyAnnotation 注释的类。

我不想从另一个库导入已经编译的处理器，我只想在我的 src 中定义它后使用它。

现在，我收到错误： [ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.6.1:compile (default-compile) on project my-project: Compilation failure [ERROR] Annotation processor 'path_to_MyAnnotationProcessor' not found

pom.xml 的一部分，我在这里引用。给我的处理器：

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>${maven.plugin.compiler}</version>
            <configuration>
                <source>${version.java}</source>
                <target>${version.java}</target>
                    <annotationProcessors>
                       <proc>path_to_MyAnnotationProcessor.MyAnnotationProcessor</proc>
                    </annotationProcessors>
            </configuration>
        </plugin>

感谢大家，尤其是 @Stefan Ferstl 和 @yegodm。来自yegodm的解决方案是： “一种方法是两个在同一个项目中有两个模块。一个模块将定义注释和处理器。另一个将它作为建立构建顺序的依赖项。”

Answer 1

解决此问题的最简单方法是将您的项目转换为一个多模块项目，其中注释处理器位于其自己的模块中。对于注解处理器有一个不同的模块，您可以使用全新的<annotationProcessorPaths> 选项通过groupId/artifactId 定义注解处理器。

使用注解处理器的模块可能需要对注解处理器模块的依赖才能首先构建它。

注意：在此答案的先前版本中，我描述了解决此问题的另一种方法，但显然不能开箱即用。该部分已被删除。

Answer 2

您可以通过单独的编译器执行更早地编译您的处理器。

<build>
    <plugins>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <executions>
                <execution>
                    <id>compile-generator</id>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                    <configuration>
                        <includes>
                            <include>com/example/YourProcessor.java</include>
                        </includes>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

我已经对此进行了测试，它可以工作 - 处理器确实会在实际编译阶段稍后被调用。

如果你也从同一个项目中预编译了一些其他类，那么你可以直接在处理器中引用和使用它们。这可能很有用。