如何利用Maven将代碼打包成第三方公共jar包？

一、摘要

在項目開發過程中，我們經常需要将一些公共方法提取出來，然後單獨封裝成一個第三方公共jar包，采用普通的方式打包後的jar，依賴的工程執行編譯時，卻提示找不到對應的依賴包，那麼如何将工程打包為可執行jar包呢？

下面向大家介紹三種通過maven将工程打包成可執行的打包方式。

二、方法實踐

2.1、assembly插件

2.1.1、pom.xml的相關配置檔案如下

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example.java</groupId>
  <artifactId>example-frame-fatJar</artifactId>
  <version>1.0.0</version>

  .....
  <build>
    <finalName>sso-api</finalName>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.2</version>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
      <!-- maven-assembly-plugin -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>2.6</version>
        <configuration>
          <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
          <encoding>UTF-8</encoding>
        </configuration>
        <executions>
          <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>
           

2.1.2、運作如下指令，進行打包

mvn clean package
           

會在target檔案夾裡生成一個jar-with-dependencies的jar是可執行的。

2.1.3、驗證jar是否可執行

在帶有jar-with-dependencies的jar檔案下，打開終端，輸入如下指令

#驗證jar是否可執行，如果沒有報錯，說明沒有問題
java -jar xxx-jar-with-dependencies.jar
           

2.2、shade插件

2.2.1、pom.xml的相關配置檔案如下

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example.java</groupId>
  <artifactId>example-frame-fatJar</artifactId>
  <version>1.0.0</version>

  ......
  <build>
    <finalName>sso-api</finalName>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.2</version>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
      <!-- maven-shade-plugin，不同的是shade可以将多個相同的配置檔案追加合并 -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>2.4.1</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
            <configuration>
              <transformers>
                <transformer
                  implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <mainClass>com.xxg.Main</mainClass>
                </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>
              </transformers>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>
           

2.2.2、運作如下指令，進行打包

mvn clean package
           

發現生成了2個jar包，一個為：original-XXX.jar，另一個為：XXX.jar，其中original...jar裡隻包含了工程自己的class檔案，而另外的一個jar包則包含了工程本身以及所有依賴的jar包的class檔案。我們隻需要使用第二個jar包就可以了。

2.2.3、驗證jar是否可執行

在XXX.jar檔案下，打開終端，輸入如下指令

#驗證jar是否可執行，如果沒有報錯，說明沒有問題
java -jar XXX.jar
           

不同點：shade可以将多個相同的配置檔案追加合并，比如，多個子項目下有相同的配置檔案，shade在打包的時候，會将相同的配置檔案合并。

2.3、Fatjar打包工具(eclipse插件)

2.3.1、eclipse線上安裝插件

1、打開eclipse，打開菜單help > Install New Sofware > Add...

name：FatJar

URL：http://kurucz-grafika.de/fatjar

根據提示下載下傳安裝并重新開機eclipse！

2.3.2、FatJar使用

在使用Eclipse進行導出時，點選項目右鍵，在彈出的右鍵菜單中選擇Build Fat Jar, 打開配置Fat Jar彈出框；或者，項目右鍵，點選Export，然後在打開的Export選擇框中選擇Other下面的Fat Jar Exporter, 選擇需要導出的項目，點選下一步打開配置Fat Jar彈出框。

2.3.3、驗證jar是否可執行

在XXX.jar檔案下，打開終端，輸入如下指令

#驗證jar是否可執行，如果沒有報錯，說明沒有問題
java -jar XXX.jar
           

三、小結

本文主要圍繞如何将工程打包可執行的第三方jar進行方法介紹，如果有描述不對的地方，歡迎網友批評指出！