springboot结合maven实现多模块打包

更新时间：2023年04月21日 08:32:29 作者：IT人的天地

本文主要介绍了springboot借助maven完成多模块打包，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

我们平时在开发系统时，一般我们的系统工程会被分为多个模块，一个原因是方便协同开发，系统间解耦，另外一个很重要的原因是：别的系统需要依赖我们系统的部分功能，我们可能将这部分功能划分到一个模块里面，单独打包提供给对方。现在我将通过一个示例工程来演示如何借助maven完成springboot应用的多模块打包的操作。

要点：

1、工程存在多个模块，模块间有依赖关系

2、父工程维护工程的主版本号，子模块直接引用父工程定义的版本号的变量

3、借助flatten-maven-plugin插件完成子模块pom文件中引用的父工程变量的替换工作

1、工程结构

test工程结构

test
--test-api
  --src
    --main
  --pom.xml
--test-core
  --src
    --main
      --java
      --resouce
    --test
--pom.xml

其中test-api模块为共用模块，test-core模块依赖test-api模块。后续也会有其他系统依赖test-api模块，因此需要将test-api模块发布到maven私服。

2、工程模块pom文件配置

2.1、父模块pom配置

<?xml version="1.0" encoding="UTF-8"?>
<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">

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>test</artifactId>
    <version>${revision}</version>
    <packaging>pom</packaging>
    <modules>
        <module>test-api</module>
        <module>test-core</module>
    </modules>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <revision>1.0.0</revision>
    </properties>
   <!--发布到远程仓库的配置-->
    <distributionManagement>
        <repository>
            <id>releases</id>
            <name>releases</name>
            <url>http://192.168.1.1/repository/releases/</url>
        </repository>

        <snapshotRepository>
            <id>snapshots</id>
            <url>http://192.168.1.1/repository/snapshots/</url>
        </snapshotRepository>

    </distributionManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>flatten-maven-plugin</artifactId>
                <version>1.4.1</version>
                <configuration>
                </configuration>
                <executions>
                    <!-- enable flattening -->
                    <execution>
                        <id>flatten</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>flatten</goal>
                        </goals>
                    </execution>
                    <!-- ensure proper cleanup -->
                    <execution>
                        <id>flatten.clean</id>
                        <phase>clean</phase>
                        <goals>
                            <goal>clean</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>


</project>

父模块很重要的一个配置就是flatten-maven-plugin这个插件，用于打包时替换子模块中pom文件的引用的父工程的变量，比如revision变量。如果不添加此插件，虽然打包时不会报错，但是别的系统引用test-api.jar的时候，会出现类似Could not find artifact org.example:test:pom:${revision} in nexus-aliyun 的错误，主要原因就是子模块中引用的父工程的变量未被替换导致的

2.2、test-api模块配置

<?xml version="1.0" encoding="UTF-8"?>
<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>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>test</artifactId>
        <version>${revision}</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>test-api</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>

    </dependencies>

</project>

test-api模块的pom文件指定父工程时，version参数用变量表示，方便对版本号的维护。后续升级系统的版本号，只需要修改父工程中的revision变量即可。打包时，子模块pom文件中的revision会被替换成revision的真实值，此处打包后jar包里的pom文件的{revision}会被替换成revision的真实值，此处打包后jar包里的pom文件的revision会被替换成revision的真实值，此处打包后jar包里的pom文件的{revision}会被替换成1.0.0

2.3、test-core模块配置

<?xml version="1.0" encoding="UTF-8"?>
<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>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>test</artifactId>
        <version>${revision}</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>test-core</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <!--跳过部署，执行deploy时不将本模块部署到仓库-->
        <maven.deploy.skip>true</maven.deploy.skip>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>test-api</artifactId>
            <version>${revision}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

</project>

test-core模块直接依赖test-api模块，通过revison参数动态引用父工程中指定的版本号。将test−core打包后，test−core.jar包中的pom文件中的{revison}参数动态引用父工程中指定的版本号。将test-core打包后，test-core.jar包中的pom文件中的revison参数动态引用父工程中指定的版本号。将test−core打包后，test−core.jar包中的pom文件中的{revision}会被替换成revision参数的实际值1.0.0

