定义
log4j--log for java(java的日志)n
在强调可重用组件开发的今天,除了自己从头到尾开发一个可重用的日志操作类外,Apache为我们提供了一个强有力的日志操作包-Log4j。n
此外,通过Log4j其他语言接口,您可以在C、C++、.Net、PL/SQL程序中使用Log4j,其语法和用法与在Java程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块。而且,通过使用各种第三方扩展,您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。n
说明:下面分为三部分,n
第一部分讲解如何配置log4j;n
第二部分为对log4j.properties配置文件中的各个属性的讲解;n
第三部分为对log4j的详细讲解。n
如果只想配置上log4j,那么只需要看前两个部分就可以,如果想对log4j深入了解,则还需看第三部分。n使用的license:Apache License V2.0。
配置
第一步n
加入log4j-1.2.8.jar(可以选择log4j的更高版本)到lib下。n
如果使用maven项目,也可以选择在pom.xml中新增依赖:n
第二步n
在CLASSPATH下建立log4j.properties。内容如下(数字为行号):
第三步n
相应的修改其中属性,修改之前就必须知道这些都是干什么的,在第二部分讲解。
第四步n
在要输出日志的类中加入相关语句:n
定义属性:static Logger logger=Logger.getLogger(LogDemo.class);//LogDemo为相关的类。n
在相应的方法中:n
if(logger.isDebugEnabled()){n
logger.debug(“System…..”);n}
说明
1、log4j.rootCategory=INFO,stdout,R
此句为将等级为INFO的日志信息输出到stdout和R这两个目的地,stdout和R的定义在下面的代码,可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL,如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO,WARN,ERROR的log信息,而DEBUG信息不会被显示,具体讲解可参照第三部分定义配置文件中的logger。
2、log4j.appender.stdout=org.apache.log4j.ConsoleAppender
此句为定义名为stdout的输出端是哪种类型,可以是
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
具体讲解可参照第三部分定义配置文件中的Appender。
3、log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
此句为定义名为stdout的输出端的layout是哪种类型,可以是
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
具体讲解可参照第三部分定义配置文件中的Layout。
4、log4j.appender.stdout.layout.ConversionPattern=【QC】 %p 【%t】 %C.%M(%L) | %m%n
如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,打印参数如下:
%m输出代码中指定的消息;n
%M输出打印该条日志的方法名;n
%p输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL;n
%r输出自应用启动到输出该log信息耗费的毫秒数;n
%c输出所属的类目,通常就是所在类的全名;n
%t输出产生该日志事件的线程名;n
%n输出一个回车换行符,Windows平台为"rn”,Unix平台为"n”;n
%d输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},输出类似:2002-10-18 22:10:28,921;n
%l输出日志事件的发生位置,及在代码中的行数;
【QC】是log信息的开头,可以为任意字符,一般为项目简称。
输出的信息
【TS】DEBUG【main】AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean'MyAutoProxy'
具体讲解可参照第三部分定义配置文件中的格式化日志信息。
5、log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。
6、log4j.appender.R.File=D:Tomcat 5.5logsqc.log
此句为定义名为R的输出端的文件名为D:Tomcat 5.5logsqc.log可以自行修改。
7、log4j.appender.R.layout=org.apache.log4j.PatternLayout
与第4行相同。
8、log4j.appender.R.layout.ConversionPattern=%d-【TS】 %p %t %c-%m%n
与第5行相同。
9、log4j.logger.com.neusoft=DEBUG
指定com.neusoft包下的所有类的等级为DEBUG。
可以把com.neusoft改为自己项目所用的包名。
10、log4j.logger.com.opensymphony.oscache=ERROR
11、log4j.logger.net.sf.navigator=ERROR
这两句是把这两个包下出现的错误的等级设为ERROR,如果项目中没有配置ehcache,则不需要这两句。
12、log4j.logger.org.apache.commons=ERRORn
13、log4j.logger.org.apache.struts=WARNn
这两句是struts的包。n
14、log4j.logger.org.displaytag=ERRORn
这句是displaytag的包。(QC问题列表页面所用)n
15、log4j.logger.org.springframework=DEBUGn
此句为Spring的包。n
16、log4j.logger.org.hibernate.ps.PreparedStatementCache=WARNn
17、log4j.logger.org.hibernate=DEBUGn
此两句是hibernate的包。n
以上这些包的设置可根据项目的实际情况而自行定制。
详解
定义配置文件
Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法:
①、配置根Logger
Logger负责处理日志记录的大部分操作。
其语法为:
log4j.rootLogger=【level】,appenderName,appenderName,…
其中,level是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志,OFF:关闭所有的日志输出。appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
②、配置日志信息输出目的地Appender
Appender负责控制日志记录操作的输出。
其语法为:
log4j.appender.appenderName=fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1=value1
…
log4j.appender.appenderName.optionN=valueN
这里的appenderName为在①里定义的,可任意起名。
其中,Log4j提供的appender有以下几种:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),可通过log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender
定义一个名为stdout的输出目的地,ConsoleAppender为控制台。
③、配置日志信息的格式(布局)Layout
Layout负责格式化Appender的输出。
其语法为:
log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1=value1
…
log4j.appender.appenderName.layout.optionN=valueN
其中,Log4j提供的layout有以下几种:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
格式化日志
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下:n
%m输出代码中指定的消息;n
%M输出打印该条日志的方法名;n
%p输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL;n
%r输出自应用启动到输出该log信息耗费的毫秒数;n
%c输出所属的类目,通常就是所在类的全名;n
%t输出产生该日志事件的线程名;n
%n输出一个回车换行符,Windows平台为"rn”,Unix平台为"n”;n
%d输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},输
出类似:2002-10-18 22:10:28,921;n
%l输出日志事件的发生位置,及在代码中的行数。
运用在代码中
我们在需要输出日志信息的类中做如下的三个工作:n
1、导入所有需的commons-logging类:n
import org.apache.commons.logging.Log;n
import org.apache.commons.logging.LogFactory;n
2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员:n
private final Log log=LogFactory.getLog(getClass());n
LogFactory.getLog()方法的参数使用的是当前类的class。n
3、使用org.apache.commons.logging.Log类的成员方法输出日志信息:n
if(log.isDebugEnabled()){n
log.debug("111");n
}n
if(log.isInfoEnabled()){n
log.info("222");n
}n
if(log.isWarnEnabled()){n
log.warn("333");n
}n
if(log.isErrorEnabled()){n
log.error("444");n
}n
if(log.isFatalEnabled()){n
log.fatal("555");n
}n
2.3如何应用记录器的层次n
2.3.1如何定义及获取不同层次的记录器n
任何一个记录器的使用都有两个步骤:n
1)在配置文件中定义相应的记录器。n
在配置文件中定义记录器的格式有两种n
?定义根记录器的格式为n
log4j.rootLogger=[level],appendName1,appendName2,…appendNameNn
?定义一个非根记录器的格式为n
log4j.logger.loggerName1=[level],appendName1,…appendNameNn
……n
log4j.logger.loggerNameM=[level],appendName1,…appendNameNn
我们可以定义任意个非根记录器。n
2)在代码中调用Logger类的取得记录器方法取得相应的记录器对象。n
要取得根记录器对象可通过Logger.getRootLogger()函数,要取得非根记录器可通过Logger.getLogger()函数。