深入源码之JDK Logging

深入源码之JDK Logging

JDK1.4开始提供Logging实现,据说当初JDK打算采用Log4J的,后来因为某些原因谈判没谈拢,然后就自己开发了一套,不知道是为了报复而故意不沿用Log4J的命名方式和抽象方式,还是开发这个模块的人水平不够,或没用心,亦或是我用Commons LoggingLog4J习惯了,看JDKLogging实现怎么看怎么不爽~~~吐个槽额~~~~

JDK Logging将日志打印抽象成以下几个类之间的交互:

1.    Level,定义日志的级别,类似Log4J中的Level类。

JDK Logging采用了完全不同于Log4J中对级别的抽象。在JDK Logging中,默认定义了以下几个级别:SEVERE(对应Log4J中的ERRORFATAL)、WARNING(对应Log4J中的WARN)、INFO(对应Log4J中的INFO)、CONFIG(对应Log4J中的DEBUG)、FINE(对应Log4J中的TRACE)、FINER(对应Log4J中的TRACE)、FINEST(对应Log4J中的TRACE)。另外,类似Log4JJDK Logging也定义了两个特殊的级别:ALLOFF,分别对应打印所有级别的日志和关闭日志打印。

Level中包含三个字段:namevalueresourceBundleName。其中name指定级别名称,value指定该级别对应的一个int值,其值从SEVERE开始依次递减,resourceBundleName定义本地化后的级别名称,默认是sun.util.logging.resources.logging,即我们在日志中看到警告、信息等级别字段就是通过调用LevelgetLocalizedName()方法,读取resourceBundleName对应的resource值来获得的,这也是Log4J中没有听过的。

Level还定义了一个parse()方法,它可以支持解析name字符串、代表级别的int值(以字符串的形式)、以及对应的Localized名称,如果所有的都不满足需求,则抛出IllegalArgumentException

最后,Level还实现了readResolve()方法,从而确保反序列化后的Level只是Level类中定义的几个实例(出了自定义的Level实例)。

2.    LogRecord,封装了打印一条一直所包含的所有数据,类似Log4J中的LoggingEvent

它包含了以下信息:

