利用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是否可执行