一. 创建
1.1 工厂函数
要使用Slf4j,首先要创建一个实例: org,slf4j.Logger.
//使用类作为参数, 实例名字:类的全路径
private static final Logger log = LoggerFactory.getLogger(Demo.class);
//使用字符串作为参数,自定义实例名字
private static final Logger log = LoggerFactory.getLogger("com.test.Demo");
1.2 Lombok
Lombok 就像fastjson, 或褒或贬. 个人观点:真香
@Slf4j
public class Demo {
// 注解 @Slf4j 会帮你生成下边这行代码
// private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(Demo.class);
}
除了Slf4j,Lombok几乎支持目前市面上所有的日志方案,从接口到实现都没放过。具体明细可以参考Lombok的官方文档 https://projectlombok.org/features/log
二. 使用
2.1 日志级别
日志等级是影响日志输出的最核心的因素。日志实现层通常会配置一个日志等级,只有[大于等于]该等级的日志【可以输出】。
package org.slf4j.event;
public enum Level {
ERROR(40, "ERROR"), //出现异常,代码无法正常执行
WARN(30, "WARN"), // 用于记录非预期场景,不影响后续业务执行
INFO(20, "INFO"), //默认级别,记录代码执行关键信息
DEBUG(10, "DEBUG"), // 通常在测试环境或者查找bug时使用,打印方法的出入参数
TRACE(0, "TRACE"); //通常用于记录调用链路。 业务层较少使用。
}
2.2 打印接口
主要有两大类,以INFO级别为例:
boolean isInfoEnabled(...); //获取当前Logger实例是否开启了对应的日志级别
void info(String var1,...); // 打印
使用{}作为占位符。需要注意的是,打印error日志时,异常本身不占用占位符。
log.info("请求参数.a={},b={}",a,b);
log.error("异常请求参数.a={},b={}",a,b,e);
2.3 Marker VS MDC
2.3.1 Marker
Marker可以作为打印接口的入参传入。
Marker marker = MarkerFactory.getMarker("mq");
log.info(marker, "mq request. parameter={}", "para");
Marker 是一个标记,它会传递给日志实现层,由实现层决定 Marker 的处理方式,比如:
1.将Marker通过%marker打印出来
2.使用MarkerFilter过滤出(或过滤掉)带有某个Marker的日志,写到一个单独的日志文件;
2.3.2 MDC
MDC的全称是Mapped Diagnostic Context,直译为映射调试上下文. 类似ThreadLocal. 它是线程安全的. 通常作为TraceId使用。
// 和 Map<String, String> 相似的接口定义
MDC.put("key", "value");
String value = MDC.get("key");
MDC.remove("key");
MDC.clear();
// 获取 MDC 中的所有内容
Map<String, String> context = MDC.getCopyOfContextMap();
2.3.3 相同点和不同点
Marker 和 MDC 都是给日志添加一个属性,并传递日志实现层。区别在于 Marker是“横向的”,跨线程的,通常用于归类某种业务场景。而MDC是线程级的,最典型的场景就是作为TraceId,记录某个请求完整调用链。