如何从自定义Gradle插件中排除SLF4J以解决类转换异常

问题本质 #

Gradle运行环境内置了SLF4J的实现类org.gradle.internal.logging.slf4j.OutputEventListenerBackedLogger，当自定义插件本身或其传递依赖引入了logback-classic等其他SLF4J实现时，就会出现类转换冲突，导致对应报错。

具体修复步骤 #

• 第一步：在插件的build.gradle中添加日志依赖排除规则，过滤所有传递引入的SLF4J、logback相关依赖。如果需要全局过滤所有依赖的日志包，配置如下：

configurations.all {
    exclude group: 'org.slf4j'
    exclude group: 'ch.qos.logback'
}

如果只有个别第三方依赖引入了日志包，也可以单独针对该依赖添加排除规则，无需全局过滤，示例：

dependencies {
    implementation gradleApi()
    // 示例：给引入的第三方库单独排除日志依赖
    implementation('com.example:some-lib:2.1') {
        exclude group: 'org.slf4j'
        exclude group: 'ch.qos.logback'
    }
}

• 第二步：修正插件代码中的日志使用逻辑，禁止强转SLF4J日志实例为logback的实现类，统一使用org.slf4j.Logger接口的标准方法调用。如果需要获取日志实例，优先使用Gradle官方提供的日志工具类，示例如下：

import org.gradle.api.logging.Logging;
import org.slf4j.Logger;

// 类内部获取日志实例
private static final Logger logger = Logging.getLogger(你的插件主类名.class);

• 第三步：如果你使用Gradle TestKit做插件单元测试，需要额外在测试配置中排除冲突的日志依赖，添加如下配置：

test {
    classpath = configurations.testRuntimeClasspath.filter { 
        !it.path.contains("slf4j") && !it.path.contains("logback") 
    }
    // 保留你原有测试框架的配置，比如useJUnit()/useJUnitPlatform()等
}

• 第四步：重新发布你的插件版本，在引用项目中更新插件版本后即可解决冲突。

内容的提问来源于stack exchange，提问作者Aakash aggarwal