Logger组件:Tomcat的日志框架及实战
每一个系统都有一些通用的模块,比如日志模块、异常处理模块、工具类等,对于 Tomcat 来说,比较重要的通用模块有日志
、Session 管理
和集群管理
。
日志模块作为一个通用的功能,在系统里通常会使用第三方的日志框架。Java 的日志框架有很多,比如:JUL(Java Util Logging)、Log4j、Logback、Log4j2、Tinylog 等。除此之外,还有 JCL(Apache Commons Logging)和 SLF4J 这样的“门面日志”
。下面是 SLF4J 与日志框架 Logback、Log4j 的关系图:
这种门面模式的好处在于,记录日志的 API 和日志输出的服务分离开,代码里面只需要关注记录日志的 API,通过 SLF4J 指定的接口记录日志;而日志输出通过引入 JAR 包的方式即可指定其他的日志框架
。当我们需要改变系统的日志输出服务时,不用修改代码,只需要改变引入日志输出框架 JAR 包。
今天我们就来看看 Tomcat 的日志模块是如何实现的。默认情况下,Tomcat 使用自身的 JULI 作为 Tomcat 内部的日志处理系统。JULI 的日志门面采用了 JCL;而 JULI 的具体实现是构建在 Java 原生的日志系统java.util.logging之上的,所以在看 JULI 的日志系统之前,我先简单介绍一下 Java 的日志系统。
Java 日志系统
Java 的日志包在java.util.logging路径下,包含了几个比较重要的组件,我们通过一张图来理解一下:
从图上我们看到这样几个重要的组件:
-
Logger:用来记录日志的类。
-
Handler:规定了日志的输出方式,如控制台输出、写入文件。
-
Level:定义了日志的不同等级。
-
Formatter:将日志信息格式化,比如纯文本、XML。
我们可以通过下面的代码来使用这些组件:
public static void main(String[] args) {
Logger logger = Logger.getLogger("com.mycompany.myapp");
logger.setLevel(Level.FINE);
logger.setUseParentHandlers(false);
Handler hd = new ConsoleHandler();
hd.setLevel(Level.FINE);
logger.addHandler(hd);
logger.info("start log");
}
JULI
JULI 对日志的处理方式与 Java 自带的基本一致,但是 Tomcat 中可以包含多个应用,而每个应用的日志系统应该相互独立。Java 的原生日志系统是每个 JVM 有一份日志的配置文件,这不符合 Tomcat 多应用的场景,所以 JULI 重新实现了一些日志接口。
DirectJDKLog
Log 的基础实现类是 DirectJDKLog,这个类相对简单,就包装了一下 Java 的 Logger 类。但是它也在原来的基础上进行了一些修改,比如修改默认的格式化方式。
LogFactory
Log 使用了工厂模式来向外提供实例,LogFactory 是一个单例,可以通过 SeviceLoader 为 Log 提供自定义的实现版本,如果没有配置,就默认使用 DirectJDKLog。
private LogFactory() {
// 通过ServiceLoader尝试加载Log的实现类
ServiceLoader<Log> logLoader = ServiceLoader.load(Log.class);
Constructor<? extends Log> m=null;
for (Log log: logLoader) {
Class<? extends Log> c=log.getClass();
try {
m=c.getConstructor(String.class);
break;
}
catch (NoSuchMethodException | SecurityException e) {
throw new Error(e);
}
}
//如何没有定义Log的实现类,discoveredLogConstructor为null
discoveredLogConstructor = m;
}
下面的代码是 LogFactory 的 getInstance 方法:
public Log getInstance(String name) throws LogConfigurationException {
//如果discoveredLogConstructor为null,也就没有定义Log类,默认用DirectJDKLog
if (discoveredLogConstructor == null) {
return DirectJDKLog.getInstance(name);
}
try {
return discoveredLogConstructor.newInstance(name);
} catch (ReflectiveOperationException | IllegalArgumentException e) {
throw new LogConfigurationException(e);
}
}
Handler
在 JULI 中就自定义了两个 Handler:FileHandler 和 AsyncFileHandler。FileHandler 可以简单地理解为一个在特定位置写文件的工具类,有一些写操作常用的方法,如 open、write(publish)、close、flush 等,使用了读写锁
。其中的日志信息通过 Formatter 来格式化。
AsyncFileHandler 继承自 FileHandler,实现了异步的写操作。其中缓存存储是通过阻塞双端队列 LinkedBlockingDeque 来实现的。当应用要通过这个 Handler 来记录一条消息时,消息会先被存储到队列中,而在后台会有一个专门的线程来处理队列中的消息,取出的消息会通过父类的 publish 方法写入相应文件内。这样就可以在大量日志需要写入的时候起到缓冲作用,防止都阻塞在写日志这个动作上。需要注意的是,我们可以为阻塞双端队列设置不同的模式,在不同模式下,对新进入的消息有不同的处理方式,有些模式下会直接丢弃一些日志:
OVERFLOW_DROP_LAST:丢弃栈顶的元素
OVERFLOW_DROP_FIRSH:丢弃栈底的元素
OVERFLOW_DROP_FLUSH:等待一定时间并重试,不会丢失元素
OVERFLOW_DROP_CURRENT:丢弃放入的元素
Formatter
Formatter 通过一个 format 方法将日志记录 LogRecord 转化成格式化的字符串,JULI 提供了三个新的 Formatter。
-
OnlineFormatter:基本与 Java 自带的 SimpleFormatter 格式相同,不过把所有内容都写到了一行中。
-
VerbatimFormatter:只记录了日志信息,没有任何额外的信息。
-
JdkLoggerFormatter:格式化了一个轻量级的日志信息。
日志配置
Tomcat 的日志配置文件为 Tomcat 文件夹下conf/logging.properties。我来拆解一下这个配置文件,首先可以看到各种 Handler 的配置:
handlers = 1catalina.org.apache.juli.AsyncFileHandler, 2localhost.org.apache.juli.AsyncFileHandler, 3manager.org.apache.juli.AsyncFileHandler, 4host-manager.org.apache.juli.AsyncFileHandler, java.util.logging.ConsoleHandler
.handlers = 1catalina.org.apache.juli.AsyncFileHandler, java.util.logging.ConsoleHandler