使用Spring Boot向Logback Appenders注入依赖项

Question

如果不可能，实现我的目标（将bean从应用程序上下文插入到appender中）的规范方法是什么？

Answer 1

正如问题中提到的，默认情况下，Logback实例化并管理不同日志记录组件（追加器等）本身的生命周期。它对Spring一无所知。而且，Logback通常会在Spring启动之前自行配置（因为Spring也使用它进行日志记录）。

因此，您不能真正使用Spring来配置FileAppender（或其他一些相当基本的appender）的实例，然后将其注入到logback中。

但是，如果您的appender不是真正的基础（或者您很乐意在Spring Boot启动期间忽略日志事件），您可以遵循下面的“简单”方法。如果您想捕获所有事件（包括启动期间的事件），请继续阅读。

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.UnsynchronizedAppenderBase;
import org.springframework.context.SmartLifecycle;
import org.springframework.stereotype.Component;

@Component
public class LogbackCustomAppender extends UnsynchronizedAppenderBase<ILoggingEvent> implements SmartLifecycle {

  @Override
  protected void append(ILoggingEvent event) {
    // TODO handle event here
  }

  @Override
  public boolean isRunning() {
    return isStarted();
  }

}

正如您所看到的，它用@component进行了注释，这样Spring就可以在类路径扫描期间提取它。此外，它实现了SmartLifecycle，以便Spring调用LogbackLifecycle接口方法（幸运的是，start()和stop()方法具有完全相同的签名，因此我们只需要实现isrunning()，它将委托给Logbackisstart())。

现在，在Spring应用程序上下文启动结束时，我们可以检索完全初始化的LogbackCustomAppender实例。但是Logback很幸运地不知道这个追加器，所以我们需要用Logback注册它。

其中一种方法是在Spring Boot应用程序类中：

@SpringBootApplication
@ComponentScan(basePackages = {"net.my.app"})
public class CustomApplication {

  public static void main(String[] args) throws Exception {
    ConfigurableApplicationContext context = SpringApplication.run(CustomApplication.class, args);
    context.start();
    addCustomAppender(context, (LoggerContext) LoggerFactory.getILoggerFactory());
  }

  private static void addCustomAppender(ConfigurableApplicationContext context, LoggerContext loggerContext) {
    LogbackErrorCollector customAppender = context.getBean(LogbackCustomAppender.class);
    Logger rootLogger = loggerContext.getLogger(Logger.ROOT_LOGGER_NAME);
    rootLogger.addAppender(customAppender);
  }

}

不需要更改您的日志配置文件中的任何内容。

更复杂的方法（捕获所有事件）

如上所述，您可能对在Spring Boot启动期间不丢失记录的事件感兴趣。

为此，您可以实现一个占位符追加器（它将在内部缓冲启动事件）：

import ch.qos.logback.core.Appender;
import ch.qos.logback.core.UnsynchronizedAppenderBase;

import java.util.ArrayList;

public class BufferingAppenderWrapper<E> extends UnsynchronizedAppenderBase<E> {

  private final ArrayList<E> eventBuffer = new ArrayList<>(1024);
  private Appender<E> delegate;

  @Override
  protected void append(E event) {
    synchronized (eventBuffer) {
      if (delegate != null) {
        delegate.doAppend(event);
      }
      else {
        eventBuffer.add(event);
      }
    }
  }

  public void setDelegateAndReplayBuffer(Appender<E> delegate) {
    synchronized (eventBuffer) {
      this.delegate = delegate;
      for (E event : this.eventBuffer) {
        delegate.doAppend(event);
      }
      this.eventBuffer.clear();
    }
  }

}

我们以通常的方式（例如Logback.xml）使用Logback注册该appender：

  <appender name="DELEGATE" class="my.app.BufferingAppenderWrapper" />

  <root level="INFO">
    <appender-ref ref="DELEGATE" />
  </root>

Spring启动后，按名称查找appender，并用占位符注册Spring配置的appender（在进程中刷新缓冲的事件）：

@SpringBootApplication
@ComponentScan(basePackages = {"net.my.app"})
public class CustomApplication {

  public static void main(String[] args) throws Exception {
    ConfigurableApplicationContext context = SpringApplication.run(CustomApplication.class, args);
    context.start();
    addCustomAppender(context, (LoggerContext) LoggerFactory.getILoggerFactory());
  }

  private static void addCustomAppender(ConfigurableApplicationContext context, LoggerContext loggerContext) {
    LogbackErrorCollector customAppender = context.getBean(LogbackCustomAppender.class);
    Logger rootLogger = loggerContext.getLogger(Logger.ROOT_LOGGER_NAME);
    BufferingAppenderWrapper<ILoggingEvent> delegate = (BufferingAppenderWrapper<ILoggingEvent>) rootLogger.getAppender("DELEGATE");
    delegate.setDelegateAndReplayBuffer(customAppender);
  }

}