maven多模块和依赖冲突问题汇总记录

时间  2020-11-23
标签 java git github web spring shell apache api springboot mybatis 栏目 Maven 繁體版
原文   原文链接

目录

前言：

今天学习和总结了一下maven的相关知识点，发现一些比较基础的东西竟然也会忘记，这里对于一些平常工做中可能会遇到的问题进行了一下汇总。java

idea怎么建立maven多module的项目

首先了解上面是多module？

一句话归纳就是：一个父模块做为版本控制多个子模块，子模块负责接入到父模块当中做为整个项目的过程。git

多Module管理项目的几种方式：

  1. 按照单模块拆分为多个子模块，好比将MVC三层架构拆分为 xxx-service，xxx-dao，xxx-model，不过这种方式我的感受比较二，目前以业务模块拆分比较多，迁移到微服务好比用springcloude或者dubbo 的时候很是好用。
  2. 按照业务模块拆分，这种模式使用的比较多，也比较多见。

建立一个多module项目(idea2019.3.3版本)

建立一个父pom项目：

  1. 打开idea，选择create new project

  1. 选择maven项目，同时不选任何的预加载设置

  1. 父pom配置以下：

  1. 删除src 目录

建立子模块，引入到父pom里面

  1. 一样右击项目工程，选择new module，而后选择maven，这时候会出现父模块以及对应的子模块名称

  1. 此时在父模块里面发现引入了子模块的内容

子父模块的区别：

父pom.xml文件内容：

<groupId>org.zxd</groupId>
<artifactId>taglib</artifactId>
<packaging>pom</packaging>
<version>1.0.0</version>

<modules>
    <module>taglib-core</module>
</modules>

分为两个部分，一个部分是父pom的声明，包含gourpId，artifactId，打包方式必须是pom，由于使用了聚合模型，同时在父pom里面指定版本号，子模块不填写version会默认使用父pom的version号github

<modules>
    <module>taglib-core</module>
</modules>

上面表示当前引入的子模块内容web

子pom.xml文件内容：

<!-- 引用自父pom -->
<parent>
    <artifactId>taglib</artifactId>
    <groupId>org.zxd</groupId>
    <version>1.0.0</version>
</parent>
<!-- 打包方式为jar包 -->
<packaging>jar</packaging>
<modelVersion>4.0.0</modelVersion>

<artifactId>taglib-core</artifactId>
<version>1.0.0</version>

子模块之间进行互相的依赖

在下面的pom中能够在任意的子模块引入对应的父模块依赖spring

注意因为<parent>这个标签会递归继承，因此要注意子依赖不要和依赖引入不一样版本的依赖，这样容易形成冲突shell

<dependency>
    <groupId>org.zxd</groupId>
    <artifactId>taglib-core</artifactId>
    <version>1.0.0</version>
    <!-- 这里须要注释掉编译的做用域 -->
    <!--<scope>compile</scope>-->
</dependency>

将上面的项目改造为spring-boot多模块项目：

改造父pom文件：

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

parent指向springboot-startedapache

子模块只须要引入父pom的内容api

Spring boot maven plugin问题

在打包spring boot项目时，须要使用以下插件：springboot

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
</plugin>

若是在用maven构建多模块项目时，不要将此插件放到parent pom中，不然若是有sub module不是spring boot应用，在打包时就会出错。只将该插件添加到是spring boot项目的子模块。mybatis

MAVEN依赖冲突问题：

依赖的传递原则：

  1. 最短路径原则
  2. 最早声明原则

maven的依赖引入策略

最短路径原则：

我有下面两个依赖jar包，A和B，他们都引入了C这个依赖，这时候若是有以下的引用

A -> C（3.3）

B -> A（3.3）

B -> C（3.4）

此时若是把B打包，获得版本号是3.4，可是若是B去掉C的依赖，那就是走A->C的传递依赖，很简单

