当前位置：首页 > article >正文

maven冲突解决-enforcer插件介绍

article 2025/8/28 9:19:36

项目使用maven管理jar依赖时有时候会有一些jar之间冲突和类冲突的情况，需要人肉排查。

maven插件enforcer正是解决此问题排查的工具

enforcer插件基本配置及规则列表

enforcer配置示例

  <plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-enforcer-plugin</artifactId><version>1.4.1</version><executions><execution><id>enforce-dependencies</id><goals><goal>display-info</goal><goal>enforce</goal></goals></execution></executions><configuration><rules><requireMavenVersion><version>[3.0.3,)</version></requireMavenVersion><requireJavaVersion><version>1.7.0</version></requireJavaVersion></rules><fail>true</fail></configuration>
</plugin> 
 

该插件默认绑定在validate阶段，有三个目标 display-info和enforce、help

display-info用于显示基本环境信息
enforce用于规则检查
help帮助信息，mvn enforcer:help -Ddetail=true -Dgoal=<goal-name>

该插件内置完整的规则列表：http://maven.apache.org/enforcer/enforcer-rules/index.html

执行命令

enforcer:display-info enforcer:enforce

enforcer:help -Ddetail=true -Dgoal=enforce

enforce目标

支持三个选项：

skip - a quick way to skip checks via a profile or using -Denforcer.skip=true from the command line.
fail - if the goal should fail the build when a rule fails. The default is true. If false, the errors will be logged as warnings.
failFast - if the goal should stop checking after the first failure. The default is false.

例如：failFast，规则检查不通过就构建失败

  <failFast> true </failFast> 
 <rules> 
      <requireJavaVersion> 
          <version> 1.8 . 0 </version> 
      </requireJavaVersion> 
 </rules> 
 

效果如下：

规则示例

全部规则列表：http://maven.apache.org/enforcer/enforcer-rules/index.html

requireJavaVersion，同理requireMavenVersion、requireOS(不支持表达式，必须准确的写一个版本号，不过可以把version注释掉，不校验操作系统的版本)

  <rules> 
      <requireJavaVersion> 
          <version> 1.8 . 0 </version> 
      </requireJavaVersion> 
 </rules> 
 

dependencyConvergence（jar包版本冲突依赖检测）

  <rules> 
      <dependencyConvergence> 
          <uniqueVersion> false </uniqueVersion> 
      </dependencyConvergence> 
 </rules> 
 

bannedDependencies（可配置不允许使用的jar），例如只能使用log4j2，不允许使用log4j1

  <bannedDependencies> 
      <!--是否检查传递性依赖(间接依赖)--> 
      <searchTransitive> true </searchTransitive> 
      <excludes> 
          <exclude>log4j:log4j</exclude> 
          <exclude>org.slf4j:slf4j-log4j12</exclude> 
          <exclude>org.slf4j:slf4j-log4j13</exclude> 
      </excludes> 
      <includes> 
          <include>org.apache.logging.log4j:log4j-core: 2.5 </include> 
          <include>org.apache.logging.log4j:log4j-slf4j-impl: 2.5 </include> 
      </includes> 
      <message>must use log4j2</message> 
 </bannedDependencies> 
 

其他规则：http://maven.apache.org/enforcer/enforcer-rules/index.html

自定义检查规则

可以使用maven-enforcer-rule-api自定义规则，http://maven.apache.org/enforcer/enforcer-api/writing-a-custom-rule.html

<rules><myCustomRule implementation="org.apache.maven.enforcer.rule.MyCustomRule"><shouldIfail>false</shouldIfail></myCustomRule>
</rules>

类冲突检测

自定义规则实现，仅把不同jar包的类冲突列出来，已有第三方的extra-enforcer-rules：http://www.mojohaus.org/extra-enforcer-rules/index.html。

<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-enforcer-plugin</artifactId><version>1.4.1</version><dependencies><dependency><groupId>org.codehaus.mojo</groupId><artifactId>extra-enforcer-rules</artifactId><version>1.0-beta-4</version></dependency></dependencies><executions><execution><id>enforce-dependencies</id><goals><goal>display-info</goal><goal>enforce</goal></goals></execution></executions><configuration><rules><banDuplicateClasses><findAllDuplicates>true</findAllDuplicates></banDuplicateClasses></rules></configuration>
</plugin>

执行效果：