maven工程怎么将除工程源码外的三方依赖一起打包到jar中

前言

现在，大家都在使用springboot来创建工程，基本很少关注打包的问题，springboot的spring boot maven plugin可以很方便的创建一个可执行的jar文件，并且包含项目的所有依赖。最近改一个老项目，纯maven项目，引入依赖后，编译通过，然后打包后，执行jar文件，总是提示类找不到，一番排查，忘记添加打包插件了。默认情况下，maven只会打包我们自己写的源码，并不会把引入的其他依赖一块打到jar里。

方法一：使用Maven Assembly Plugin插件打包

在pom.xml中添加Maven Assembly Plugin 配置：

xml 复制代码

<build>  
    <plugins>  
        <plugin>  
            <groupId>org.apache.maven.plugins</groupId>  
            <artifactId>maven-assembly-plugin</artifactId>  
            <version>3.3.0</version> <!-- 请根据需要选择最新版本 -->  
            <configuration>  
                <archive>  
                    <manifest>  
                        <mainClass>com.example.MainClass</mainClass> <!-- 替换为你的主类 -->  
                    </manifest>  
                </archive>  
                <descriptorRefs>  
                    <descriptorRef>jar-with-dependencies</descriptorRef>  
                </descriptorRefs>  
                 <appendAssemblyId>false</appendAssemblyId>
            </configuration>  
            <executions>  
                <execution>  
                    <id>make-assembly</id>  
                    <phase>package</phase>  
                    <goals>  
                        <goal>single</goal>  
                    </goals>  
                </execution>  
            </executions>  
        </plugin>  
    </plugins>  
</build>

注意：1、当工程中没有主类时

xml 复制代码

                <archive>  
                    <manifest>  
                        <mainClass>com.example.MainClass</mainClass> <!-- 替换为你的主类 -->  
                    </manifest>  
                </archive>

可以省略。

2、 <appendAssemblyId>false</appendAssemblyId>这行代码，默认不写的时候，值为true。它能干啥呢？

当默认不写这行代码的时候，你执行打包完成后，会得到两个.jar结尾的jar文件。一个为 p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar

和一个为 p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}-jar-with-dependencies.jar这么两个文件。

（1） p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar

只包含我们开发时编写的代码

（2） p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}-jar-with-dependencies.jar

包含我们开发时编写的代码和引入的第三方依赖的源代码

那么问题就来了，我们想要文件名称为 p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar，同时还需要jar文件中包含所有的依赖，怎么办呢？配置上 <appendAssemblyId>false</appendAssemblyId>这样代码就ok了。按照字面翻译appendAssemblyId追加组装标识，说的就是jar-with-dependencies这个文件名的后缀。

方法二：使用Maven Shade Plugin插件打包

在 pom.xml 中添加 Maven Shade Plugin 配置：

xml 复制代码

<build>  
    <plugins>  
        <plugin>  
            <groupId>org.apache.maven.plugins</groupId>  
            <artifactId>maven-shade-plugin</artifactId>  
            <version>3.2.4</version> <!-- 请根据需要选择最新版本 -->  
            <executions>  
                <execution>  
                    <phase>package</phase>  
                    <goals>  
                        <goal>shade</goal>  
                    </goals>  
                    <configuration>  
                        <transformers>  
                            <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">  
                                <mainClass>com.example.MainClass</mainClass> <!-- 替换为你的主类 -->  
                            </transformer>  
                        </transformers>  
                    </configuration>  
                </execution>  
            </executions>  
        </plugin>  
    </plugins>  
</build>

注意：1、当没有主类时，

xml 复制代码

            <configuration>
              <transformers>
                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <mainClass>com.example.MainClass</mainClass> <!-- 替换为你的主类 -->
                </transformer>
              </transformers>
            </configuration>

这段代码可以省略。

2、使用maven-shade-plugin打包完的也得到两个jar文件。 p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar和original- p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar 这两个。

（1） p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar

包含开发时我们写的代码，和引入的第三方依赖的源码

（2）original- p r o j e c t . a r t i f a c t I d − {project.artifactId}- project.artifactId−{project.version}.jar

只包含开发时我们写的代码

总结

方法一和方法二都可以实现将代码打包成jar文件，通过比较我们发现方法二在代码量上更是好更简洁，生成的文件也更直观，不用特殊配置去掉后缀。总体来讲，两种方式都比较实用，针对个人情况，自行选择即可。

翻了一下，spring boot maven plugin的源码，发现它的底层原来也是用maven-shade-plugin来实现的。其实估计大家也能猜到个大概，毕竟也就这么写主流的技术。