验证：

  1. 我假设我有一个web包引入了common-lang3，版本是3.4的版本
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.4</version>
</dependency>
  1. 此时又引入了一个公用包，里面也有这个引用：
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.3</version>
</dependency>
  1. 若是此时在本地引用3.4版本，那就是3.4的版本，不然就死3.3的版本，无论声明顺序谁先谁后

最早声明原则：

若是两个jar包的寻址路径一致，那么谁先优先声明，先引入谁

验证：

下面两个依赖分配对应两个module，引入模块的这个模块暂定为 C 模块。

<!-- 引入core包内容 -->
<dependency>
    <groupId>org.zxd</groupId>
    <artifactId>taglib-core</artifactId>
    <version>1.0.0</version>
    <!--            <scope>compile</scope>-->
</dependency>
<!-- 引入db包的内容 -->
<dependency>
    <groupId>org.zxd</groupId>
    <artifactId>taglib-db</artifactId>
    <version>1.0.0</version>
</dependency>

此时 taglib-core 中的依赖版本以下，暂定为 A 模块：

<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-client</artifactId>
    <version>2.5.0</version>
</dependency>

而taglib-db 中的依赖版本以下，暂定为 B 模块：

<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-client</artifactId>
    <version>4.0.1</version>
</dependency>

此时将整个web项目打包，能够看到web项目里面的版本以下：

能够很明显的看到若是引入关系是这样的：

C -> A,B

A -> curator-client 2.5

B -> curator-client 4.1

这样的链路最终打包出来的效果是 C -> A -> curator-client 2.5

这样也就形成了不少状况下咱们编译和运行时彻底没有问题的，甚至有可能打包都是正常的，可是到最后运行的时候忽然报错，要谨防这种依赖版本的问题，好在通常公司的项目都有经理负责控制版本依赖，这种错误算是低级错误，可是在现在框架满天飞的时代，依赖管理的版本控制问题依然须要注意！！！

如何解决依赖冲突的问题

锁定版本法

通常状况下咱们会在父pom文件里面管理，可使用<dependencyManagement>这个这个标签来管理全部子模块的版本依赖，子模块若是指定本身的版本，这里发现打出来的包依然是父pom指定的版本，版本管理使用以下：

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-client</artifactId>
            <version>4.1.0</version>
        </dependency>
    </dependencies>
</dependencyManagement>

锁定版本法能够打破2个依赖传递的原则，优先级为最高

版本锁定能够排除一些exclude标签，不一样模块用不一样版本的jar包自己也不符合规范，因此这种方式较为稳妥

什么状况下会出现Jar包冲突问题

只有高版本Jar包不向下兼容，或者新增了某些低版本没有的API才有可能致使这样的问题

如何查找和发现jar包冲突？

1. 利用idea的maven视图工具

直接使用一个图说明一下：

能够经过这个工具查看依赖在哪一个模块重复引用，同时若是有冲突会显示红线，这个视图很是的直观，能够帮助依赖管理人员去处理依赖重复引用或者引用版本不一致的问题，进行<exclude>操做

2. Idea Maven Helper 插件

如何使用？

安装完成以后，随便找一个pom.xml文件，按照以下的图例提示进行操做，对于冲突的内容，右击exclude就能够排除依赖：

排除完依赖以后，点击左上角的Refresh UI 刷新一下UI的界面：

3. maven命令工具：

mvn dependency:tree -Dverbose，有时候若是咱们没有idea的状况下，可使用这个命令来处理，执行的结果参考以下：

PS: 此处必定不要省略 -Dverbose参数，要否则是 不会显示被 忽略的包的 
or:curator-client:jar:4.1.0:compile
[INFO] |  |  +- org.apache.zookeeper:zookeeper:jar:3.5.4-beta:compile
[INFO] |  |  |  +- commons-cli:commons-cli:jar:1.2:compile
[INFO] |  |  |  +- log4j:log4j:jar:1.2.17:compile
[INFO] |  |  |  +- org.apache.yetus:audience-annotations:jar:0.5.0:compile
[INFO] |  |  |  \- io.netty:netty:jar:3.10.6.Final:compile
[INFO] |  |  +- com.google.guava:guava:jar:20.0:compile
[INFO] |  |  \- org.slf4j:slf4j-api:jar:1.7.30:compile
[INFO] |  +- commons-codec:commons-codec:jar:1.15:compile
[INFO] |  +- commons-collections:commons-collections:jar:3.2.2:compile
[INFO] |  +- commons-beanutils:commons-beanutils:jar:1.9.4:compile
[INFO] |  +- commons-configuration:commons-configuration:jar:1.10:compile
[INFO] |  |  \- commons-lang:commons-lang:jar:2.6:compile

