java - with - spring boot maven build jar




如何使用Maven創建具有依賴關係的可執行JAR? (20)

我想將我的項目打包在一個可執行的JAR中進行分發。

如何將所有依賴JAR的Maven項目打包到我的輸出JAR中?


Ken Liu在我看來是正確的。 maven依賴插件允許您擴展所有依賴項,然後您可以將其視為資源。 這允許您將它們包含在工件中。 使用程序集插件會創建一個難以修改的輔助工件 - 在我的情況下,我想添加自定義清單條目。 我的pom最終成了:

<project>
 ...
 <build>
  <plugins>
   <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
     <execution>
      <id>unpack-dependencies</id>
      <phase>package</phase>
      <goals>
       <goal>unpack-dependencies</goal>
      </goals>
     </execution>
    </executions>
   </plugin>
  </plugins>
  ...
  <resources>
   <resource>
    <directory>${basedir}/target/dependency</directory>
    <targetPath>/</targetPath>
   </resource>
  </resources>
 </build>
 ...
</project>


使用onejar插件將其構建為一個可執行jar文件,該文件將所有依賴jar包裝在其中。 這解決了我的問題,類似於此。 當使用程序集插件時,它將所有依賴jar解壓縮到源文件夾中並將它們重新打包為jar,它已經覆蓋了我在代碼中具有相同類名的所有類似實現。 onejar在這裡是一個簡單的解決方案。


使用maven-assembly-plugin-2.2.1查找共享程序集文件的問題?

嘗試使用descriptorId配置參數而不是descriptors / descriptor或descriptorRefs / descriptorRef參數。

他們都沒有做你需要的:在類路徑上查找文件。 當然,您需要在maven-assembly-plugin的類路徑中添加共享程序集所在的包(請參閱下文)。 如果您使用的是Maven 2.x(而不是Maven 3.x),則可能需要在pluginManagement部分的最頂級父pom.xml中添加此依賴項。

有關詳細信息,請參閱this

類:org.apache.maven.plugin.assembly.io.DefaultAssemblyReader

例:

        <!-- Use the assembly plugin to create a zip file of all our dependencies. -->
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.2.1</version>
            <executions>
                <execution>
                    <id>make-assembly</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                    <configuration>
                        <descriptorId>assembly-zip-for-wid</descriptorId>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>cz.ness.ct.ip.assemblies</groupId>
                    <artifactId>TEST_SharedAssemblyDescriptor</artifactId>
                    <version>1.0.0-SNAPSHOT</version>
                </dependency>
            </dependencies>
        </plugin>

如果你想從命令行本身。 只需從項目路徑運行以下命令即可

mvn彙編:彙編


如果你真的想要在你的單個結果JAR中重新打包其他JAR內容,那麼另一個選擇是Maven Assembly插件 。 它解壓縮然後通過<unpack>true</unpack>所有內容重新打包到目錄中。 然後你會有第二遍將它構建成一個巨大的JAR。

onejar-maven-plugin 。 這將一步完成上述重新打包操作。


對我有用的東西是:

  <plugin>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
      <execution>
        <id>unpack-dependencies</id>
        <phase>prepare-package</phase>
        <goals>
          <goal>unpack-dependencies</goal>
        </goals>
        <configuration>
          <outputDirectory>${project.build.directory}/classes</outputDirectory>
        </configuration>
      </execution>

    </executions>
  </plugin>


  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <executions>
      <execution>
        <id>unpack-dependencies</id>
        <phase>package</phase>
      </execution>
    </executions>
    <configuration>
      <archive>
        <manifest>
          <addClasspath>true</addClasspath>
          <classpathPrefix>lib/</classpathPrefix>
          <mainClass>SimpleKeyLogger</mainClass>
        </manifest>
      </archive>
    </configuration>
  </plugin>

我有特殊情況,因為我的依賴是系統一:

<dependency>
  ..
  <scope>system</scope>
  <systemPath>${project.basedir}/lib/myjar.jar</systemPath>
</dependency>

我更改了@ user189057提供的代碼更改:1)maven-dependency-plugin在“prepare-package”階段執行2)我正在將解壓縮的classess直接提取到“target / classes”


對於任何尋找從超級jar中排除特定依賴項的選項的人來說,這是一個對我有用的解決方案:

<project...>
<dependencies>
        <dependency>
            <groupId>org.apache.spark</groupId>
            <artifactId>spark-core_2.11</artifactId>
            <version>1.6.1</version>
            <scope>provided</scope> <=============
        </dependency>
