自定义Gradle插件配置SLF4J-Log4J无控制台输出问题排查

核心问题原因 #

Gradle内置了SLF4J的默认绑定（slf4j-simple），会优先于你引入的Log4J2绑定加载，导致自定义日志配置失效；同时Gradle自带的日志过滤规则会拦截低级别日志输出。

具体解决步骤 #

1. 排除Gradle自带的SLF4J依赖 #

在插件项目的build.gradle中，强制排除Gradle内置的SLF4J相关模块，确保你的Log4J2绑定优先加载：

dependencies {
    implementation 'org.apache.logging.log4j:log4j-api:2.17.2'
    implementation 'org.apache.logging.log4j:log4j-core:2.17.2'
    implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.17.2'
}

configurations.all {
    // 排除Gradle自带的SLF4J API和默认绑定
    exclude group: 'org.slf4j', module: 'slf4j-api'
    exclude group: 'org.slf4j', module: 'slf4j-simple'
}

2. 确保log4j2.xml配置文件被正确加载 #

Gradle插件的类加载器可能无法自动读取src/main/resources下的配置文件，可通过以下方式处理：

• 方式一：在插件代码中强制指定配置路径
  在任务执行前添加配置文件路径的系统属性：

  import java.io.File;
  import org.gradle.api.DefaultTask;
  import org.gradle.api.tasks.TaskAction;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  public class LogTestTask extends DefaultTask {
      @TaskAction
      public void run() {
          File configFile = getProject().file("src/main/resources/log4j2.xml");
          System.setProperty("log4j.configurationFile", configFile.getAbsolutePath());
          
          Logger logger = LoggerFactory.getLogger(LogTestTask.class);
          logger.debug("Debug日志内容");
          logger.info("Info日志内容");
          logger.error("Error日志内容");
      }
  }
  

• 方式二：检查log4j2.xml配置正确性
  确保根日志级别设置为debug或info，控制台输出器配置正常：

  <?xml version="1.0" encoding="UTF-8"?>
  <Configuration status="WARN">
      <Appenders>
          <Console name="Console" target="SYSTEM_OUT">
              <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
          </Console>
      </Appenders>
      <Loggers>
          <Root level="debug">
              <AppenderRef ref="Console"/>
          </Root>
      </Loggers>
  </Configuration>
  

3. 调整Gradle日志级别 #

Gradle默认日志级别为LIFECYCLE（对应INFO级别），若要查看DEBUG日志，需在运行任务时添加参数：

./gradlew log-test --debug

或在项目根目录的gradle.properties中全局设置：

org.gradle.logging.level=debug

4. 验证日志绑定是否生效 #

在插件代码中添加验证代码，确认SLF4J使用的是Log4J2绑定：

import org.slf4j.impl.StaticLoggerBinder;

// 在任务执行时打印绑定信息
System.out.println("当前SLF4J绑定实现：" + StaticLoggerBinder.getSingleton().getLoggerFactoryClassStr());

若输出为org.apache.logging.log4j.slf4j.Log4jLoggerFactory，说明绑定成功；若为其他值，需检查依赖排除是否生效。

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