java 基于maven多模块合并打包部署的操作过程

下面我将详细讲解“java 基于maven多模块合并打包部署的操作过程”的完整攻略。

一、背景知识

在使用 Maven 管理多模块 Java 项目时，通常会出现需要将多个子模块合并成为一个独立的可部署应用程序的情况。本攻略的目的就是帮助你完成这一操作。

二、操作步骤

以下是基于 Maven 的多模块合并打包部署的操作步骤：

1. 创建一个 Maven 项目

首先，你需要创建一个 Maven 多模块项目，通过该项目管理所有需要合并部署的子模块。可以使用以下命令去创建 Maven 项目：

mvn archetype:generate -DgroupId=com.example \
  -DartifactId=my-project \
  -DarchetypeArtifactId=maven-archetype-quickstart \
  -DinteractiveMode=false

2. 将需要合并部署的子模块添加到项目中

在创建的 Maven 项目中，你需要把所有需要合并部署的子模块添加到项目中，具体可以通过如下命令创建一个子模块：

mvn archetype:generate \
  -DgroupId=com.example \
  -DartifactId=my-module \
  -DarchetypeArtifactId=maven-archetype-quickstart \
  -DinteractiveMode=false

3. 配置多模块项目的 pom.xml 文件

在项目的根目录下的 pom.xml 文件中配置所有子模块的代码，如下：

<project>
    <groupId>com.example</groupId>
    <artifactId>my-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>module1</module>
        <module>module2</module>
    </modules>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.1.1</version>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <archive>
                                <manifest>
                                    <mainClass>com.example.Main</mainClass>
                                </manifest>
                            </archive>
                            <finalName>${project.artifactId}</finalName>
                            <appendAssemblyId>false</appendAssemblyId>
                            <descriptors>
                                <descriptor>src/main/assembly/assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

4. 配置子模块的 pom.xml 文件

在子模块的 pom.xml 文件中添加 module 标签指定父级，如下：

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>my-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>module1</artifactId>
    <packaging>jar</packaging>
</project>

5. 配置打包文件的 descriptor 文件

在根目录下的 src/main/assembly 目录下创建一个 assembly.xml 的文件，该文件用于定义打包文件的描述器，如下：

<assembly>
    <id>bin</id>
    <formats>
        <format>tar.gz</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <moduleSets>
        <moduleSet>
            <useAllReactorProjects>true</useAllReactorProjects>
            <includes>
                <include>${project.groupId}:*</include>
            </includes>
            <binaries>
                <outputDirectory>/</outputDirectory>
                <unpack>false</unpack>
            </binaries>
        </moduleSet>
    </moduleSets>
</assembly>

6. 执行打包命令

最后，在项目的根目录下执行以下命令：

mvn clean package

这样，就完成了多模块的合并打包操作。你可以在 target 目录下找到生成的打包文件。

三、示例

以下是两个基于 Maven 的多模块合并打包部署的示例：

示例一

假设你有一个需要合并打包的 Maven 项目，它有如下三个子模块：

my-project/
    module1/
    module2/
    module3/

通过 Apache Maven 打包工具，将三个模块部署到一个独立的应用程序中，具体步骤见上。

示例二

假设你有一个 SpringBoot 项目，其中包含以下两个模块：

my-project/
    web/
    service/

需要将这两个模块合并打包，部署到一个 Tomcat 服务器中。具体步骤如下：

首先，在工程的 pom.xml 文件中添加以下配置：

<packaging>war</packaging>

<!-- 略去其他配置 -->

然后在 web 和 service 模块的 pom.xml 文件中分别添加以下配置：

<packaging>jar</packaging>

<build>
    <plugins>
        <!-- 略去其他配置 -->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

<!-- 略去其他配置 -->

最后，在项目的根目录下执行以下命令：

mvn clean package

运行以上命令后，将在 target 目录下生成一个名为 my-project.war 的文件。

将该文件拷贝至 Tomcat 的 webapps 目录中，并启动 Tomcat！

这样，就完成了多模块的合并打包操作，并将项目部署到了一个 Tomcat 服务器中。

四、总结

在本攻略中，我们了解了如何使用 Maven 管理多模块 Java 项目，并将多个子模块合并成为一个独立的可部署应用程序。同时，我们还提供了两个基于 Maven 的多模块合并打包部署的示例供参考。希望对大家有所帮助！