</dependencies>
<build>
        <plugins>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>...</mainClass>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

所以它不是mvn-assembly-plugin的配置,而是依賴的屬性。


您可以使用maven-dependency-plugin,但問題是如何創建可執行JAR。 要做到這一點,需要對Matthew Franglen的響應進行以下更改(順便說一句,使用依賴插件從清理目標開始時需要更長時間才能構建):

<build>
    <plugins>
        <plugin>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>fully.qualified.MainClass</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>unpack-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>unpack-dependencies</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
    <resources>
        <resource>
            <directory>${basedir}/target/dependency</directory>
        </resource>
    </resources>
</build>

您可以使用maven-shade插件來構建如下所示的超級jar

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

我不會像其他人之前已經做過的那樣直接回答這個問題,但我真的很想知道將所有依賴項嵌入項目的jar本身是否是個好主意。

我看到了重點(易於部署/使用),但它取決於你的項目的用例(並且可能有替代方案(見下文))。

如果你完全獨立使用它,為什麼不。

但是如果你在其他環境中使用你的項目(比如在webapp中,或者放在其他jar所在的文件夾中),你的類路徑中可能有jar副本(文件夾中的那​​些,jar中的那個)。 也許不是出價協議,但我通常會避免這種情況。

一個很好的選擇:

  • 將您的應用程序部署為.zip / .war:存檔包含項目的jar和所有相關的jar;
  • 使用動態類加載器機制(請參閱Spring,或者您可以輕鬆地自己完成),以獲得項目的單個入口點(單個類開始 - 請參閱另一個答案的Manifest機制),它將(動態)添加到當前的classpath所有其他需要的罐子。

像這樣,最後只有一個清單和一個“特殊的動態類加載器主”,你可以用以下方式啟動你的項目:

java -jar ProjectMainJar.jar com..projectName.MainDynamicClassLoaderClass

我在博客上寫了一些不同的方法來做到這一點。

請參閱使用Apache Maven的可執行jar (WordPress)

或者executable-jar-with-maven-example (GitHub)

筆記

這些優點和缺點由Stephan提供。

用於手動部署

  • 優點
  • 缺點
    • 依賴性超出了最後的jar。

將依賴項複製到特定目錄

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-dependency-plugin</artifactId>
  <executions>
    <execution>
      <id>copy-dependencies</id>
      <phase>prepare-package</phase>
      <goals>
        <goal>copy-dependencies</goal>
      </goals>
      <configuration>
        <outputDirectory>${project.build.directory}/${project.build.finalName}.lib</outputDirectory>
      </configuration>
    </execution>
  </executions>
</plugin>

使Jar可執行文件和類路徑感知

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-jar-plugin</artifactId>
  <configuration>
    <archive>
      <manifest>
        <addClasspath>true</addClasspath>
        <classpathPrefix>${project.build.finalName}.lib/</classpathPrefix>
        <mainClass>${fully.qualified.main.class}</mainClass>
      </manifest>
    </archive>
  </configuration>
</plugin>

此時, jar實際上可以使用外部類路徑元素執行。

$ java -jar target/${project.build.finalName}.jar

製作可部署的檔案

jar文件只能與兄弟...lib/目錄一起執行。 我們需要使用目錄及其內容來部署存檔。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-antrun-plugin</artifactId>
  <executions>
    <execution>
      <id>antrun-archive</id>
      <phase>package</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <target>
          <property name="final.name" value="${project.build.directory}/${project.build.finalName}"/>
          <property name="archive.includes" value="${project.build.finalName}.${project.packaging} ${project.build.finalName}.lib/*"/>
          <property name="tar.destfile" value="${final.name}.tar"/>
          <zip basedir="${project.build.directory}" destfile="${final.name}.zip" includes="${archive.includes}" />
          <tar basedir="${project.build.directory}" destfile="${tar.destfile}" includes="${archive.includes}" />
          <gzip src="${tar.destfile}" destfile="${tar.destfile}.gz" />
          <bzip2 src="${tar.destfile}" destfile="${tar.destfile}.bz2" />
        </target>
      </configuration>
    </execution>
  </executions>
</plugin>

