java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot父子工程POM依赖关系

Spring Boot父子工程POM依赖关系举例详解

作者:TracyCoder123

这篇文章主要介绍了Spring Boot父子工程POM依赖关系的相关资料,Spring Boot父子工程通过Maven继承机制实现统一版本、依赖和插件管理,模块化开发与代码复用,提升项目可维护性与效率,需要的朋友可以参考下

1. 父子工程概述

Spring Boot 父子工程是一种多模块项目结构,通过 Maven 的继承机制来管理依赖关系。这种结构具有以下优势:

2. 项目结构

spring-boot-parent/
├── parent-pom.xml          # 父工程POM
├── common/                 # 公共工具模块
│   └── pom.xml
├── api/                    # API接口模块
│   └── pom.xml
├── service/                # 业务服务模块
│   └── pom.xml
└── web/                    # Web应用启动模块
    └── pom.xml

3. 父工程 POM 详解

3.1 基本信息配置

<groupId>com.example</groupId>
<artifactId>spring-boot-parent</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>  <!-- 关键:父工程必须是pom类型 -->

3.2 子模块声明

<modules>
    <module>common</module>
    <module>api</module>
    <module>service</module>
    <module>web</module>
</modules>

3.3 版本统一管理

<properties>
    <spring-boot.version>3.2.0</spring-boot.version>
    <spring-cloud.version>2023.0.0</spring-cloud.version>
    <mysql.version>8.0.33</mysql.version>
    <!-- 其他版本号... -->
</properties>

3.4 依赖管理 (dependencyManagement)

重要概念dependencyManagement 不会直接引入依赖,只是管理版本号。

<dependencyManagement>
    <dependencies>
        <!-- Spring Boot 依赖管理 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring-boot.version}</version>
            <type>pom</type>
            <scope>import</scope>  <!-- 导入Spring Boot的依赖管理 -->
        </dependency>
        
        <!-- 自定义依赖版本管理 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>
        
        <!-- 内部模块依赖管理 -->
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>common</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</dependencyManagement>

3.5 公共依赖 (dependencies)

所有子模块都会继承这些依赖:

<dependencies>
    <!-- 所有子模块都会自动包含这些依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

3.6 插件管理 (pluginManagement)

<build>
    <pluginManagement>
        <plugins>
            <!-- Spring Boot Maven Plugin -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

4. 子模块 POM 详解

4.1 继承父工程

<parent>
    <groupId>com.example</groupId>
    <artifactId>spring-boot-parent</artifactId>
    <version>1.0.0</version>
    <relativePath>../parent-pom.xml</relativePath>
</parent>

4.2 模块特有依赖

<dependencies>
    <!-- 依赖其他子模块 -->
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>common</artifactId>
        <!-- 不需要指定版本,由父工程管理 -->
    </dependency>
    
    <!-- 依赖外部库 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <!-- 不需要指定版本,由父工程管理 -->
    </dependency>
</dependencies>

5. 依赖关系层次

5.1 依赖传递关系

web (启动模块)
├── service (业务服务)
│   ├── api (API接口)
│   │   └── common (公共工具)
│   └── common (公共工具)
└── common (公共工具)

5.2 各模块职责

模块职责主要依赖
common公共工具类、常量、异常hutool、fastjson、validation
apiAPI接口定义、DTOcommon、swagger
service业务逻辑、数据访问api、common、mybatis、redis
web应用启动、控制器service、actuator、devtools

6. 关键概念解析

6.1 dependencyManagement vs dependencies

<!-- 父工程:只管理版本 -->
<dependencyManagement>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.33</version>
    </dependency>
</dependencyManagement>

<!-- 子模块:实际引入依赖 -->
<dependencies>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <!-- 版本由父工程管理 -->
    </dependency>
</dependencies>

6.2 继承机制

子模块自动继承父工程的:

6.3 依赖作用域 (Scope)

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>  <!-- 仅测试时使用 -->
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>  <!-- 不会传递给依赖方 -->
</dependency>

7. 最佳实践

7.1 版本管理

7.2 模块划分

7.3 依赖管理

7.4 构建配置

8. 常见问题

8.1 依赖冲突

8.2 版本不一致

8.3 构建失败

9. 总结

Spring Boot 父子工程通过 Maven 的继承机制实现了:

这种结构特别适合中大型项目的开发和维护,能够有效提高开发效率和代码质量。

到此这篇关于Spring Boot父子工程POM依赖关系的文章就介绍到这了,更多相关SpringBoot父子工程POM依赖关系内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文