前言
本文介绍了各个Log框架的优劣势,而且介绍了利用slf4j作为接口,底层使用各个日志实现。
commons-logging
apache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC 的api 接口,具体的的JDBC driver 实现由各数据库提供商实现。通过统一接口解耦,不过其内部也实现了一些简单日志方案。
slf4j
slf4j全称Simple Logging Facade for JAVA。是一个日志系统的接口,不提供实现,只提供api。设计出来是为了让任何一种日志实现方案可以方便的接入。例如log4j, logback, JUL, simple, NOP 和 JCL。相比之下,比commons-logging设计更好。
log4j
一、Loggers——The ability to selectively enable or disable logging requests based on their logger.
Apache的开源项目,是一个功能强大的日志组件,提供方便的日志记录。基本上所有的日志系统(库)对于日志记录的抽象都差不多,就是 日志记录者(Loggers)将message以某种格式(Layouts)写到某些日志文件(Appenders)中。
这里有三个关键的概念——Loggers,Layouts,Appenders,正是Log4J的三个核心概念。下面我们一一介绍一下。
- Loggers是树形继承关系的,这个关系将影响到下面的Appenders,因此掌握这个概念很重要。
有且仅有一个root logger,应用程序通过Logger.getRootLogger()获取而不是通过名字;其他的Loggers都是root logger的子孙Loggers,应用程序通过Logger.getLogger(loggerName)获取。他们之间的继承关系通过名字确定。 - 每个Loggers都必须有记录等级,Loggers之间的等级也存在一种继承关系,但是这种继承关系是一种重载的关系,即如果子Logger有定义了自己的LEVEL,那么它就不需要继承父Logger的LEVEL。每个LEVEL都有一个相应的方法供应用程序调用:分别是 debug, info, warn, error, fatal and log. 如logger.info("..")。但是这里要特别注意一下,Logger只会打印日志级别大于等于它本事level的日志请求。比如一个level配置为warn的logger,发送给这个logger的info、debug级别的日志就不会打印出来。
这个规则是log4j的核心. level之间是有顺序的,对于内建的level,顺序如下:DEBUG < INFO < WARN < ERROR < FATAL. 下面是这个规则的一个例子:
//建立Logger的一个实例,命名为“com.foo”
Logger logger = Logger.getLogger("com.foo"); //"com.foo"是实例进行命名,也可以任意
//设置logger的级别。通常不在程序中设置logger的级别。一般在配置文件中设置。
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
//下面这个请求可用,因为WARN >= INFO
logger.warn("Low fuel level.");
//下面这个请求不可用,因为DEBUG < INFO
logger.debug("Starting search for nearest gas station.");
//命名为“com.foo.bar”的实例barlogger会继承实例“com.foo”的级别。因此,下面这个请求可用,因为INFO >= INFO
barlogger.info("Located nearest gas station.");
//下面这个请求不可用,因为DEBUG < INFO
barlogger.debug("Exiting gas station search");
- Loggers的获取方式采用了工厂方法,返回的是Singleton。
通过getLogger(name)方式,传递同样的name会返回一样的logger对象:
// x and y refer to exactly the same logger object.
Logger x = Logger.getLogger("huskyLog");
Logger y = Logger.getLogger("huskyLog");
二、Appenders——Allow logging requests to print to multiple destinations
禁用与使用日志请求只是Log4j其中的一个小小的地方,Log4j日志系统允许把日志输出到不同的地方,如控制台(Console)、文件(Files),根据天数或者文件大小产生新的文件,以流的形式发送到其它地方,异步记录日志等等。
1、定义:appender其实就是输出源(output destination, target, endpoint)。可以是终端、文件、图形界面、远程socket服务、JMS、邮件等。还支持日志的异步写入。
2、一个logger可以有一个或多个appender,即日志可以同时记录到多个地方。通过logger.addAppender(Appender newAppender)方法将appender添加到指定的logger。
3、每一个发送给logger的合法(即没有被logger等级过滤掉)日志请求都会发送到该logger关联的每一个appenders和该logger的每一个父logger的appender。换一种说法就是logger会继承父logger的appender。可以通过设置additivity=false取消。
这个规则称之为Appender Additivity,也算是log4j最复杂的规则吧。
4、Appender也有level等级。在Logger中称之为level,在appender中称之为Threshold,决定Appender记录什么等级的日志。可以对通过logger级别过滤的日志进行最后一次的过滤。比如:
Log4j.properties:
# Root logger option
log4j.rootLogger=debug, stdout, file
# Redirect log messages to console
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
# Redirect log messages to a log file, support file rolling.
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=${project.home}/log/log4j-application.log
log4j.appender.file.Threshold=WARN
log4j.appender.file.MaxFileSize=5MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
Log4j内建的Apperders:
5、Appender可以有一个或者多个Filter,对日志信息进行过滤。例如:
<appender name="file" class="org.apache.log4j.RollingFileAppender">
<param name="append" value="false" />
<param name="maxFileSize" value="10MB" />
<param name="maxBackupIndex" value="10" />
<param name="file" value="${project.home}/log/log4j-application.log" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
</layout>
<filter class="org.apache.log4j.filter.ExpressionFilter">
<param name="Expression" value="EXCEPTION ~=java.lang.ArithmeticException" />
<param name="AcceptOnMatch" value="false"/>
</filter>
</appender>
三、Layouts——customize the output format
如果说appender是控制日志输出到哪里,那么layout就是控制日志以何种格式打印。每一个appender一般有一个layout相关联。远程Appender只是发送日志信息,不需要Layout。
一般都是是配置PatternLayout,配置起来很类似于C的printf。
Log4j内建的Layout:
四、配置
Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java Properties文件(key=value)。log4j在启动时,检查用户是否通过环境变量log4j.configuration指定了配置文件的路径,如果指定了,则加载之。否则,优先加载log4j.xml,如果找不到,再查找log4j.properties。
Java Properties相对于XML比较简洁,但是一些高级功能只支持XML配置,比如Filters、自定义ErrorHandlers和一些特定类型的Appender,比如Nested appenders such as the AsyncAppender。
log4j的配置其实就是配置上面说的三个核心组件。
1、配置logger
log4j.logger.${logerName}=[${logLevel}], [${appenderName1}], [${appenderName2}], ...
其中根Logger没有名称,直接用rootLogger指定:
log4j.rootLogger=[logLevel], ${appenderName1}, ${appenderName2}, ...
其他的logger名称一般采用类的全路径名,例如
log4j.logger.org.springframework=ERROR。
appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。例如:log4j.rootLogger=info,A1,B2,C3。
2、配置日志信息输出目的地(Appender)
语法为:
log4j.appender.${appenderName}=fully.qualified.name.of.appender.class
其中fully.qualified.name.of.appender.class可以指定下面内建Appender中的一个,也可以是自定义的Appender。
3、配置日志信息的格式(Layout)
语法为:
log4j.appender.${appenderName}.layout=fully.qualified.name.of.layout.class
log4j最佳实践
1.使用Spring的Log4jConfigListener动态加载
Spring的Log4jConfigListener支持如下功能:
定时刷新配置文件,即修改log4j.properties,不需要重启Web应用。这需要在web.xml中设置一下log4jRefreshInterval参数。
可以把log4j.properties和其他properties一起放在/WEB-INF/,而不是Class-Path。也支持环境变量。
把log文件定在 /WEB-INF/logs/ 而不需要写绝对路径。
在web.xml配置:
<context-param>
<param-name>webAppRootKey</param-name>
<param-value>webapp.root.one</param-value>
</context-param>
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>classpath:conf-log4j/${env}_log4j.properties</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>
2.服务器日志与应用日志分离 && 应用模块之间日志分离:
这个关键在于意识,不在于实现。因为log4j已经内建支持了。但是很多开发同学都没有意识到将不同模块的日志分离的好处。比如将tomcat的日志单独分离出去,把gcm的消息推送日志单独成一个日志文件,将统计日志单独一个文件等等。
实现很简单,只要多配置几个Logger和Appender就可以了。例如:
# Rules reminder:
# TRACE < DEBUG < INFO < WARN < ERROR < FATAL
# Global logging configuration
log4j.rootLogger=info,console, system
## Console output...
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%p]\t%d\t[%t] %c (%F\:%L) - %m%n
## File output...
log4j.appender.system=org.apache.log4j.DailyRollingFileAppender
log4j.appender.system.File=${LOG_DIR}/system.log
log4j.appender.system.Append=true
#log4j.appender.system.Threshold=INFO
log4j.appender.defaultLogger.DatePattern='.'yyyy-MM-dd
log4j.appender.system.layout=org.apache.log4j.PatternLayout
log4j.appender.system.layout.ConversionPattern=%d [%p] [%t] %c (%F\:%L): %m%n
## File output...
log4j.appender.mbrowser=org.apache.log4j.DailyRollingFileAppender
log4j.appender.mbrowser.File=${LOG_DIR}/mbrowser.log
log4j.appender.mbrowser.Append=true
#log4j.appender.mbrowser.Threshold=INFO
log4j.appender.defaultLogger.DatePattern='.'yyyy-MM-dd
log4j.appender.mbrowser.layout=org.apache.log4j.PatternLayout
log4j.appender.mbrowser.layout.ConversionPattern=%d [%p] [%t] %c (%F\:%L): %m%n
# 3rdparty logging configuration
log4j.logger.org.springframework=WARN
# My logging(Application) logging configuration
log4j.logger.me.arganzheng.study.mbrowser=INFO, mbrowser
log4j.additivity.me.arganzheng.study.mbrowser=false
# GCM
log4j.logger.com.google.android.gcm.server=INFO, mbrowser
log4j.additivity.com.google.android.gcm.server=false
有多个logger和appender的时候要注意一下additivity 配置项。