現在你有target/${project.build.finalName}.(zip|tar|tar.bz2|tar.gz) ,每個包含jarlib/*

Apache Maven Assembly插件

  • 優點
  • 缺點
    • 沒有類重定位支持(如果需要類重定位,請使用maven-shade-plugin)。
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>single</goal>
      </goals>
      <configuration>
        <archive>
          <manifest>
            <mainClass>${fully.qualified.main.class}</mainClass>
          </manifest>
        </archive>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
      </configuration>
    </execution>
  </executions>
</plugin>

你有target/${project.bulid.finalName}-jar-with-dependencies.jar

Apache Maven Shade插件

  • 優點
  • 缺點
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <executions>
    <execution>
      <goals>
        <goal>shade</goal>
      </goals>
      <configuration>
        <shadedArtifactAttached>true</shadedArtifactAttached>
        <transformers>
          <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
            <mainClass>${fully.qualified.main.class}</mainClass>
          </transformer>
        </transformers>
      </configuration>
    </execution>
  </executions>
</plugin>

你有target/${project.build.finalName}-shaded.jar

onejar - Maven的插件

  • 優點
  • 缺點
    • 自2012年以來未得到積極支持
<plugin>
  <!--groupId>org.dstovall</groupId--> <!-- not available on the central -->
  <groupId>com.jolira</groupId>
  <artifactId>onejar-maven-plugin</artifactId>
  <executions>
    <execution>
      <configuration>
        <mainClass>${fully.qualified.main.class}</mainClass>
        <attachToBuild>true</attachToBuild>
        <!-- https://code.google.com/p/onejar-maven-plugin/issues/detail?id=8 -->
        <!--classifier>onejar</classifier-->
        <filename>${project.build.finalName}-onejar.${project.packaging}</filename>
      </configuration>
      <goals>
        <goal>one-jar</goal>
      </goals>
    </execution>
  </executions>
</plugin>

Spring Boot Maven插件

  • 優點
  • 缺點
    • 添加潛在的不必要的Spring和Spring Boot相關類。
<plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <executions>
    <execution>
      <goals>
        <goal>repackage</goal>
      </goals>
      <configuration>
        <classifier>spring-boot</classifier>
        <mainClass>${fully.qualified.main.class}</mainClass>
      </configuration>
    </execution>
  </executions>
</plugin>

你有target/${project.bulid.finalName}-spring-boot.jar


我經歷了這些響應中的每一個都希望製作一個包含所有依賴項的胖可執行jar,但它們都沒有正常工作。 答案是陰影插件,它非常簡單直接。

    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-shade-plugin</artifactId>
      <version>2.3</version>
      <executions>
         <!-- Run shade goal on package phase -->
        <execution>
        <phase>package</phase>
        <goals>
            <goal>shade</goal>
        </goals>
        <configuration>
          <transformers>
             <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                <mainClass>path.to.MainClass</mainClass>
             </transformer>
          </transformers>
        </configuration>
          </execution>
      </executions>
    </plugin>

請注意,您的依賴項需要具有編譯或運行時範圍才能使其正常工作。

這個例子來自mkyong.com


採取未答复的答案並重新格式化,我們有:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <mainClass>fully.qualified.MainClass</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
        </plugin>
    </plugins>
</build>

接下來,我建議將其作為構建的一部分,而不是明確調用。 要使其成為構建中不可或缺的一部分,請將此插件添加到pom.xml並將其綁定到package生命週期事件。 但是,一個問題是你需要調用assembly:single如果將它放在pom.xml中, assembly:single目標,而如果從命令行手動執行它,則調用'assembly:assembly'。

<project>
  [...]
  <build>
      <plugins>
          <plugin>
              <artifactId>maven-assembly-plugin</artifactId>
              <configuration>
                  <archive>
                      <manifest>
                          <addClasspath>true</addClasspath>
                          <mainClass>fully.qualified.MainClass</mainClass>
                      </manifest>
                  </archive>
                  <descriptorRefs>
                      <descriptorRef>jar-with-dependencies</descriptorRef>
                  </descriptorRefs>
              </configuration>
              <executions>
                  <execution>
                      <id>make-my-jar-with-dependencies</id>
                      <phase>package</phase>
                      <goals>
                          <goal>single</goal>
                      </goals>
                  </execution>
              </executions>
          </plugin>
      [...]
      </plugins>
    [...]
  </build>
</project>

這也可以是一個選項,您將能夠構建您的jar文件

<build>
    <plugins>
        <plugin>
            <!-- Build an executable JAR -->
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.4</version>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>lib/</classpathPrefix>
                        <mainClass>WordListDriver</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

這是我們在Credit Karma使用的Maven的可執行jar插件。 它創建了一個jar罐,其中包含一個能夠從嵌套jar加載類的類加載器。 這允許您在dev和prod中具有相同的類路徑,並且仍將所有類保留在單個簽名的jar文件中。

https://github.com/creditkarma/maven-exec-jar-plugin

這裡有一篇博客文章,詳細介紹了插件以及我們製作插件的原因: https://engineering.creditkarma.com/general-engineering/new-executable-jar-plugin-available-apache-maven/https://engineering.creditkarma.com/general-engineering/new-executable-jar-plugin-available-apache-maven/


長期使用maven程序集插件 ,但我找不到"already added, skipping"問題的解決方案。 現在,我正在使用另一個插件 - onejar-maven-plugin 。 下面的例子( mvn package構建jar):

<plugin>
    <groupId>org.dstovall</groupId>
    <artifactId>onejar-maven-plugin</artifactId>
    <version>1.3.0</version>
    <executions>
        <execution>
            <configuration>
                <mainClass>com.company.MainClass</mainClass>
            </configuration>
            <goals>
                <goal>one-jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

您需要為該插件添加存儲庫:

<pluginRepositories>
    <pluginRepository>
        <id>onejar-maven-plugin.googlecode.com</id>
        <url>http://onejar-maven-plugin.googlecode.com/svn/mavenrepo</url>
    </pluginRepository>
</pluginRepositories>

maven-assembly-plugin對我很有用。我花了幾個小時使用maven-dependency-plugin並且無法使其工作。主要原因是我必須在配置部分明確定義應該包含的工件項,如documentation中所述。有一個例子,當你想要使用它時,例如:mvn dependency:copy,其中沒有包含任何artifactItem但它不起作用。


我比較了這篇文章中提到的樹插件。我生成了2個罐子和一個包含所有罐子的目錄。我比較了結果,絕對是maven-shade-plugin是最好的。我的挑戰是我有多個需要合併的spring資源,以及jax-rs和JDBC服務。與maven-assembly-plugin相比,它們都被shade插件正確合併。在這種情況下,彈簧將失敗,除非您將它們複製到您自己的資源文件夾並手動合併它們一次。兩個插件都輸出正確的依賴樹。我有多個範圍,如測試,提供,編譯等測試和提供被兩個插件跳過。它們都產生了相同的清單,但我能夠使用變壓器將許可證與陰影插件合併。有了maven-dependency-plugin,你當然不會這些問題是因為沒有提取罐子。但正如其他一些人指出的那樣,你需要攜帶一個額外的文件才能正常工作。這是pom.xml的一個片段

            <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.directory}/lib</outputDirectory>
                        <includeScope>compile</includeScope>
                        <excludeTransitive>true</excludeTransitive>
                        <overWriteReleases>false</overWriteReleases>
                        <overWriteSnapshots>false</overWriteSnapshots>
                        <overWriteIfNewer>true</overWriteIfNewer>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.6</version>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <mainClass>com.rbccm.itf.cdd.poller.landingzone.LandingZonePoller</mainClass>
                    </manifest>
                </archive>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
            <executions>
                <execution>
                    <id>make-my-jar-with-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>2.4.3</version>
            <configuration>
                <shadedArtifactAttached>false</shadedArtifactAttached>
                <keepDependenciesWithProvidedScope>false</keepDependenciesWithProvidedScope>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/services/javax.ws.rs.ext.Providers</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.factories</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.handlers</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.schemas</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.tooling</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"/>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer">
                    </transformer>
                </transformers>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

為了解決這個問題,我們將使用Maven Assembly Plugin,它將JAR與其依賴JAR一起創建到一個可執行的JAR文件中。只需在pom.xml文件中添加以下插件配置即可。

<build>
   <pluginManagement>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
               <archive>
                  <manifest>
                     <addClasspath>true</addClasspath>
                     <mainClass>com.your.package.MainClass</mainClass>
                  </manifest>
               </archive>
               <descriptorRefs>
                  <descriptorRef>jar-with-dependencies</descriptorRef>
               </descriptorRefs>
            </configuration>
            <executions>
               <execution>
                  <id>make-my-jar-with-dependencies</id>
                  <phase>package</phase>
                  <goals>
                     <goal>single</goal>
                  </goals>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </pluginManagement>
</build>

執行此操作後,不要忘記使用此命令運行MAVEN工具mvn clean compile assembly:single

http://jkoder.com/maven-creating-a-jar-together-with-its-dependency-jars-into-a-single-executable-jar-file/





executable-jar