在maven工作流中的Annotation处理期间，在何处生成资源

Question

我有一个有几个模块的maven项目，即

<module>backend</module>             <!-- provides annotations -->
<module>annotationProcessor</module> <!-- processes ann., generates files -->
<module>mainprog</module>            <!-- uses annotations/files -->

backend提供了用于注释类的注释类MyAnnotation。

mainprog包含Mainprog.java，它定义了一个带有@MyAnnotation注释的类。在运行时，这个类尝试通过getResourceAsStream("Mainprog.properties")（它还不存在）加载一个文件。

annotationProcessor有一个类MyAnnotationProcessor，maven执行该类并查找我的注释。

处理器应根据注释处理器收集的信息创建文件Mainprog.properties。

在执行/测试Mainprog时，我无法将属性文件放在可以找到它的地方。

• 在maven工作流中，我应该将文件生成到哪里
• 如何告诉maven这个文件在测试或运行时使用？最后必须包装在罐子里

Mainprog

package demo;
@MyAnnotation
public class Mainprog {
}

使用属性文件

目前，我在测试类中进行测试，但稍后将在类本身中进行测试。

package demo;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import org.junit.Test;
public class MainprogTest {
  Class testclass = Mainprog.class;
  @Test
  public void testPropertiesFile() throws IOException {
    String fn = testclass.getCanonicalName().replace('.', '/') + ".properties";
    System.err.println("loading: '"+fn+"'");
    InputStream in = getClass().getResourceAsStream(fn);
    Properties prop = new Properties();
    prop.load(in);
    in.close();
  }
}

这目前是这样运行的：

loading: 'demo/Mainprog.properties'
Tests in error: 
   testPropertiesFile(demo.MainprogTest)

对于NullPointerException，因为流返回null，即不存在。

尽管文件在那里（但它在正确的地方吗？）：

towi@havaloc:~/git/project/mainprog$ find . -name Mainprog.properties 
./src/java/demo/Mainprog.properties
./target/classes/demo/Mainprog.properties

处理器

package demo;
import com.github.javaparser.*;
import com.github.javaparser.ast.*;
import javax.annotation.processing.*;
import javax.lang.model.element.*;
@SupportedAnnotationTypes({"demo.MyAnnotation"})
public class MyAnnotationProcessor extends AbstractProcessor {
  @Override
  public boolean process(Set<? extends TypeElement> elements, RoundEnvironment env) {
    for (TypeElement te : elements) {
      for (Element e : env.getElementsAnnotatedWith(te))
      {
        processAnnotation(e);
      }
    }
    return true;
  }
  private void processAnnotation(Element elem) {
    final TypeElement classElem = (TypeElement) elem;
    ...
    final String prefix = System.getProperty("user.dir").endsWith("/"+"mainprog") ? "." : "mainprog";
    final String className = classElem.getQualifiedName().toString();
    String fileName = prefix + "/src/java/" + className.replace('.', '/') + ".java";
    FileInputStream in = new FileInputStream(fileName);
    final CompilationUnit cu = JavaParser.parse(in);
    final CallGraph graph = ...
    generateInfoProperties(classElem, fileName, graph);
  }
  private void generateInfoProperties(TypeElement classElem, String inFilename, CallGraph graph) throws IOException {
    final File outFile = new File(inFilename
      .replace("/src/java/", "/src/java/") // <<< WHERE TO ???
      .replace(".java", ".properties"));
    outFile.getParentFile().mkdirs();
    try (PrintWriter writer = new PrintWriter(outFile, "UTF-8")) {
      final Properties ps = new Properties();
      graph.storeAsProperties(ps);
      ps.store(writer, inFilename);
      writer.close();
    }
  }
}

正如您所看到的，在处理目录名时，会有很多猜测和"启发"。所有的System.getProperty("user.dir")和replace("/src/java/", "/src/java/")可能都是错误的，但还有什么更好呢？

maven

在Maven，我有4个pom，当然是

• pom.xml
• backend/pom.xml
• annotationProcessor/pom.xml
• mainprog/pom.xml

在我看来，只有一个包含任何值得注意的内容，即mainprog/pom.xml:中注释处理器的执行

<project>
 ....
 <dependencies>
  <dependency>
    <groupId>project</groupId>
    <artifactId>backend</artifactId>
    <scope>compile</scope>
  </dependency>
  <dependency>
    <groupId>project</groupId>
    <artifactId>annotationProcessor</artifactId>
    <scope>compile</scope>
  </dependency>
 </dependencies>
 <build>
  <finalName>mainprog</finalName>
  <sourceDirectory>src/java</sourceDirectory>
  <resources>
    <resource>
      <directory>${basedir}/src/conf</directory>
      <targetPath>META-INF</targetPath>
    </resource>
    <resource>
      <directory>${basedir}/web</directory>
    </resource>
    <resource>
      <directory>${basedir}/src/java</directory>
      <includes>
        <include>**/*.xml</include>
        <include>**/*.properties</include>
        <include>**/*.wsdl</include>
        <include>**/*.xsd</include>
      </includes>
    </resource>
  </resources>
  <plugins>
   <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
      <annotationProcessors>
        <annotationProcessor>demo.MyAnnotationProcessor
        </annotationProcessor>
      </annotationProcessors>
    </configuration>
   </plugin>
  ...
  </plugins>
 </build>
</project>

我认为将文件生成为/src/java/，然后拥有<resource><directory>${basedir}/src/java和<include>**/*.properties就足够了，但事实似乎并非如此。为什么？

Answer 1

使用提供的Filer，可以使用processingEnv.getFiler()获得。如果您使用它创建一个源文件，编译器将在下一轮编译它，您不需要担心配置Maven来编译生成的源文件。