java_log4j----java 日志管理

log4j 有三个主要组件：



 
类别Loggers------消息类型和优先级 


 
附加目的地Appenders-------在哪里报告消息 


 
布局Layouts------控制如何格式化消息 



这三个组件共同合作，使开发者可以根据消息类型和优先级记录消息，并在运行时控制如何格式化消息以及在哪里报告消息.


Log4j基本使用方法


Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。


定义配置文件


Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：



 
配置根Logger，其语法为： 

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 
appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。 
 


 
配置日志信息输出目的地Appender，其语法为 

log4j.appender.appenderName = fully.qualified.name.of.appender.class  log4j.appender.appenderName.option1 = value1  …  log4j.appender.appenderName.option = valueN
其中，Log4j提供的appender有以下几种： 
org.apache.log4j.ConsoleAppender（控制台）， 
org.apache.log4j.FileAppender（文件）， 
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）， 
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方） 
 


 
配置日志信息的格式（布局），其语法为： 

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class  log4j.appender.appenderName.layout.option1 = value1  …  log4j.appender.appenderName.layout.option = valueN
其中，Log4j提供的layout有以下几种： 
org.apache.log4j.HTMLLayout（以HTML表格形式布局）， 
org.apache.log4j.PatternLayout（可以灵活地指定布局模式）， 
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）， 
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息） 
 



 


4.Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： 


         %m 输出代码中指定的消息


　　%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL 
　　%r 输出自应用启动到输出该log信息耗费的毫秒数 
　　%c 输出所属的类目，通常就是所在类的全名 
　　%t 输出产生该日志事件的线程名 

　　%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” 
　　%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 
　　%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10) 


 


log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。


org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。 

8 log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log

此句为定义名为R的输出端的文件名为D:\Tomcat 5.5\logs\qc.log

可以自行修改。


15 log4j.logger.org.apache.commons=ERROR

16 log4j.logger.org.apache.struts=WARN

这两句是struts的包。

17 log4j.logger.org.displaytag=ERROR

这句是displaytag的包。（QC问题列表页面所用）

18 log4j.logger.org.springframework=DEBUG

此句为Spring的包。

24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

25 log4j.logger.org.hibernate=DEBUG

此两句是hibernate的包。







 


=======================================================


在WEB-INF\classes 中新建“log4j.properties”文件，加入以下代码，便能实现将错误信息在后台显示并写入到日志文件“jkpt-two.log”中：


log4j.rootLogger=ERROR,THEONE,THETWO


###################
# THEONE Appender
###################
log4j.appender.THEONE=org.apache.log4j.ConsoleAppender
log4j.appender.THEONE.layout=org.apache.log4j.PatternLayout
log4j.appender.THEONE.layout.ConversionPattern= %d{ISO8601}-[%p][%C{1}]-%m%n



###################
# THETWO Appender
###################
log4j.appender.THETWO=org.apache.log4j.DailyRollingFileAppender


log4j.appender.THETWO.File=C:/Program Files/Apache Group/Tomcat 5.0/logs/jkpt-two.log
log4j.appender.THETWO.File.MaxFileSize=500KB
log4j.appender.THETWO.File.MaxBackupIndex=50
log4j.appender.THETWO.File.Append=true
log4j.appender.THETWO.layout=org.apache.log4j.PatternLayout
log4j.appender.THETWO.layout.ConversionPattern= %d{ISO8601}-[%p][%C{1}]-%m%n


 


这段代码的解释如下：


log4j.rootLogger=ERROR,THEONE,THETWO   


----表示要获取的是“ERROR”级的信息；分别有两个“处理方式”：THEONE,THETWO   


ConsoleAppender，DailyRollingFileAppender


----表示“控制台”和“文件大小到达指定尺寸的时候产生一个新的文件”


PatternLayout


----表示“可以灵活地指定布局模式”


ConversionPattern


----表示输出的格式


log4j.appender.THETWO.File=C:/Program Files/Apache Group/Tomcat 5.0/logs/jkpt-two.log


----表示将信息写入“jkpt-two.log”中。


=====================================================


二、在代码中使用Log4j


　　1.得到记录器


　　使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为： 


　　public static Logger getLogger( String name) 


　　通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如： 


　　static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )


　　2.读取配置文件 


　　当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：


　　BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
　　PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
　　DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。


　　3.插入记录信息（格式化日志信息）


　　当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：


　　Logger.debug ( Object message ) ;
　　Logger.info ( Object message ) ;
　　Logger.warn ( Object message ) ;
　　Logger.error ( Object message ) ;


 


在代码中使用Log4j

我们在需要输出日志信息的类中做如下的三个工作：

1、导入所有需的commongs-logging类：

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员：

private final Log log = LogFactory.getLog(getClass());

LogFactory.getLog()方法的参数使用的是当前类的class。

3、使用org.apache.commons.logging.Log类的成员方法输出日志信息：

if (log.isDebugEnabled())

{

log.debug("111");

}

if (log.isInfoEnabled())

{

log.info("222");

}

if (log.isWarnEnabled())

{

log.warn("333");

}

if (log.isErrorEnabled())

{

log.error("444");

}

if (log.isFatalEnabled())

{

log.fatal("555")

}  


==============================


### direct log messages to stdout ###
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{ABSOLUTE} %5p %c{1}:%L - %m%n


### direct messages to file hibernate.log ###
#log4j.appender.file=org.apache.log4j.FileAppender
#log4j.appender.file.File=hibernate.log
#log4j.appender.file.layout=org.apache.log4j.PatternLayout
#log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n


### set log levels - for more verbose logging change 'info' to 'debug' ###


log4j.rootLogger=info, stdout


log4j.logger.net.sf.hibernate=info


### log just the SQL
#log4j.logger.net.sf.hibernate.SQL=debug


### log JDBC bind parameters ###
log4j.logger.net.sf.hibernate.type=info


### log schema export/update ###
log4j.logger.net.sf.hibernate.tool.hbm2ddl=debug


### log cache activity ###
#log4j.logger.net.sf.hibernate.cache=debug


### enable the following line if you want to track down connection ###
### leakages when using DriverManagerConnectionProvider ###
#log4j.logger.net.sf.hibernate.connection.DriverManagerConnectionProvider=trace