以编程方式访问 Logback 中定义的属性

Question

我正在构建一个管理控制台，我想显示在

Logback

中为我的应用程序创建的日志。但是，这些日志的存储位置因环境而异。我有几个定义日志存储位置的属性文件：

<configuration>
  <property resource='log.properties'/>
  <property resource='log.${ENV:-prod}.properties'/>

  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.dir}/sync.log</file>
  ...
</configuration>

我想从

${log.dir}

Java API 中找到

Logback's

的值。我尝试了以下操作，但它没有资源中定义的任何属性。例如：

 LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
 String logDir = loggerContext.getProperty("log.dir"); // this always returns null

所以我的问题是我应该使用什么 API？

Answer 1

默认情况下，属性在“本地”范围中定义。但是，您可以强制属性具有上下文范围，在这种情况下，获取属性的值非常容易：

 LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
 String val = lc.getProperty(aString);

在“上下文”范围内定义属性被认为有点严厉。您可以在上下文范围中仅定义单个属性，而不是在上下文范围中定义所有/多个属性。这是一个例子：

<configuration>
  <!-- get many props from a file -->
  <property resource='log.properties'/>
  <-- set only one to be in context scope -->
  <property scope="context" name="log.dir.ctx" value="${log.dir}" />
  ...
</configuration>

然后您可以通过以下方式获得您正在寻找的值：

 LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
 String val = lc.getProperty("log.dir.ctx"); 

Answer 2

属性也定义在

LoggerContextVO

中，你可以这样获取你定义的属性：

LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
LoggerContextVO loggerContextRemoteView = context.getLoggerContextRemoteView();
Map<String, String> propertyMap = loggerContextRemoteView.getPropertyMap();
String loggingFile = propertyMap.get("log.dir.ctx");

Answer 3

以编程方式配置自定义编码器时，我尝试使用在 application.properties 中定义的 Spring 属性。在编码器中，它必须决定是否操作日志。此功能可以通过可配置参数打开或关闭。

由于此日志记录库将由许多不同的项目使用，因此每个部署都可以使用自己的 application.property 文件中的此属性来配置其需求。

我是这样解决的：

您可以从 logback.xml 访问application.properties中定义的 spring 属性。

<configuration>
    <springProperty scope="context" name="ourCustomParameter" source="eu.some.property.name" />
...
</configuration>

注意范围声明。我们需要能够从 Java 代码中的 Context 检索此变量。

在 Logback 中你现在可以从 Context 中获取它。编写自定义编码器，您可以像这样访问它

this.getContext().getProperty("ourCustomParameter");

或者更大的例子：

public class CustomLoggingEventCompositeJsonEncoder extends LoggingEventCompositeJsonEncoder {
  
  ...
  
  @Override
  public byte[] encode(ILoggingEvent iLoggingEvent) {
    return super.encode(iLoggingEvent);
  }
  
  ...
  
  private String getOurSpringProp() {
    return this.getContext().getProperty("");
    // Note that this will return null if this property does not exist
  }
}