将 Maven 中的多模块项目只打成一个 JAR 包

太过爱你忘了你带给我的痛 2021-09-25 13:22 2645阅读 1赞

### 将 Maven 中的多模块项目只打成一个 JAR 包 ###

1.  假设读者已经编写好了一个可以在编译器中运行的一个 Maven 多模块项目。对于 Maven 多模块项目，应该首先有一个父 pom，它的属性 packaging 为 pom。而它的一个不成为其它模块的父模块的子模块，其属性 packaging 应该为 jar 或 war。
2.  将上面的 Maven 项目只打成一个 JAR 包，可以使用插件 `maven-assembly-plugin`。它有一个目标 single 可以完成此任务。使用该插件打包出来的 JAR 包将会包含完整的依赖，可以在 CMD 下直接运行。
    
    （该插件网址：[https://maven.apache.org/plugins/maven-assembly-plugin/plugin-info.html][https_maven.apache.org_plugins_maven-assembly-plugin_plugin-info.html]）
3.  使用该插件的具体方法为，在需要被打包的模块（这里选择的是父模块）中加入如下配置：
    
        <project...>
        
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-assembly-plugin</artifactId>
                        <version>3.3.0</version>
                        <executions>
                            
                            <execution>
                                <id>make-assembly</id>
                                <phase>package</phase>
                                <goals>
                                    
                                    <goal>single</goal>
                                </goals>
                            </execution>
                        </executions>
                        <configuration>
                            
                            <descriptorRefs>
                                <descriptorRef>jar-with-dependencies</descriptorRef>
                            </descriptorRefs>
                            <archive>
                                <manifest>
                                    <addClasspath>true</addClasspath>
                                    <classpathPrefix>lib/</classpathPrefix>
                                    
                                    <mainClass>包名.类名</mainClass>
                                </manifest>
                            </archive>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        
        </project>
4.  如果读者想偷懒，可以只更改上述配置的两处位置：
    
    1.  `<mainClass>包名.类名</mainClass>`：将其改为读者自己模块的程序运行入口所在的类的类名。
    2.  `<version>3.3.0</version>`：将其改为读者当时打包时，本插件 `maven-assembly-plugin` 的最新版本。
5.  如果读者想要打包后的目录更有条理，可以去掉上面 `<configuration/...>` 中的 `<descriptorRefs/...>`，而改用 `<descriptors/...>`。由于笔者没有这样的需求，因此对这方面不做详细介绍，有兴趣的读者可以查阅其它资料。
6.  上面的配置完成之后，在进行该配置的模块目录下执行如下命令：`mvn package assembly:single`。这会为其下的各个模块各做一次打包，生成的 JAR 包将输出至每个模块的文件夹 target 中。这里要注意的是，此插件会根据依赖关系进行打包，只有依赖各个模块的那个“核心模块”下的 JAR 包中才有完整的依赖。如果一个模块不依赖于其它模块，则此模块生成的 JAR 包将不包含其它模块。因此，主 pom 生成的 JAR 包里不会有任何有意义的内容。读者需要自行找到自己“核心模块”下的 JAR 包。
    
    【踩坑提醒】
    
    1.  不要使用命令 `mvn package` 进行打包。这样生成的 JAR 包是不完整的。
    2.  不要使用命令 `mvn assembly:single` 进行打包。这样生成的 JAR 包是不完整的，且会有如下报错：
        
        `Cannot include project artifact: XXX; it doesn't have an associated file or directory.`
    3.  不要使用 IntelliJ IDEA 中内置的界面选项进行打包。这样生成的 JAR 包是不完整的，且会有如下报错：
        
        `Cannot include project artifact: XXX; it doesn't have an associated file or directory.`
        
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center]
    4.  不要去掉配置中的 `<archive/...>`，否则会有报错：
        
        `[ERROR] Failed to execute goal org.apache.maven.plugins:maven-assembly-plugin:3.3.0:single (make-assembly) on project XXX: Failed to create assembly: Error creating asse mbly archive jar-with-dependencies: archive cannot be empty -> [Help 1]`
7.  如果完成了上面的操作，打出来的应该是一个可以在 CMD 中单独运行的 JAR 包。在 CMD 中运行 JAR 包的方法是，使用命令：`java -jar xxx.jar`。

[https_maven.apache.org_plugins_maven-assembly-plugin_plugin-info.html]: https://maven.apache.org/plugins/maven-assembly-plugin/plugin-info.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center]: /images/20210923/3babab640a6d4760a6d0dfa81560b99a.png