Log4j基本使用方法

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

　　一、定义配置文件

　　其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：

　　1.配置根Logger，其语法为：

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

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

　　2.配置日志信息输出目的地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（将日志信息以流格式发送到任意指定的地方）

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

　　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（包含日志产生的时间、线程、类别等等信息）

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
%m 输出代码中指定的消息
%n  输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” 
%p  输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r   输出自应用启动到输出该log信息耗费的毫秒数
%c  输出所属的类目，通常就是所在类的全名
%t   输出产生该日志事件的线程名
%d  输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，
        比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l   输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
        举例：Testlog4.main(TestLog4.java:10)
%F  类目名
%L  代码中的行数

　　二、在代码中使用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 ) ;


介绍
命令行参数解析、应用程序配置和日志记录，作为一个应用程序的骨架，随处可见。因此，Apache软件组织开发出了一套通用的类库，用来帮助软件开发人员完成这些“骨架”的建立。其中：
•Commons CLI用于命令行解析
•Commons Configuration用于读取properties格式或者XML格式的配置信息
•Commons Logging和Log4J用来提供日志支持。
这些通用的类库都在http://jakarta.apache.org/commons/index.html网址上提供下载

Log4J是一个高度可配置的Logging框架，提供了结构化，多种目标和格式支持。

•配置Log4J
问题：
Log4J支持Properties和XML两种格式的配置文件。
解决方案：
定义log4j.properties配置文件

# 所有Log信息输出到标准输出(System.out)和在下面指定的一个文件
# WARN是默认的logging级别
log4j.rootCategory = WARN, STDOUT, FILE

# 应用程序的logging级别是DEBUG
log4j.logger.com.discursive = DEBUG

# 配置标准输出Appender
log4j.appender.STDOUT = org.apache.log4j.ConsoleAppender
log4j.appender.STDOUT.layout = org.apache.log4j.PatternLayout
log4j.appender.STDOUT.layout.ConversionPattern = %5p (%F:%L) %m%n

# 配置输出文件Appender
log4j.appender.FILE = org.apache.log4j.RollingFileAppender
log4j.appender.FILE.File = output.log
log4j.appender.FILE.MaxFileSize = 2000KB
log4j.appender.FILE.MaxBackupIndex = 5
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern = %d %-5p %c - %m%n

PropertyConfigurator.configure(getClass()
  .getResource("/resources/log4j.properties"));

Logger logger = Logger.getLogger("com.discursive.SomeApp");
logger.info("This is a info message");
logger.error("This is a error message");

使用BasicConfigurator类来加载log4j.properties配置。使用Logger.getLogger获得一个logger实例。
配置文件中的rootCategory指定将log输出到控制台和output.log文件。文件Appender使用了RollingFileAppender，当文件大小达到最大文件大小(MaxFileSize)2000KB时，RollingFileAppender会备份原log文件，并再创建一个新的log文件。
配置文件指定默认的logging级别是DEBUG(log4j.logger.com.discursive = DEBUG)。所以，所有级别低于DEBUG的log信息都不会被输出。Log4J按重要度定义了五个log级别，分别是：DEBUG, INFO, WARN, ERROR, 和FATAL。
其他：
Log4J还可以使用XML格式的配置文件，使用DOMConfigurator读取。
Log4J使用Appender和Layout来定制log输出。Appender指定输出到何处，Layout指定如何输出(输出的格式)。
Log4J内置的Appender有：
•SMTPAppender
•RollingFileAppender
•SocketAppender
•SyslogAppender
•NTEventLogAppender
Log4J支持的Layout有
•XMLLayout
•PatternLayout
•HTMLLayout
•DateLayout.


附1
# 所有Log信息输出到标准输出(System.out)和在下面指定的一个文件
# WARN是默认的logging级别
log4j.rootCategory = INFO, STDOUT
#log4j.rootCategory = INFO, STDOUT, FILE

# 配置标准输出Appender
log4j.appender.STDOUT = org.apache.log4j.ConsoleAppender
log4j.appender.STDOUT.layout = org.apache.log4j.PatternLayout
log4j.appender.STDOUT.layout.ConversionPattern = %d{ABSOLUTE} %-5p [%c:%L] %m%n

# 配置输出文件Appender
log4j.appender.FILE = org.apache.log4j.RollingFileAppender
log4j.appender.FILE.File = output.log
log4j.appender.FILE.MaxFileSize = 2000KB
log4j.appender.FILE.MaxBackupIndex = 5
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern = %d %-5p [%c:%L] %m%n

# 应用程序的logging级别是DEBUG
log4j.logger.com.xzc = DEBUG


附2
### 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=warn, stdout

log4j.logger.net.sf.hibernate=warn

### 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

附3

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n





 附4
# Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式

# 1.配置根Logger，其语法为：
#　　log4j.rootLogger = [ level ] , appenderName, appenderName, … 

# 2.配置日志信息输出目的地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（将日志信息以流格式发送到任意指定的地方）

# 3.配置日志信息的格式（布局），其语法为：
#　　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（包含日志产生的时间、线程、类别等等信息）

# Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
# %m  输出代码中指定的消息
# %n  输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” 
# %p  输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL 
# %r  输出自应用启动到输出该log信息耗费的毫秒数 
# %c  输出所属的类目，通常就是所在类的全名 
# %t  输出产生该日志事件的线程名
# %d  输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，
#     比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 
# %l  输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
#     举例：Testlog4.main(TestLog4.java:10)
# %F  类目名
# %L  代码中的行数

# 所有Log信息输出到标准输出(System.out)和在下面指定的一个文件 
# 日志信息的优先级从从高到低有ERROR、WARN、INFO、DEBUG
# WARN是默认的logging级别
log4j.rootCategory = INFO, STDOUT
#log4j.rootCategory = INFO, STDOUT, FILE
#log4j.rootCategory = INFO, STD
 
# 配置标准输出Appender
log4j.appender.STDOUT = org.apache.log4j.ConsoleAppender
log4j.appender.STDOUT.layout = org.apache.log4j.PatternLayout
#log4j.appender.STDOUT.layout.ConversionPattern = %d{ABSOLUTE} %-5p [%c:%t:%L] %m%n
log4j.appender.STDOUT.layout.ConversionPattern = %d{ABSOLUTE} %-5p [ %l ] %m%n

# 配置输出文件Appender
log4j.appender.FILE = org.apache.log4j.RollingFileAppender
log4j.appender.FILE.File = output.log
log4j.appender.FILE.MaxFileSize = 2000KB
log4j.appender.FILE.MaxBackupIndex = 5
log4j.appender.FILE.layout = org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern = %d %-5p [%c:%L] %m%n

# 配置默认输出layout
log4j.appender.STD = org.apache.log4j.ConsoleAppender
log4j.appender.STD.layout = org.apache.log4j.TTCCLayout

# 应用程序的logging级别是DEBUG
log4j.logger.com.xzc = DEBUG