Log4j用法

 

日志是应用软件中不可缺少的部分，Apache的开源项目Log4j是一个功能强大的日志组件，提供方便的日志记录，具体请参考Log4j文档指南。

Log4j下载
在apache网站，可以免费下载到Log4j最新版本的软件包

Apache log4j  （推荐）

Apache log4j 2

Log4j的包下载完成后，解压，将其中打包好的的log4j-1.x.x.jar导入你的工程LIB中。

Log4j配置

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。

1. 配置文件
Log4J配置文件的基本格式如下：

#配置根Logger
log4j.rootLogger  =   [ level ]   ,  appenderName1 ,  appenderName2 ,   …

#配置日志信息输出目的地Appender
log4j.appender.appenderName  =   fully.qualified.name.of.appender.class 
　　log4j.appender.appenderName.option1  =   value1 
　　… 
　　log4j.appender.appenderName.optionN  =   valueN 

#配置日志信息的格式（布局）
log4j.appender.appenderName.layout  =   fully.qualified.name.of.layout.class 
　　log4j.appender.appenderName.layout.option1  =   value1 
　　… 
　　log4j.appender.appenderName.layout.optionN  =  valueN 

其中 [level] 是日志输出级别，共有5级：

FATAL       0   
ERROR      3   
WARN       4   
INFO         6   
DEBUG      7 

Appender  为日志输出目的地，Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

Layout：日志输出格式，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

打印参数: 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 ) 

2. 在代码中初始化Logger: 
1）在程序中调用BasicConfigurator.configure()方法：给根记录器增加一个ConsoleAppender，输出格式通过PatternLayout设为"%-4r [%t] %-5p %c %x - %m%n"，还有根记录器的默认级别是Level.DEBUG. 
2）配置放在文件里，通过命令行参数传递文件名字，通过PropertyConfigurator.configure(args[x])解析并配置；
3）配置放在文件里，通过环境变量传递文件名等信息，利用log4j默认的初始化过程解析并配置；
4）配置放在文件里，通过应用服务器配置传递文件名等信息，利用一个特殊的servlet来完成配置。

Log4j示例

新建Java工程，代码

[java]  view plain copy print ?

1. package com.homer;  
2.   
3. import org.apache.log4j.BasicConfigurator;  
4. import org.apache.log4j.Logger;  
5. import org.apache.log4j.PropertyConfigurator;  
6. import org.apache.log4j.xml.DOMConfigurator;  
7.   
8.   
9. public class HMain {  
10.     static Logger log4j = Logger.getLogger(HMain.class.getClass());  
11.       
12.     public HMain(){  
13.         System.out.println("hello, I am HMain");  
14.           
15.         printLog();  
16.     }  
17.       
18.     private void printLog(){  
19.         BasicConfigurator.configure();  
20.         PropertyConfigurator.configure("/home/homer/workspace/myLog4j/WebContent/WEB-INF/log4j.properties");  
21.           
22.         DOMConfigurator.configure("");  
23.           
24.         log4j.debug("log4j debug");  
25.         log4j.info("log4j info");  
26.         log4j.warn("log4j warn");  
27.         log4j.error("log4j error");  
28.         log4j.fatal("log4j fatal");  
29.     }  
30. }  

Log4j 配置文件 （log4j.properties）

[html]  view plain copy print ?

1. ### set log levels ###  
2. log4j.rootLogger = debug ,  stdout ,  D ,  E  
3.   
4. ### 输出到控制台 ###  
5. log4j.appender.stdout = org.apache.log4j.ConsoleAppender  
6. log4j.appender.stdout.Target = System.out  
7. log4j.appender.stdout.layout = org.apache.log4j.PatternLayout  
8. log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n  
9.   
10. ### 输出到日志文件 ###  
11. log4j.appender.D = org.apache.log4j.DailyRollingFileAppender  
12. log4j.appender.D.File = logs/log.log  
13. log4j.appender.D.Append = true  
14. log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志  
15. log4j.appender.D.layout = org.apache.log4j.PatternLayout  
16. log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n  
17.   
18. ### 保存异常信息到单独文件 ###  
19. log4j.appender.E = org.apache.log4j.DailyRollingFileAppender  
20. log4j.appender.E.File = /logs/error.log ## 异常日志文件名  
21. log4j.appender.E.Append = true  
22. log4j.appender.E.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!  
23. log4j.appender.E.layout = org.apache.log4j.PatternLayout  
24. log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %l:%c:%t:%r ] - [ %p ]  %m%n  

运行结果（/home/homer/logs目录下）：

控制台（console）

15:56:12,718 DEBUG java.lang.Class:24 - log4j debug
15:56:12,722  INFO java.lang.Class:25 - log4j info
15:56:12,723  WARN java.lang.Class:26 - log4j warn
15:56:12,723 ERROR java.lang.Class:27 - log4j error
15:56:12,723 FATAL java.lang.Class:28 - log4j fatal

error.log

2012-09-20 15:56:12  [ com.homer.HMain.printLog(HMain.java:24):java.lang.Class:http-bio-9980-exec-3:0 ] - [ DEBUG ]  log4j debug
2012-09-20 15:56:12  [ com.homer.HMain.printLog(HMain.java:25):java.lang.Class:http-bio-9980-exec-3:4 ] - [ INFO ]  log4j info
2012-09-20 15:56:12  [ com.homer.HMain.printLog(HMain.java:26):java.lang.Class:http-bio-9980-exec-3:5 ] - [ WARN ]  log4j warn
2012-09-20 15:56:12  [ com.homer.HMain.printLog(HMain.java:27):java.lang.Class:http-bio-9980-exec-3:5 ] - [ ERROR ]  log4j error
2012-09-20 15:56:12  [ com.homer.HMain.printLog(HMain.java:28):java.lang.Class:http-bio-9980-exec-3:5 ] - [ FATAL ]  log4j fatal

log.log

2012-09-20 15:56:12  [ http-bio-9980-exec-3:0 ] - [ DEBUG ]  log4j debug
2012-09-20 15:56:12  [ http-bio-9980-exec-3:4 ] - [ INFO ]  log4j info
2012-09-20 15:56:12  [ http-bio-9980-exec-3:5 ] - [ WARN ]  log4j warn
2012-09-20 15:56:12  [ http-bio-9980-exec-3:5 ] - [ ERROR ]  log4j error
2012-09-20 15:56:12  [ http-bio-9980-exec-3:5 ] - [ FATAL ]  log4j fatal

参考推荐：

log4j日志配置

log4j.properties配置详解

Apache logging services