Maven：代码生成之前的部分编译

Question

tl;dr-edition： 我知道编译会失败，但希望编译后在我的 target/classes 文件夹中仍然可以编译的类子集。我已经配置了 false，但没有生成任何类，甚至没有生成独立于除 Object 之外的任何其他类的虚拟类。是否有一些配置可以实现此目的？

---

我有一个由 Maven 支持的项目，其工作流程基本上由以下（相关）目标组成：

• ...

• init-compile

  代码生成器（如下）使用基于反射的配置，因此，在第一遍中，我想尝试编译尽可能多的项目，以便不会在那里抛出 ClassNotFoundException。此编译配置为 false 以便构建继续。

  不幸的是（你可以称之为设计缺陷），该配置既用于代码生成（指定 OWL 文件和命名空间来打包映射）又用于运行时，因此它还包含代码不需要的其他元素生成器，但仍会被读取，因此需要在类路径上才能成功。

• 生成模型

  在此步骤中，一些模型类是从 OWL-Ontology 生成的，创建的代码使项目的其余部分完全可编译。

• 默认编译

  现在，显然应该编译其余的类

• save-model

  现在，从本体中读取实例并将其序列化为运行时的文件

• < p>...

旁注：生成和保存模型都使用 maven-exec-plugin，但我真诚地认为这根本不重要。

问题：

当我使用mvn -e -U clean package source:jar javadoc:jar install:install运行构建时，它在generate-model<期间失败/code> 目标是我试图避免的错误。 target/classes 是空的，因此编译器似乎没有吐出它可以/应该能够处理的类的子集。有办法实现这一点吗？

我有两个我都不喜欢的解决方法：

• 在将配置文件“AST”解析为 Java 对象之前编辑它，以便仅解析与代码生成器相关的部分（需要调整我有权访问的代码）但我的项目应该认为是不可变的）；
• 并将 init-compile 目标配置为仅包含所需的类（太不灵活，因为 POM 应该/可能是使用相同模型的未来应用程序的模板）。

如果您可以想象另一种方法来解决我的问题，您可以从我的描述中看到，我也很高兴听到它们！

Answer 1

首先，让我重述一下您的问题，以确保我正确理解了它。

• 您有一组类，其编译形式的功能是
  配置代码生成器和运行时。 （的一个子集
  这些与代码生成器相关，但生成会失败
  除非存在完整的配置。所以我们可以将其视为
  尽管整个配置都是必要的。）

• 然后您将拥有一组将作为源生成的类
  代码。它们有一个生成时间，也许是一个编译时间，以及一个
  运行时依赖于配置类。

• 最后，您还有一些具有编译时依赖性的其他代码
  依赖于生成的类，以及运行时依赖
  生成的类和配置类。

• 但是，您的配置类对生成的类或其他代码没有任何编译时依赖性。您没有明确说明这一点，但我假设它，否则您将遇到循环依赖问题。

这是我的建议：将项目划分为多模块（“reactor”）项目。您当前的项目将是reactor项目的一个模块。创建一个名为“config”或类似的新模块，并将您的配置类移入其中。让主模块依赖它。

如果您不喜欢多模块项目，您可以通过声明绑定到生成源阶段的编译插件的额外执行来实现相同的目的。 （你没有说，但我假设你在这个阶段进行代码生成。如果你在 POM 中的代码生成器插件之前声明编译插件，Maven 将以相同的顺序执行它们。）你可以使用编译插件的“include”过滤器仅编译配置类。为此，您需要将配置类与其他所有配置类放在一个单独的包中，无论如何，这是一个很好的做法。

Answer 2

有一种非常方便的解决方案 - 使用 Eclipse Java Compiler (EJC) 而不是标准的 Oracle javac！ ECJ 相对于 javac 的优点之一是它允许错误，它尝试尽可能多地编译并保留已生成的类文件。 EJC 是为在 IDE 中使用而开发的，用于必须进行部分编译的高度交互工作，但它也可以用作 CLI 或 Maven 插件。 Plexus 人员提供 EJC 作为方便的 Maven 依赖项。

编译器可插入 Maven 中。您可以在一个 POM 中定义多个编译（编译执行），并且可以为每个编译器使用不同的编译器，为开发人员提供广泛的选择。

POM 代码示例：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.1</version>
    <executions>
        <execution>
            <id>pre-compilation</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>compile</goal>
            </goals>
            <configuration>
                <compilerId>eclipse</compilerId>
                <!-- IMPORTANT. Select EJC as compiler instead of javac -->
                <failOnError>false</failOnError>
                <!-- IMPORTANT. When ECJ is used errors are reported 
                only as warnings, it continues in compilation, 
                try to compile as much as possible, keeps already 
                generated classes in target/classes -->
            </configuration>
        </execution>
        <execution>
            <id>default-compile</id>
            <phase>compile</phase>
            <!-- in the end recompile everything with standard javac.
                 This time no compilation errors are expected or tolerated. -->
            <goals>
                <goal>compile</goal>
            </goals>
            <configuration>
                <useIncrementalCompilation>false</useIncrementalCompilation>
            </configuration>
        </execution>
    </executions>
    <dependencies>
        <dependency>
            <groupId>org.codehaus.plexus</groupId>
            <artifactId>plexus-compiler-eclipse</artifactId>
            <version>2.3</version>
        </dependency>
    </dependencies>
</plugin>

<!-- generate sources. This plugin executes in facet BETWEEN the compilations due to 
    'generate-sources' phase binding and relative position in POM -->
<plugin>
    <groupId>org.eclipse.xtext</groupId>
    <artifactId>xtext-maven-plugin</artifactId>
    <version>2.5.0</version>
    <executions>
        <execution>
            <id>generate-the-stuff</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>

感谢 Gabriel Axel 的文章 http: //www.gabiaxel.com/2011/10/replacing-javac-with-eclipse-compiler.html

这种方法可以解决一些棘手的问题“源到生成的源到源”循环依赖关系，可能无法通过拆分为单独的模块来解决。

另外，我想以最透明的方式集成源代码生成。必须根据生成源的依赖关系重新整理代码肯定会破坏它。我想根据逻辑设计对我的代码进行分组，而不是因为技术细节。

如果您的代码生成器恰好是 xtext，就像我的情况一样，并且您使用 xtext-maven-plugin，比如说新发布的 2.5.0，您不必像上面的示例中那样配置任何内容，该插件完全按照下面的方式执行引擎盖。