a.    日志级别(level

b.    全局标识号(sequenceNumber,即没创建一个LogRecordsequenceNumber都会自增1

c.    打印这条日志语句所在的类的名称(sourceClassName),可以通过调用inferCaller()方法解析出来。解析实现则是通过实例化一个Throwable实例,通过解析该实例的Call Stack即可得出打印这条日志所在的类的名称和方法名称,这里貌似不支持行号、文件名等信息。并且通过设置needToInferCaller字段(不可序列化)来判断sourceClassNamesourceMethodName是否已经取得,从而不用每次调用的时候都去解析而提升性能。

d.    打印这条日志语句所在调用方法的名称(sourceMethodName),它也是通过调用inferCaller()方法解析出来。

e.    打印消息(message

f.     线程号(threadID),对LogRecord本身而言,从0开始对每个线程自增1

g.    创建LogRecord的时间(millis

h.    打印日志中的异常(thrown

i.      日志名称(loggerName

j.     资源名称(resourceBundleName

k.    参数列表(parameters数组),在Formatter中通过MessageFormat使用这些参数列表,并在序列化是手动调用其toString()方法序列化,而不是采用默认的序列化方式。

l.      ResourceBundle实例,获取本地消息,不可序列化。

3.    Formatter,根据配置格式化一条日志记录,类似Log4J中的Layout

JDK Logging支持两种类型的FormatterSimpleFormatterXMLFormatter,默认采用SimpleFormatter,它先打印日期和时间、LoggerNamesource ClassName、方法名称,然后换行,在打印日志级别、本地化后的消息,然后换行,打印异常信息。而XMLFormatter实现getHead()getTail()方法,并且将每条记录写成一条<record></record>记录。吐槽一下,它的实现是在是太不专业了~~

4.    Handler,实现将日志写入指定目的地,如ConsoleHandlerFileHandlerSocketHandler即对应将日志写入控制台、文件、Socket端口。它类似Log4J中的Appender

Handler包含对FormatterLevelFilter的引用,其中FormatterLogRecord格式化成String字符串;Level定义当前Handler支持的日志级别;而Filter则提供一个用户自定义的过滤一些日志的扩展点。

public interface Filter {

        public boolean isLoggable(LogRecord record);

}

用户可以定义自己的Filter类以实现用户自定义的过滤逻辑。Handler还定义了encoding属性,以配置底层日志的输出格式。

Handler中最终要的方法是publish(),它实现了真正打印日志消息的逻辑。

public abstract void close() throws SecurityException;

 

默认JDK Logging实现了StreamHandler,而StreamHandler有三个子类:ConsoleHandlerFileHandlerSocketHandlerStreamHandler支持的配置有:

java.util.logging.StreamHandler.level 设置当前Handler支持的级别,默认为FINE

java.util.logging.StreamHandler.filter 设置当前HandlerFilter,默认为null

java.util.logging.StreamHandler.formatter 设置当前HandlerFormatter类,默认为SimpleFormatter

java.util.logging.StreamHandler.encoding 设置当前Handler的编码方式,默认为null

 

ConsoleHandler只是将OutputStream设置为System.err,其他实现和StreamHandler类似。

 

SocketHandlerOutputStream绑定到对应的端口号中,其他也和StreamHandler类似。另外它还增加了两个配置:java.util.logging.SocketHandler.portjava.util.logging.SocketHandler.host分别对应端口号和主机。

 

FileHandler支持指定文件名模板(java.util.logging.FileHandler.pattern),文件最大支持大小(java.util.logging.FileHandler.limit,字节为单位,0为没有限制),循环日志文件数(java.util.logging.FileHandler.count)、对已存在的日志文件是否往后添加(java.util.logging.FileHandler.append)。

FileHandler支持的文件模板参数有:

/     目录分隔符

%t   系统临时目录

%h 系统当前用户目录

%g 生成的以区别循环日志文件名

%u 一个唯一的数字以处理冲突问题

%% 一个%

5.    LogManager类,读取配置文件和管理Logger实例,类似Log4JLogRepository

LogManager类初始化时,用户可以通过指定java.util.logging.manager系统属性以自定义LogManager,默认使用LogManager类本身。初始化完成后创建RootLogger,并将新创建的RootLogger实例加入到LogManager中。LogManager中将所有创建的Logger缓存在loggers字段中(Hashtablename作为keyWeakReference<Logger>作为value)。RootLoggername为空,因而所有对RootLogger的配置都从”.”开始。

 

Logger的配置支持一下几种方式:

<name>.level=INFO|CONFIG….

handers=<handlerName1>,<handlerName2>…. (”,”分隔或以空格、TAB等字符分隔,全局Handler)

config=<configClassName1>,<configClassName2>….(自定义类,实现在其构造函数中实现自定义配置)

<name>.userParentHandlers=true|false|1|0

<name>.handlers=<handlerName1>,<handlerName2>…(”,”分隔或以空格、TAB等字符分隔)

<handlerName>.level=INFO|CONFIG….

以及各自Handler本身支持的配置,具体各自的Handler

 

用户可以通过以下方式自定义配置文件:

a.    设置系统属性java.util.logging.config.class,由自定义类的构造函数实现自定义配置,如调用LogManagerLogger中的一些静态方法。

b.    设置系统属性java.util.logging.config.file,自定义配置文件路径。读取该文件中的内容作为配置信息。

c.    默认使用${java.home}/lib/logging.properties文件作为配置文件(JDK已经提供了一些默认配置,一般是${JRE_HOME}/lib/logging.properties文件)

 

类似Log4JLogManager也将Logger构建成树状结构,并且对那些暂时没有真正Logger实例的节点,使用LogNode,同样构建成树,这个实现也类似Log4JProvisionNode

6.    Logger类,用户打印log接口,类似Log4J中的Logger

Logger包含nameHandlersresourceBundleNameuseParentHandlersfilteranonymouslevelObjectparentkids等字段。其中其他字段都比较容易理解,anonymous比较难理解,按注释,它是用来表达当前Logger是一个匿名Logger,即不会被加入到LogManager中,因而也不需要安全检查,匿名Logger一般在Applet中使用,对Applet不了解,因而也无法做更详细的解释。在构建树时,该Logger同时保持了父节点和子节点的所有引用,对JDK这个Logging的实现一直无力吐槽。

Logger提供getLogger()接口,这个也是一般用户直接打交道的接口,传入name,返回缓存的Logger实例或新创建一个Logger实例。

对匿名LoggerLogger提供getAnonymousLogger()接口。log(LogRecord)方法是对打印日志的真正实现:

public void log(LogRecord record) {

    if (record.getLevel().intValue() < levelValue || levelValue == offValue) {

        return;

    }

    synchronized (this) {

        if (filter != null && !filter.isLoggable(record)) {

            return;

        }

    }

    Logger logger = this;

    while (logger != null) {

        Handler targets[] = logger.getHandlers();

        if (targets != null) {

            for (int i = 0; i < targets.length; i++) {

                targets[i].publish(record);

            }

        }

        if (!logger.getUseParentHandlers()) {

            break;

        }

        logger = logger.getParent();

    }

}

其他log方法只是对该方法中LogRecord中不同字段参数的组合。其他logp()系类方法只是提供给用户自定log所在的方法名和类名;而enteringexistingthrown等几个方法只是几个傻逼的命名而已。

 

最后给张JDK Logging的类图吧:


你可能感兴趣的:(深入源码之JDK Logging)