maven shaded jar:改变输出位置

时间:2016-02-11 20:32:40

标签: maven jar maven-3 pom.xml maven-shade-plugin

我在使用Maven Shade插件时遇到了困难,因为我希望将我的阴影jar安装到与父pom相同的文件夹中(而不是本地src/target目录)。

布局: maven_project

guide/
   parent_pom.xml
projA/
   pom.xml
projB/
   pom.xml
   /target
      original-projB-0.0.3.jar
      projB-0.0.3.jar (shaded jar) 

我必须导出项目并让其他人更容易运行可执行jar我想将着色jar重定位到guide文件夹。

不幸的是,我尝试使用

<outputDirectory>/home/name/Desktop/maven_project/guide/</outputDirectory>    

但这只会将原始jar移动到目录。

问题:关于如何在那里移动阴影罐的任何想法(甚至删除过程中的原始jar)?

1 个答案:

答案 0 :(得分:5)

默认情况下,Maven Shade Plugin会替换构建生成的原始jar,并创建一个前缀为 original 的副本。

可以通过outputDirectoryoutputFilefinalName配置条目配置替换和重定位。

应用以下配置:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.4</version>
            <executions>
                <execution>
                    <id>default-jar</id>
                    <phase />
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>2.4.3</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <finalName>${project.artifactId}-${project.version}-something</finalName>
                        <outputDirectory>../guide</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

我们是:

  • 首先根据您的要求禁用默认jar的生成,并由this dedicated SO Q/A指定
  • 然后配置Shade插件以将其输出重定位到上部guide文件夹(通过相对路径,更好的方法,也由@Tunaki建议)
  • 还配置finalName元素以禁用替换(这也会影响重定位,在某种意义上也会重定位(前缀)原始jar)。根据{{​​3}},finalName是
      

    着色artifactId的名称。如果您想更改本机工件的名称,可以使用<build><finalName>设置。如果设置为与<build><finalName>不同,则即使正在使用shadedArtifactAttached,也不会执行文件替换。

因此,Maven将仅在配置的位置生成阴影jar。

另一种方法是使用outputFile配置条目,该条目指定:

  

着色工件的输出文件的路径。设置此参数后,创建的存档既不会替换项目的主工件,也不会附加。因此,此参数会导致参数finalName,shadedArtifactAttached,shadedClassifierNamecreateDependencyReducedPom在使用时被忽略。

因此,您可以将上面的配置更改为:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.4</version>
            <executions>
                <execution>
                    <id>default-jar</id>
                    <phase />
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>2.4.3</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <outputFile>../guide/${project.artifactId}-${project.version}-shaded.jar</outputFile>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

并且具有完全相同的行为。

旁注:你真的在这里改变了构建的行为。如果有人只从模块文件夹本身构建一个模块,他/她就不会在target文件夹上找到预期的内容,而是在父文件夹上(有点意外)。

<强>更新
应用上面的配置并仅从命令行调用Shade Plugin

mvn shade:shade

但是,您会遇到以下问题:

[INFO] --- maven-shade-plugin:2.4.3:shade (default-cli) @ test-addjar ---
[ERROR] The project main artifact does not exist. This could have the following
[ERROR] reasons:
[ERROR] - You have invoked the goal directly from the command line. This is not
[ERROR]   supported. Please add the goal to the default lifecycle via an
[ERROR]   <execution> element in your POM and use "mvn package" to have it run.
[ERROR] - You have bound the goal to a lifecycle phase before "package". Please
[ERROR]   remove this binding from your POM such that the goal will be run in
[ERROR]   the proper phase.
[ERROR] - You removed the configuration of the maven-jar-plugin that produces the main artifact.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------