整体上来讲仍是比较直观的，很是方便和好用。

如何写一个干净依赖关系的POM文件

  • 尽可能在父POM中定义<dependencyManagement>，来进行本项目一些依赖版本的管理，这样能够从很大程度上解决必定的冲突
  • 最少依赖jar包原则
  • 使用mvn dependency:analyze-only命令用于检测那些声明了可是没被使用的依赖，若有有一些是你本身声明的，那尽可能去掉
  • 使用mvn dependency:analyze-duplicate命令用来分析重复定义的依赖，清理那些重复定义的依赖

dependency:analyze-only 命令

在idea - Terminal里面，能够看到对应的依赖被下载

执行完以后个人运行结果以下，这里报错的缘由是打包时候默认去阿里云仓库寻找依赖，这里须要配置一下：

[ERROR] Failed to execute goal on project taglib-web: Could not resolve dependencies for project org.zxd:taglib-web:war:1.0.0: The following artifacts could not be resolved: org.zxd:
taglib-core:jar:1.0.0, org.zxd:taglib-db:jar:1.0.0: Failure to find org.zxd:taglib-core:jar:1.0.0 in http://maven.aliyun.com/nexus/content/repositories/central/ was cached in the loc
al repository, resolution will not be reattempted until the update interval of alimaven has elapsed or updates are forced -> [Help 1]

大体意思就是说再阿里云仓库找不到对应的依赖引入。

解决方式以下：

找到maven的安装路径下的apache-maven-3.6.3\conf下面的setting.xml，找到以下配置：

<!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ${user.home}/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
<!-- 这里配置本地仓库的位置 -->
  <localRepository>D:\soft\apache-maven-3.6.3\rep</localRepository>

此时从新执行一下：dependency:analyze-only 命令

[INFO] --- maven-dependency-plugin:3.1.2:analyze-only (default-cli) @ taglib-web ---
[WARNING] Unused declared dependencies found:
[WARNING]    org.zxd:taglib-core:jar:1.0.0:compile
[WARNING]    org.apache.commons:commons-lang3:jar:3.4:compile
[WARNING]    org.springframework.boot:spring-boot-starter-web:jar:2.4.0:compile
[WARNING]    org.springframework.boot:spring-boot-starter-test:jar:2.4.0:test
[WARNING]    org.neo4j.driver:neo4j-java-driver:jar:1.5.0:compile
[WARNING]    commons-codec:commons-codec:jar:1.10:compile
[WARNING]    commons-collections:commons-collections:jar:3.2.2:compile
[WARNING]    commons-beanutils:commons-beanutils:jar:1.9.4:compile
[WARNING]    commons-configuration:commons-configuration:jar:1.10:compile
[WARNING]    commons-fileupload:commons-fileupload:jar:1.3:compile
[WARNING]    commons-logging:commons-logging:jar:1.2:compile
[WARNING]    org.apache.httpcomponents:httpclient:jar:4.4.1:compile
[WARNING]    org.apache.poi:poi-ooxml:jar:3.17:compile
[WARNING]    org.mybatis:mybatis:jar:3.4.0:compile
[WARNING]    org.mybatis:mybatis-spring:jar:1.3.0:compile
[WARNING]    com.github.pagehelper:pagehelper:jar:5.1.2:compile

mvn dependency:analyze-duplicate 命令

[INFO] No duplicate dependencies found in <dependencies/> or in <dependencyManagement/>

若是没有其余信息，表明没有重复依赖的引入

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程