Maven全局排除依赖

2021.11.21 12:21

项目中有很多依赖，某些Jar之间是有冲突的，有些冲突只有在运行时才会报出错误，这样就很危险。比如我使用如下方式去排除依赖。

<dependency>
    <groupId>kuaishou</groupId>
    <artifactId>kuaishou-web-common</artifactId>
    <exclusions>
        <exclusion>
            <groupId>kuaishou</groupId>
            <artifactId>kuaishou-es</artifactId>
        </exclusion>
    </exclusions>
</dependency>

某天项目组其他人引入了个依赖，这个依赖又间接传递了kauishou-es依赖，这样服务部署完才发现错误，回头再加上排除。但如果测试没有覆盖这一点的时候，可能会在线上才会排除错误，就完了。

<dependency>
    <groupId>kuaishou</groupId>
    <artifactId>kuaishou-admin-framework</artifactId>
    <exclusions>
        <exclusion>
            <groupId>kuaishou</groupId>
            <artifactId>kuaishou-es</artifactId>
        </exclusion>
    </exclusions>
</dependency>

所以我们想就有没有一种方式来全局的排除依赖呢？我想起了gradle的方式：

configurations.all* {
    exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'
}

所以理所当然想到maven肯定也会有类似的机制，但很不幸没有。Maven提供了一种插件的形式通过黑白名单来控制依赖，如下：

官网文档参考 https://maven.apache.org/enforcer/enforcer-rules/bannedDependencies.html

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>3.0.0-M3</version>
    
    <executions>
        <execution>
            <id>enforce-banned-dependencies</id>
            <goals>
                <goal>enforce</goal>
            </goals>
            <configuration>
                <rules>
                    <bannedDependencies>
                        <searchTransitive>true</searchTransitive>
                        <excludes>
                            <exclude>kuaishou:kuaishou-es</exclude>
                        </excludes>
                    </bannedDependencies>
                </rules>
                <fail>true</fail>
            </configuration>
        </execution>
    </executions>
</plugin>

然后执行：
mvn validate 这个是全局命令，会覆盖到enforce插件
或者是
mvn enforce:enforce 这个只是那个插件的命令，只执行插件的检查功能

如果检查到依赖kuaishou-es的包会编译不通过报错：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:3.0.0-M3:enforce (enforce-banned-dependencies) on project kuaishou-merchant-financial-center-component: Some Enforcer rules have failed. Look above for specific messages explaining why the rule failed. -> [Help 1]

这个只是帮助检查，检查出来问题，还是要自己手动去排除的。

△

五百年前

Maven全局排除依赖