log4j解析(包含源码)

为什么80%的码农都做不了架构师&＃xff1f;>>>

读前问题&＃xff1a;

1&＃xff1a;log4j的日志流程是怎么样的&＃xff1f;

2&＃xff1a;log4j的配置文件各项都是什么含义&＃xff1f;特别是有些配置里面有包名到底有什么用&＃xff1f;

3&＃xff1a;log4j的输出都是什么含义&＃xff1f;具体见log4j conversion pattern各格式含义

一。log4j全局说明

log4j采用logger&＃xff0c;appender模式&＃xff0c;其中logger含有层级信息&＃xff0c;顶级logger为rootLogger&＃xff0c;其他logger在在解析时会以.(英文点号)为分隔符

划分层级&＃xff0c;在获取logger时名字决定了要获取的logger实例

二。log4j配置文件解析

解析流程&＃xff1a;

解析全局配置 &＃61;> 解析log4j.rootLogger &＃61;> 解析log4j.appender.* &＃61;>解析logFactory &＃61;> 解析log4j.logger.* &＃61;> 解析renderers

2.1:解析全局配置

全局配置包含&＃xff1a;

log4j.debug&＃61;true : Defining this value makes log4j print log4j-internal debug statements to System.out.log4j.reset&＃61;true : If property set to true, then hierarchy will be reset before configurationlog4j.threshold&＃61;INFO #全局级别设定&＃xff0c;不超过这个级别的一律不输出

2.2:解析log4j.rootLogger

格式&＃xff1a;log4j.rootLogger&＃61;priority,appenderName1,appenderName2

说明&＃xff1a;priority是日志级别&＃xff0c;包含由低到高DEBUG,INFO,WARN,ERROR,FATAL五个级别

appenderName是自己定义的名称&＃xff0c;只要与后面的一致就可以了,标示了在这个logger下面的输出器

ps&＃xff1a;根logger必须有&＃xff0c;是所有其余logger的顶级parent&＃xff0c;他自身parent为null

rootLogger的名称为root&＃xff0c;默认的

2.3&＃xff1a;解析log4j.appender.*
格式&＃xff1a;

log4j.appender.appenderName&＃61;appenderClass log4j.appender.appenderName.threshold&＃61;priority log4j.appender.appenderName.layout&＃61;layoutClass log4j.appender.appenderName.layout.ConversionPattern&＃61;conversionPattern log4j.appender.appenderName.filter.filterName&＃61;filterClass log4j.appender.appenderName.errorhandler&＃61;errorhandlerClass log4j.appender.appenderName.errorhandler.root-ref&＃61;[true|false] log4j.appender.appenderName.errorhandler.logger-ref&＃61;loggerName

说明&＃xff1a;上面只是列出了一部分&＃xff0c;像filter跟errorhandler平常我们基本不会用到&＃xff0c;其实只要记住log4j.appender.appenderName后面的配置都是appender的属性就可以了

譬如自己继承了AppenderSkeleton这个类&＃xff0c;里面有一个attr的属性可以用log4j.appender.appenderName.attr&＃61;anyValue

appender自身也有级别过滤日志是否输出&＃xff0c;可以用log4j.appender.appenderName.threshold&＃61;ERROR 这样就设定这个appender只输出ERROR级别的日志

2.4:解析logFactory

格式&＃xff1a;log4j.loggerFactory&＃61;loggerFactoryClass

就是讲log4j默认的日志工厂替换为自定义的&＃xff0c;基本没有必要这么做

2.5:解析log4j.logger.*

格式&＃xff1a;log4j.logger.loggerName&＃61;priority,appenderName1,appenderName2

说明&＃xff1a;这个logger的解析流程与rootLogger的基本一致&＃xff0c;不同点在于logger是有层级的

假设我们有这几个配置&＃xff1a;log4j.logger.com.oschina.net&＃61;DEBUG,appenderName

log4j.logger.com.oschina.net.web.action&＃61;INFO,appenderName

log4j.logger.com&＃61;ERROR,appenderName

log4j解析规则为&＃xff1a;

解析loggerName &＃61; log4j.logger.后面的内容&＃xff0c;譬如loggerName为com.oschina.net.web.action

解析上下级关系&＃xff1a;com.oschina.net.web.action的有效parent为com.oschina.net&＃xff0c;

com.oschina.net的有效parent为com

com的有效parent为root

ps:这里所说为有效parent&＃xff0c;实际上com.oschina.net的直接parent为com.oschina&＃xff0c;再上级的parent才是com&＃xff0c;这里log4j做了一个处理&＃xff0c;将com.oschina这一级

设定为一个占位符ProvisionNode&＃xff0c;没有任何的appender

2.6&＃xff1a;解析renderers

格式&＃xff1a;log4j.renderer.renderedClass&＃61;renderingClass #定制对象显示使用renderingClass来render renderedClass

说明&＃xff1a;renderer就是为了解决我们在直接打印对象的时候如何输出值的问题&＃xff0c;而不是直接调用toString方法

三&＃xff1a;log4j的日志打印规则

通常我们都是这样来获取一个logger实例&＃xff1a;

Logger logger &＃61; LoggerFactory.getLogger(ObjectClass.class);

这里面的获取逻辑为&＃xff1a;

假设ObjectClass.class的全限定路径为com.oschina.net.web.action.controller,那么LoggerFactory会生成一个名称为com.oschina.net.web.action.controller的logger&＃xff08;会缓存起来&＃xff0c;下次直接使用&＃xff09;&＃xff0c;并初始化他的parent&＃xff0c;此时logger的层级关系为&＃xff1a;

日志打印时会自底向上用各自的appender输出日志内容&＃xff0c;贴一下代码&＃xff1a;

for (Category c &＃61; this; c !&＃61; null; c &＃61; c.parent) {// Protected against simultaneous call to addAppender, removeAppender,...synchronized (c) {if (c.aai !&＃61; null) {writes &＃43;&＃61; c.aai.appendLoopOnAppenders(event);}if (!c.additive) {break;}}}

不过这里有一点需要说明&＃xff0c;因为在日志打印的时候需要判断logger的threshold&＃xff0c;但是生成的最下面的com.oschina.net.web.action.controller这个loggerthreshold为null&＃xff0c;

log4j会自底向上找到第一个不为null的logger来判定是否可以输出当前日志&＃xff0c;因此在logger级别设定的时候就需要注意parent的级别需要比child的级别低&＃xff0c;不然很容易导致

日志文件中输出了2条或以上的日志信息

四。appender类图

由于Logger相关类只有两个(另一个是Category类)&＃xff0c;configure相关类和filter类继承相关都很简单&＃xff0c;这里只贴一个自己做的appender相关的类图