Maven多模块项目中common模块,base模块以及dependencyManagement和relativePath

今天药忘吃喽~ 2024-04-20 22:06 57阅读 0赞

## 一.common模块 ##

### 1.为什么会有common模块?    ###

在分布式项目中各个模块是分离开来的,有用户模块,通信模块等等,而像枚举,通用的工具类这些是每个模块都需要的,当发生业务更改的时候,每个模块都需要去更改这些通用的东西,显然这不是一个好的做法,浪费时间,而且可能出错;

所以为了解决这种问题,就将一些公用的东西放到了common模块里面来统一管理.![d7b36996a6a04e718951d0dc58ce9558.png][]

> 注意: common包对外暴露,全公司的项目都可以使用,common包里面没有业务代码;

common包里的依赖一般都是这种和业务无关的,和业务有关的,比如数据库这些是不在common中出现的;

<dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-all</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot</artifactId>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-api</artifactId>
            </dependency>

那么每个项目总有许多数据库操作等一些业务操作也是公用的他们应该放到哪里呢?为了解决这个问题,就有了base模块

## 二.base模块 ##

通过上面的问题,显而易见的base模块是为了编写一些公用的业务逻辑

> 注意:base包用于编写业务逻辑，不对外暴露

因此base包中的依赖一般也就是和公用业务相关的

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.xuxueli</groupId>
                <artifactId>xxl-job-core</artifactId>
            </dependency>

注意在base模块中我们也会导入common模块,这也是必然的 因为他是公用的嘛,谁都要导入它 , 显而易见的 我们的一些主要实现功能的模块 也要导入base模块

<dependency>
                <groupId>com.qcby</groupId>
                <artifactId>chat-service-common</artifactId>
            </dependency>

> 注意: 依赖是可以传递的

比如我有一个Web模块 我需要导入 common模块和base模块 因为我的base模块以及导入了common模块 所以我只需要导入Base模块就可以了 而我再base模块中导入的mysql 等等这些依赖也无需再次在base模块中导入;

## 三.dependencyManagement ##

根据标签翻译是依赖管理的意思

我们在上述中说了 依赖是可以传递的 当我们写一个项目的时候比如有ABC三个模块,A模块依赖B模块,B模块依赖C模块,那么A模块也会间接依赖C模块![2b3025f8c92347dbbf2ae90a5e9396d4.png][]

如下图 在这些依赖关系中 难免有一些依赖会产生冲突 ![97a3402de1454fe089193beced9bbaec.png][]

![98c9915d23514221b96622e40c3f2c47.png][]

#### 当发生了依赖冲突我们如何解决?   一.排除依赖 ####

我们可以使用exclusions把依赖排除出去,比如上述例子中的spring-webmvc

![7b862eed940d430290d55a70bc7a650b.png][]

#### 二.就是要用到我们的dependencyManagement标签了(又称版本锁定) ####

我们在父级模块的pom文件中锁定我们所有模块中Jar包的版本,我们在子模块中导入的时候就无需考虑版本问题直接导入依赖即可,子模块中依赖都会按照这个版本走;

如果我们某个模块和父级模块中某个依赖的版本不能一致,那么我们可以在子模块导入中声明上依赖的版本,这样就可以使用独特的版本了(这个基本不用)

<?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>
    
        <groupId>com.qcby</groupId>
        <artifactId>chatService</artifactId>
        <packaging>pom</packaging>
        <version>1.0.0</version>
        <modules>
            <module>chat-service-web</module>
            <module>chat-service-socket</module>
            <module>chat-service-common</module>
            <module>chat-service-base</module>
        </modules>
    
    
        <properties>
            <spring-boot-dependencies.version>2.5.14</spring-boot-dependencies.version>
            <chat-service.version>1.0.0</chat-service.version>
            <tio-websocket-server.version>3.5.0.v20190822-RELEASE</tio-websocket-server.version>
            <lombok.version>1.18.12</lombok.version>
            <druid.version>1.2.11</druid.version>
            <fastjson.version>1.2.73</fastjson.version>
            <xxl-job-core.version>2.3.0</xxl-job-core.version>
            <redisson.version>3.11.1</redisson.version>
            <hutool.version>5.4.0</hutool.version>
            <fastdfs.version>1.26.2</fastdfs.version>
            <mybatis-plus.version>3.4.2</mybatis-plus.version>
            <redisson.version>3.14.1</redisson.version>
        </properties>
        <dependencyManagement>
            <dependencies>
                
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>${spring-boot-dependencies.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
    
    
                
                <dependency>
                    <groupId>org.t-io</groupId>
                    <artifactId>tio-websocket-server</artifactId>
                    <version>${tio-websocket-server.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>${lombok.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>druid-spring-boot-starter</artifactId>
                    <version>${druid.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>fastjson</artifactId>
                    <version>${fastjson.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.qcby</groupId>
                    <artifactId>chat-service-common</artifactId>
                    <version>${chat-service.version}</version>
                </dependency>
    
    
                
                <dependency>
                    <groupId>com.qcby</groupId>
                    <artifactId>chat-service-base</artifactId>
                    <version>${chat-service.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.qcby</groupId>
                    <artifactId>chat-service-web</artifactId>
                    <version>${chat-service.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.qcby</groupId>
                    <artifactId>chat-service-socket</artifactId>
                    <version>${chat-service.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.xuxueli</groupId>
                    <artifactId>xxl-job-core</artifactId>
                    <version>${xxl-job-core.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>cn.hutool</groupId>
                    <artifactId>hutool-all</artifactId>
                    <version>${hutool.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.github.tobato</groupId>
                    <artifactId>fastdfs-client</artifactId>
                    <version>${fastdfs.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>com.baomidou</groupId>
                    <artifactId>mybatis-plus-boot-starter</artifactId>
                    <version>${mybatis-plus.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>org.redisson</groupId>
                    <artifactId>redisson</artifactId>
                    <version>${redisson.version}</version>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
    </project>

> #### 如果不加dependecyManagement那么子项目会直接继承父项目的依赖;加了则需要在子项目中声明才可以有 ####

## 四.relativePath ##

在子模块的Pom文件中都会有这么一段代码

<parent>
            <artifactId>chatService</artifactId>
            <groupId>com.qcby</groupId>
            <version>1.0.0</version>
            <relativePath/>
        </parent>

这个`relativePath`是什么意思?其实很明显，就是parent的路径，具体来说就是你引用这个父级项目,那么腹肌项目在哪里

###  ###

### 1.默认值 ###

不加<relativePath>：默认是<relativePath> ../pom.xml</relativePath>

### 2.指定路径 ###

###  **<**relativePath**>也可以在此指定<**relativePath/**>** ###

### **3.<relativePath/>** ###

设定一个空值将始终从仓库(父级pom文件)中获取，不从本地路径获取

[d7b36996a6a04e718951d0dc58ce9558.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/20/123a79f7eedb48d38a7eea230401aafe.png
[2b3025f8c92347dbbf2ae90a5e9396d4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/20/d9ead064a2494d9699e0e73e517db6c1.png
[97a3402de1454fe089193beced9bbaec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/20/1f6e03d143a7415ba0711c7d8c14fff4.png
[98c9915d23514221b96622e40c3f2c47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/20/fdf093b292634f27adc12f149fd7a808.png
[7b862eed940d430290d55a70bc7a650b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/20/5a2b519b2c6949a8bbd3d67736d30bad.png