3、工程打包

3.1、执行打包

（1）进入test工程根目录，比如我所在工程根目录路径是D:\ideaProject\test，

若执行下述命令，

mvn clean install

test-api模块和test-core模块都会被打包进本地仓库。

（2）如果执行下述命令，test-api模块会被部署到远程仓库，而test-core模块则不会被部署到远程仓库。

mvn clean deploy

（3）如果只想打包test-api模块到本地仓库，或者只想把test-api模块部署到远程仓库，可以进入test-api模块的主目录，比如D:\ideaProject\test\test-api，执行下述命令

#只安装到本地仓库

mvn clean install

#部署到远程仓库(该命令会先把包安装到本地仓库)

mvn clean deploy

3.2、打包效果

已test-api为例，打包后的test-api-1.00.jar文件中的pom.xml文件内容如下所示

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.example</groupId>
  <artifactId>test-api</artifactId>
  <version>1.0.0</version>
  <licenses>
    <license>
      <name>Apache License, Version 2.0</name>
      <url>https://www.apache.org/licenses/LICENSE-2.0</url>
    </license>
  </licenses>
</project>

可以发现，里面引入的父工程的变量已经被成功替换。

参考

1、flatten-maven-plugin官网

到此这篇关于springboot结合maven实现多模块打包的文章就介绍到这了,更多相关springboot maven多模块打包内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

关于Java 并发的 CAS
后端开发锁成为一个不可避免的话题，今天我们讨论的是与之对应的无锁 CAS。本文会从怎么来的、是什么、怎么用、原理分析、遇到的问题等不同的角度带你真正搞懂 CAS。
2021-09-09
探讨Java语言中那些修饰符
在java中常见的修饰符有：abstract(抽象的)、static(静态的)、public(公共的)、protected(受保护的)、private(私有的)、synchronized(同步的)、native(本地的)、transient(暂时的)、volatile(易失的)、final(不可改变的)。对java语言修饰符感兴趣的朋友一起看看吧
2016-11-11
springboot如何读取模板文件
这篇文章主要介绍了springboot如何读取模版文件的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
java 缓冲流的概念使用方法以及实例详解
这篇文章主要为大家介绍了java 缓冲流的概念使用方法以及实例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-06-06
Java中Semaphore信号量的方法解析
这篇文章主要介绍了Java中Semaphore信号量的方法解析, Semaphore信号量是用来控制同时访问特定资源的线程数量,它通过协调各个线程,以保证合理的使用公共资源,需要的朋友可以参考下
2023-12-12
Spring Bean实例化实现过程解析
这篇文章主要介绍了Spring Bean实例化实现过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
在SpringBoot中,如何使用Netty实现远程调用方法总结
我们在进行网络连接的时候,建立套接字连接是一个非常消耗性能的事情,特别是在分布式的情况下,用线程池去保持多个客户端连接,是一种非常消耗线程的行为.那么我们该通过什么技术去解决上述的问题呢,那么就不得不提一个网络连接的利器——Netty,需要的朋友可以参考下
2021-06-06
使用MyBatis查询千万级数据量操作实现
这篇文章主要为大家介绍了如何使用MyBatis 查询千万数据量的操作过程详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
springboot jasypt2.x与jasypt3.x的使用方式
在软件开发中,将配置文件中的敏感信息(如数据库密码)进行加密是保障安全的有效手段,jasypt框架提供了这一功能,支持通过加密工具类或命令行工具生成密文,并通过修改配置文件和启动参数的方式使用密文和密钥,这样即便配置文件被泄露
2024-09-09
SpringBoot的自定义banner使用方法
这篇文章主要介绍了SpringBoot的自定义banner使用方法,在Spring Boot中,你可以通过定制Banner来个性化你的应用程序启动时的输出,Banner是一个在应用程序启动时显示的ASCII艺术字形式的标志,用于增加应用程序的识别度和个性化,需要的朋友可以参考下
2024-01-01