Slf4j+Logback配置文件变量使用小记
项目中须要根据不同的模块,产生出不同的日志文件名,使用的是同一logback.xml配置文件,这里简单调研,说明两种实现方式,以及两种实现方式的区别。
测试准备
建立一个maven项目,并添加slf4j-api, logback-core, logback-classic 依赖。
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.13</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.1.3</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.3</version>
</dependency>
</dependencies>
方式一:变量替换
详细信息参考:https://logback.qos.ch/manual/configuration.html#variableSubstitution
测试一(单线程)
logback.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="FILE"
class="ch.qos.logback.core.FileAppender">
<File>test-logger-${test-variable}.log</File>
<Append>true</Append>
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n
</Pattern>
</layout>
</appender>
<root level="debug">
<appender-ref ref="FILE" />
</root>
</configuration>
测试代码
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LoggerJVMParamTest {
private static final Logger LOG = LoggerFactory.getLogger(LoggerJVMParamTest.class);
public void printLog() {
LOG.info("This is test log.");
}
public static void main(String[] args) {
LoggerJVMParamTest test = new LoggerJVMParamTest();
test.printLog();
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
执行程序时加入jvm参数: -Dtest-variable="PROG"
执行结果及说明
生成了test-logger-PROG.log文件
2017-08-02 17:06:29,794 INFO [main] c.s.t.l.LoggerJVMParamTest [LoggerJVMParamTest.java:16] This is test log.
logback 中可以通过jvm参数传递变量来指定文件名, 当然变量的传递方式还有多种方式,这里不展开,可以参考https://logback.qos.ch/manual/configuration.html#variableSubstitution
测试二(多线程)
再看看在多线程环境中是否也都有效,logback.xml同测试一
测试代码
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
public class LoggerJVMParamMultiThreadsTest {
private static final Logger LOG = LoggerFactory.getLogger(LoggerJVMParamMultiThreadsTest.class);
public void printLog() {
LOG.info("This is test log.");
}
public static void main(String[] args) {
LoggerJVMParamMultiThreadsTest test = new LoggerJVMParamMultiThreadsTest();
Thread subThd1 = new Thread(new Runnable() {
public void run() {
LOG.info("This is subThd1 log");
}
});
subThd1.start();
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
test.printLog();
Thread subThd2 = new Thread(new Runnable() {
public void run() {
LOG.info("This is subThd2 log");
}
});
subThd2.start();
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
执行程序时加入jvm参数: -Dtest-variable="PROG"
执行结果及说明
生成了test-logger-PROG.log文件
2017-08-02 17:26:01,786 INFO [Thread-0] c.s.t.l.LoggerJVMParamMultiThreadsTest [LoggerJVMParamMultiThreadsTest.java:27] This is subThd1 log
2017-08-02 17:26:06,791 INFO [main] c.s.t.l.LoggerJVMParamMultiThreadsTest [LoggerJVMParamMultiThreadsTest.java:17] This is test log.
2017-08-02 17:26:06,791 INFO [Thread-1] c.s.t.l.LoggerJVMParamMultiThreadsTest [LoggerJVMParamMultiThreadsTest.java:42] This is subThd2 log
方式二:MDC
详细信息参考:https://logback.qos.ch/manual/mdc.html
测试1(单线程)
logback.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="FILE_MDC" class="ch.qos.logback.classic.sift.SiftingAppender">
<discriminator>
<Key>test-variable</Key>
<DefaultValue>default</DefaultValue>
</discriminator>
<sift>
<appender name="FILE"
class="ch.qos.logback.core.FileAppender">
<File>test-logger-${test-variable}.log</File>
<Append>true</Append>
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</Pattern>
</layout>
</appender>
</sift>
</appender>
<root level="debug">
<appender-ref ref="FILE_MDC" />
</root>
</configuration>
测试代码
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
public class LoggerConfVariablesTest {
private static final Logger LOG = LoggerFactory.getLogger(LoggerConfVariablesTest.class);
public void printLog() {
LOG.info("This is test log.");
}
public static void main(String[] args) {
MDC.put("test-variable", "PROG");
LoggerConfVariablesTest test = new LoggerConfVariablesTest();
test.printLog();
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
执行结果及说明
执行代码,生成日志文件:test-logger-PROG.log
内容:
2017-08-02 13:44:20,779 INFO [main] c.s.t.l.LoggerConfVariablesTest [LoggerConfVariablesTest.java:17] This is test log.
先看下ch.qos.logback.classic.sift.SiftingAppender类的说明:
This appender can contains other appenders which it can build dynamically depending on MDC values. The built appender is specified as part of a configuration file.
就是说SiftingAppender类可以根据MDC的值动态的构建其他的appender,由discriminator来指定MDC的Key和默认值。
根据https://logback.qos.ch/manual/mdc.html中的说明:
MDC operations such as put() and get() affect only the MDC of the current thread, and the children of the current thread. The MDC in other threads remain unaffected.
MDC put(), get()会影响当前线程和子线程的MDC值,但是不会响应其他线程。再考虑上面的测试,那么其他线程应该是拿不到MDC test-variable的值的,打印的日志信息应该是不会输出到test-logger-PROG.log日志文件中去的,那它会输出到哪里呢? 接下来继续测试。
测试二(多线程)
logback.xml配置同测试一
测试代码
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
public class LoggerConfVariablesTest {
private static final Logger LOG = LoggerFactory.getLogger(LoggerConfVariablesTest.class);
public void printLog() {
LOG.info("This is test log.");
}
public static void main(String[] args) {
LoggerConfVariablesTest test = new LoggerConfVariablesTest();
Thread subThd1 = new Thread(new Runnable() {
public void run() {
MDC.put("test-variable", "PROG");
LOG.info("This is subThd1 log");
}
});
subThd1.start();
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
test.printLog();
Thread subThd2 = new Thread(new Runnable() {
public void run() {
LOG.info("This is subThd2 log");
}
});
subThd2.start();
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
执行结果及说明
生成了两个日志文件
test-logger-PROG.log
2017-08-02 16:45:22,798 INFO [Thread-0] c.s.t.l.LoggerConfVariablesTest [LoggerConfVariablesTest.java:30] This is subThd1 log
test-logger-default.log
2017-08-02 16:45:27,790 INFO [main] c.s.t.l.LoggerConfVariablesTest [LoggerConfVariablesTest.java:17] This is test log.
2017-08-02 16:45:27,790 INFO [Thread-1] c.s.t.l.LoggerConfVariablesTest [LoggerConfVariablesTest.java:45] This is subThd2 log
可以知道
MDC.put("test-variable", "PROG"); 仅在subThd1中生效,其的父线程和兄弟线程取不到PROG这个值所以使用了默认值“default”。
总结
根据测试通过JVM变量方式来设置日志文件名,这个方式适用于单线程和多线程环境,但是MDC不适用多线程环境,特别是当MDC.put()方法的调用是非主线程的情况,比如javaEE项目就不适合这么做。根据对MDC的了解,MDC主要适用于须要在同一个进程中对不同的线程输出不同的日志格式,或输出到不同的文件这种场景,比如web项目,针对不同的用户请求,在日志中加入用户的信息,或者是不同的任务日志输出到不同的文件。
而对于须要将不同模块进程的日志输出到不同的文件,共用logback.xml, 则可以使用jvm参数传递变量的方式。
- Vue 大法好
- Python:ip地址处理模块
- Oracle 12c系列(四)|资源隔离之IO、内存、CPU
- Python:gethostbyname获取本地ip地址
- Oracle 12c系列(五)|PDB Refresh
- hdu 2473 Junk-Mail Filter (并查集之点的删除)
- Python:platform获取操作系统详细信息
- java版本的学生管理系统
- Python:获取目录下指定后缀的文件
- Go语言基于Socket编写服务器端与客户端通信的实例
- Linux强制用户首次登陆修改密码
- crontab执行python脚本提示ImportError解决方法
- Java学习之约瑟夫环的两中处理方法
- Zabbix实现QQ报警配置
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- Go语言 | CSP并发模型与Goroutine的基本使用
- LeetCode链表知识点&题型总结
- dp 类找零钱类问题
- 网易校招真题三
- 嵌入式linux之go语言开发(四)go语言8583协议报文解析
- java 线程池设计模式
- 初识分布式:MIT 6.284系列(一)
- LeetCode 93 | 生成所有有效的IP地址
- 嵌入式linux之go语言开发(二)c动态库驱动调用
- 华量杯-股票预测, keras+LSTM
- Apollo配置中心源码编译及搭建
- 嵌入式linux之go语言开发(三)卡库的封装
- 可笑,你竟然不知道 Java 如何生成 UUID
- 招商银行校招题一
- 面试:mysql最全索引与优化详解