如何在Maven中清洁封装时保护自动生成的源码?

2022-03-28 00:00:00 java maven cxf xjc

我有一个maven配置文件,它触发xsdwsdl类的自动生成,如下所示:

    <plugin>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-xjc-plugin</artifactId>
        <version>${cxf-xjc-plugin}</version>
        <executions>
            <execution>
                <id>generate-sources</id>
                <phase>generate-sources</phase>

                <configuration>
                    <sourceRoot>${project.build.directory}/generated/src/main/java</sourceRoot>
                    <xsdOptions>
                        //xsds, wsdls etc
                    </xsdOptions>
                </configuration>
                <goals>
                    <goal>xsdtojava</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

生成的类转到:target/generated/src/main/java

问题:运行‘MVN CLEAN PACKET’将始终删除这些类。我怎么才能防止它呢?是否可以让clean删除target目录中除generated/目录之外的全部内容?


解决方案

可以不使用maven-clean-plugin删除某些目录,但这绝对不是一个好主意:

  • 这违反了Maven的惯例
  • 每次希望生成这些类时,它都会强制您更改POM

您确切问题的解决方案(不推荐)

您可以使用excludeDefaultDirectoriesfilesets参数排除maven-clean-plugin目录:

<plugin>
    <artifactId>maven-clean-plugin</artifactId>
    <version>2.6.1</version>
    <configuration>
        <excludeDefaultDirectories>true</excludeDefaultDirectories>
        <filesets>
            <fileset>
                <directory>${project.build.directory}</directory>
                <excludes>
                    <exclude>generated/*</exclude>
                </excludes>
            </fileset>
        </filesets>
    </configuration>
</plugin>

请注意,我强烈建议您不要使用此解决方案。

建议的解决方案

您的实际问题不是每次构建时都重新生成类,因为这需要花费很多时间。目标是避免使用自定义配置文件生成:

<profiles>
    <profile>
        <id>noGenerate</id>
        <properties>
            <xjc.generate>none</xjc.generate>
        </properties>
    </profile>
    <profile>
        <id>generate</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <xjc.generate>generate-sources</xjc.generate>
        </properties>
    </profile>
</profiles>

具有以下插件定义:

<plugin>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-xjc-plugin</artifactId>
    <version>${cxf-xjc-plugin}</version>
    <executions>
        <execution>
            <id>generate-sources</id>
            <phase>${xjc.generate}</phase>
            <configuration>
                <sourceRoot>${project.build.directory}/generated/src/main/java</sourceRoot>
                <xsdOptions>
                    //xsds, wsdls etc
                </xsdOptions>
            </configuration>
            <goals>
                <goal>xsdtojava</goal>
            </goals>
        </execution>
    </executions>
</plugin>

似乎cxf-xjc-plugin没有任何skip参数,所以当我们想要避免执行时,必须将phase设置为none(这是一个未记录的功能,但它是有效的)。

诀窍是定义两个配置文件:一个在默认情况下激活,设置一个属性告诉cxf-xjc-plugingenerate-soures阶段执行,而另一个设置一个属性告诉cxf-xjc-plugin不要执行。

因此,当您想要生成类时,可以使用mvn clean install调用Maven,而当您不想生成类时,可以使用mvn clean install -PnoGenerate调用Maven。

这里真正的好处和好处是,您不需要在每次决定是否生成类时都更改POM。

相关文章