log4j使用教程

Log4j简介

 

第1章.     Log4j 的优点

第2章.     配置文件

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

 

2.1.   日志信息的优先级

分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。 
Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。 
假如在一个级别为q的Logger中发生一个级别为p的日志请求，如果p>=q,那么请求将被启用。这是Log4j的核心原则。 
比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来； 

2.2.   输出源的使用

有选择的能用或者禁用日志请求仅仅是Log4j的一部分功能。Log4j允许日志请求被输出到多个输出源。用Log4j的话说，一个输出源被称做一个Appender。 
Appender包括console（控制台）, files（文件）, GUI components（图形的组件）, remote socket servers（socket 服务）, JMS（java信息服务）, NT Event Loggers（NT的事件日志）, and remote UNIX Syslog daemons（远程UNIX的后台日志服务）。它也可以做到异步记录。 
一个logger可以设置超过一个的appender。 
用addAppender 方法添加一个appender到一个给定的logger。对于一个给定的logger它每个生效的日志请求都被转发到该logger所有的appender上和该logger的父辈logger的appender上。

 

2.2.1.  ConsoleAppender

如果使用ConsoleAppender，那么log信息将写到Console。效果等同于直接把信息打印到System.out上了。

 

2.2.2.  FileAppender

使用FileAppender，那么log信息将写到指定的文件中。这应该是比较经常使用到的情况。 
相应地，在配置文件中应该指定log输出的文件名。如下配置指定了log文件名为dglog.txt 
log4j.appender.A2.File=dglog.txt 
注意将A2替换为具体配置中Appender的别名。

 

2.2.3.  DailyRollingAppender

使用FileAppender可以将log信息输出到文件中，但是如果文件太大了读起来就不方便了。这时就可以使用DailyRollingAppender。DailyRollingAppender可以把Log信息输出到按照日期来区分的文件中。配置文件就会每天产生一个log文件，每个log文件只记录当天的log信息：

[c-sharp] view plaincopy

1. log4j.appender.A2=org.apache.log4j.DailyRollingFileAppender   
2. log4j.appender.A2.file=dglog   
3. log4j.appender.A2.DatePattern='.'yyyy-MM-dd   
4. log4j.appender.A2.layout=org.apache.log4j.PatternLayout   
5. log4j.appender.A2.layout.ConversionPattern= %5r %-5p %c{2} - %m%n   

 

2.2.4.  org.apache.log4j.RollingFileAppender

文件大小到达指定尺寸的时候产生一个新的文件。 

[java] view plaincopy

1. log4j.appender.R=org.apache.log4j.RollingFileAppender   
2. log4j.appender.R.File= ../logs/dglog.log   
3. # Control the maximum log file size   
4. log4j.appender.R.MaxFileSize=100KB   
5. # Archive log files (one backup file here)   
6. log4j.appender.R.MaxBackupIndex=1   
7. log4j.appender.R.layout=org.apache.log4j.PatternLayout   
8. log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n   

这个配置文件指定了输出源R，是一个轮转日志文件。最大的文件是100KB，当一个日志文件达到最大尺寸时，Log4J会自动把example.log重命名为dglog.log.1，然后重建一个新的dglog.log文件，依次轮转。

 

2.2.5.  org.apache.log4j.WriterAppender

将日志信息以流格式发送到任意指定的地方。

 

 

 

2.3.  Layout的配置

Layout指定了log信息输出的样式。

 

2.3.1.  布局样式

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

 

2.3.2.  格式

1）%m：消息本身

2）%p：消息的层次,也就是级别DEBUG,INFO,WARN,ERROR,FATAL

3）%r：从程序开始执行到当前日志产生时的时间间隔（微秒）

4）%c：输出当前日志动作所在的category名称（一般是类全名）。例如：如果category名称是"a.b.c","%c{2}"将会输出"b.c"；{2}意谓着输出“以点分隔开的category名称的后两个组件”,如果 {n}没有，将会输出整个category名称。

5）%t：输出当前线程的名称

     6）%x：输出和当前线程相关联的NDC(具体解释见下文),尤其用到像java servlets这样的多客户多线程的应用中。

     7）%n：输出平台相关的换行符。

     8）%%：输出一个"%"字符

     9）%d：输出日志产生时候的日期，当然可以对日期的格式进行定制。例如%d{yyy MMM dd HH:mm:ss,SSS}，输出类似： 2002年10月18日 22：10：28，921   ；如果没有指定后面的格式，将会输出ISO8601的格式。

     10）%l：输出位置信息，相当于%C.%M(%F:%L)的组合。包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

     11）%C：输出日志消息产生时所在的类名，如果类名是“test.page.Class1”%C{1}表示输出类名"Class1" ；%C{2}输出"page.Class1"；而%C则输出"test.page.Class1"。

     12）%M：输出日志消息产生时的方法名称

     13）%F：输出日志消息产生时所在的文件名称

    

     14）%L：输出代码中的行号

 

2.3.3.  例子

例子1：显示日期和log信息 
log4j.appender.A2.layout=org.apache.log4j.PatternLayout 
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %m%n 
打印的信息是： 
2002-11-12 11:49:42,866 SELECT * FROM Role WHERE 1=1 order by createDate desc 

例子2：显示日期，log发生地方和log信息 
log4j.appender.A2.layout=org.apache.log4j.PatternLayout 
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %l "#" %m%n 
2002-11-12 11:51:46,313 cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java:409) "#" 
SELECT * FROM Role WHERE 1=1 order by createDate desc 
  
例子3：显示log级别,时间,调用方法,log信息 
log4j.appender.A2.layout=org.apache.log4j.PatternLayout 
log4j.appender.A2.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} 
method:%l%n%m%n 
log信息: 
[DEBUG] 2002-11-12 12:00:57,376 
method:cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java:409) 
SELECT * FROM Role WHERE 1=1 order by createDate desc

 

2.4.   配置文件的例子:

 

 

 

[xhtml] view plaincopy

1. log4j.rootLogger=DEBUG,CONSOLE,A1,im   
2. log4j.addivity.org.apache=true    
3.   
4. # 应用于控制台   
5. log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender   
6. log4j.appender.Threshold=DEBUG   
7. log4j.appender.CONSOLE.Target=System.out   
8. log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout   
9. log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   
10. #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n   
11.   
12. #应用于文件   
13. log4j.appender.FILE=org.apache.log4j.FileAppender   
14. log4j.appender.FILE.File=file.log   
15. log4j.appender.FILE.Append=false   
16. log4j.appender.FILE.layout=org.apache.log4j.PatternLayout   
17. log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   
18. # Use this layout for LogFactor 5 analysis   
19.   
20.   
21. # 应用于文件回滚   
22. log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   
23. log4j.appender.ROLLING_FILE.Threshold=ERROR   
24. log4j.appender.ROLLING_FILE.File=rolling.log   
25. log4j.appender.ROLLING_FILE.Append=true   
26. log4j.appender.ROLLING_FILE.MaxFileSize=10KB   
27. log4j.appender.ROLLING_FILE.MaxBackupIndex=1   
28. log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout   
29. log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   
30.   
31. #应用于socket   
32. log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender   
33. log4j.appender.SOCKET.RemoteHost=localhost   
34. log4j.appender.SOCKET.Port=5001   
35. log4j.appender.SOCKET.LocationInfo=true   
36. # Set up for Log Facter 5   
37. log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout   
38. log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n   
39.   
40.   
41. # Log Factor 5 Appender   
42. log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender   
43. log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000   
44.   
45. # 发送日志给邮件   
46. log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender   
47. log4j.appender.MAIL.Threshold=FATAL   
48. log4j.appender.MAIL.BufferSize=10   
49. log4j.appender.MAIL.From=[e-mail]   
50. log4j.appender.MAIL.SMTPHost=www.wusetu.com   
51. log4j.appender.MAIL.Subject=Log4J Message   
52. log4j.appender.MAIL.To=[e-mail]   
53. log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout   
54. log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   
55.   
56.   
57. # 用于数据库   
58. log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender   
59. log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test   
60. log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver   
61. #这里是user不是username  
62. log4j.appender.DATABASE.user=root   
63. log4j.appender.DATABASE.password=   
64. #执行插入的语句，后面的控制输出字符都是有效的  
65. log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')   
66. log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout   
67. #这个格式可以不需要  
68. log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   
69.   
70.   
71. log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender   
72. log4j.appender.A1.File=SampleMessages.log4j   
73. log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'   
74. log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout   
75.   
76. #自定义Appender   
77. log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender   
78.   
79. log4j.appender.im.host = mail.cybercorlin.net   
80. log4j.appender.im.username = username   
81. log4j.appender.im.password = password   
82. log4j.appender.im.recipient = [e-mail]   
83.   
84. log4j.appender.im.layout=org.apache.log4j.PatternLayout   
85. log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n  

 

log4j.rootLogger=DEBUG 
#将DAO层log记录到DAOLog,allLog中 
log4j.logger.DAO=DEBUG,A2,A4 
#将逻辑层log记录到BusinessLog,allLog中 
log4j.logger.Businesslog=DEBUG,A3,A4 

#A1--打印到屏幕上 
log4j.appender.A1=org.apache.log4j.ConsoleAppender 
log4j.appender.A1.layout=org.apache.log4j.PatternLayout 
log4j.appender.A1.layout.ConversionPattern=%-5p [%t] %37c %3x - %m%n 

#A2--打印到文件DAOLog中--专门为DAO层服务 
log4j.appender.A2=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.A2.file=DAOLog 
log4j.appender.A2.DatePattern='.'yyyy-MM-dd 
log4j.appender.A2.layout=org.apache.log4j.PatternLayout 
log4j.appender.A2.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} 
method:%l%n%m%n 

#A3--打印到文件BusinessLog中--专门记录逻辑处理层服务log信息 
log4j.appender.A3=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.A3.file=BusinessLog 
log4j.appender.A3.DatePattern='.'yyyy-MM-dd 
log4j.appender.A3.layout=org.apache.log4j.PatternLayout 
log4j.appender.A3.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} 
method:%l%n%m%n 

#A4--打印到文件alllog中--记录所有log信息 
log4j.appender.A4=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.A4.file=alllog 
log4j.appender.A4.DatePattern='.'yyyy-MM-dd 
log4j.appender.A4.layout=org.apache.log4j.PatternLayout 
log4j.appender.A4.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} 
method:%l%n%m%n 

 

注意：每个log4j.properties必须有rootLogger(旧有版本是rootCategory)，其第一个参数是输出级别，之后的参数是不同的appender

在配置文件中可以通过这样使用来定义具体每个logger的输出级别:

logger就是你使用的输出对象，一般都是用类全名来命名

log4j.logger.org.hibernate=warn

如此，则工程中所有org.hibernate包路径下的类的日志信息都被置为warn以上级别 

第3章.     API使用

log4j使用步骤有3个：

 

3.1.   初始化

 

3.1.1.  Tomcat下的初始化

默认的Log4j initialization典型的应用是在web-server 环境下。在tomcat3.x和tomcat4.x下，你应该将配置文件Log4j.properties放在你的web应用程序的WEB-INF/classes 目录下。 
Log4j将发现属性文件，并且以此初始化。这是使它工作的最容易的方法。 
你也可以选择在运行tomcat前设置系统属性Log4j.configuration 。对于tomcat 3.x，TOMCAT_OPTS 系统变量是用来设置命令行的选项。对于tomcat4.0，用系统环境变量CATALINA_OPTS 代替了TOMCAT_OPTS。

UNIX 命令行 
export TOMCAT_OPTS="-DLog4j.configuration=foobar.txt" 
告诉Log4j用文件foobar.txt作为默认的配置文件。这个文件应该放在WEB-INF/classes 目录下。这个文件将被PropertyConfigurator所读。每个web-application将用不同的默认配置文件，因为每个文件是和它的web-application 相关的。 
1). export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml" export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml" 
告诉Log4j输出Log4j-internal的调试信息，并且用foobar.xml作为默认的配置文件。这个文件应该放在你的web-application的WEB-INF/classes 目录下。因为有.xml的扩展名，它将被DOMConfigurator所读。每个web-application将用不同的默认配置文件。因为每个文件都和它所在的web-application 相关的。 
2). set TOMCAT_OPTS=-DLog4j.configuration=foobar.lcf 
-DLog4j.configuratorClass=com.foo.BarConfigurator 
告诉Log4j用文件foobar.lcf作为默认的配置文件。这个文件应该放在你的web-application的WEB-INF/classes 目录下。因为定义了Log4j.configuratorClass 系统属性，文件将用自定义的com.foo.barconfigurator类来解析。每个web-application将用不同的默认配置文件。因为每个文件都和它所在的web-application 相关的。 
3). set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf 
告诉Log4j用文件foobar.lcf作为默认的配置文件。这个配置文件用URL file:/c:/foobar.lcf定义了全路径名。这样同样的配置文件将被所有的web-application所用。

 
不同的web-application将通过它们自己的类装载器来装载Log4j。这样，每个Log4j的环境将独立的运作，而没有任何的相互同步。例如：在多个web-application中定义了完全相同的输出源的FileAppenders将尝试写同样的文件。结果好象是缺乏安全性的。你必须确保每个不同的web-application的Log4j配置没有用到同样的系统资源。

 

3.1.2.  Servlet 的初始化

用一个特别的servlet来做Log4j的初始化也是可以的。如下是一个例子： 

[java] view plaincopy

1. public class Log4jInit extends HttpServlet {   
2. public void init() {   
3. String prefix = getServletContext().getRealPath("/");   
4. String file = getInitParameter("Log4j-init-file");   
5. if(file != null) {   
6. PropertyConfigurator.configure(prefix+file);   
7. }   
8. }   
9. public void doGet(HttpServletRequest req, HttpServletResponse res) {   
10. }   
11. }   

在web.xml中定义随后的servlet为你的web-application。 

[xhtml] view plaincopy

1. <servlet>   
2. <servlet-name>Log4j-init</servlet-name>   
3. <servlet-class>xx.xx.Log4jInit</servlet-class>   
4. <init-param>   
5. <param-name>Log4j-init-file</param-name>   
6. <param-value>WEB-INF/classes/Log4j.properties</param-value>   
7. </init-param>   
8. <load-on-startup>1</load-on-startup>   
9. </servlet>   

写一个初始化的servlet是最有弹性的初始化Log4j的方法。代码中没有任何限制，你可以在servlet的init方法中定义它。

 

3.2.   根据配置文件初始化log4j

log4j可以使用3中配置器来初始化：BasicConfigurator,DOMConfigurator,PropertyConfigurator 
其语法为： 
BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。 
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。 
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。 
这里用的是PropertyConfigurator。使用PropertyConfigurator适用于所有的系统。如下的语句： 
PropertyConfigurator.configure("log4j.properties"); 
就以log4j.properties为配置文件初始化好了log4j环境。 
注意一点：这个语句只需要在系统启动的时候执行一次。例如，在ActionServlet的init()方法中调用一次。

[java] view plaincopy

1. public class ActionServlet extends HttpServlet{   
2. ...   
3. /**  
4. * Initialize global variables  
5. */   
6. public void init() throws ServletException {   
7. // 初始化Action资源   
8. try{   
9. initLog4j();   
10. ...   
11. }catch(IOException e){   
12. throw new ServletException("Load ActionRes is Error");   
13. }   
14. }   
15. ...   
16. protected void initLog4j(){   
17. PropertyConfigurator.configure("log4j.properties");   
18. }   
19. ...   
20. }//end class ActionServlet   

 

 

3.3.   在需要使用log4j的地方获取Logger实例

使用Log4j，首先就是获取日志记录器，这个记录器将负责控制日志信息。其语法为： 
public static Logger getLogger( String name)， 
通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如： 
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ; 
     Log4j使得通过软件组件命名logger很容易。我们可以通过Logger的静态的初始化方法在每一个类里定义一个logger，令logger的名字等于类名的全局名，而实现logger的命名。这是一个实效的简单的定义一个logger的方法。因为日志输出带有产生日志的类的名字，这个命名策略使得我们更容易定位到一个日志信息的来源。虽然普通，但却是命名logger的常用策略之一。 
Log4j没有限制定义logger的可能。开发员可以自由的按照它们的意愿定义logger的名称。 
然而，以类的所在位置来命名Logger好象是目前已知的最好方法。

 

3.4.   使用Logger对象的debug,info,fatal...方法
log.debug("it is the debug info");

第4章.     优化

一个经常引用的依靠于logging的参数是可以计算的花费。这是一个合理的概念，一个适度的应用程序可能产生成千上万个日志请求。许多努力花在测量和调试logging的优化上。Log4j要求快速和弹性：速度最重要，弹性是其次。

 

4.1.   日志为禁用时，日志的优化。

当日志被彻底的关闭，一个日志请求的花费等于一个方法的调用加上整数的比较时间。在233mhz的Pentium II 机器上这个花费通常在5-50纳秒之间。 
然而，方法调用包括参数构建的隐藏花费。 
例如，对于logger cat，logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i])); 
引起了构建信息参数的花费，例如，转化整数i和entry[i]到一个string，并且连接中间字符串，不管信息是否被输出。这个参数的构建花费可能是很高，它主要决定于被调用的参数的大小。 
避免参数构建的花费应如下，

if(logger.isDebugEnabled()) 
{ 
        logger.debug("result is" + result ); 
}

如果logger的debug被关闭这将不会招致参数构建的花费。另一方面，如果logger是debug的话，它将产生两次判断 logger是否能用的花费。一次是在debugenabled，一次是debug。这是无关紧要的，因为判断日志的能用 只占日志实际花费时间的约1%。 
在Log4j里，日志请求在Logger 类的实例里。Logger 是一个类，而不是一个接口。这大量的减少了在方法调用上的弹性化的花费。 
当然用户采用预处理或编译时间技术去编译出所有的日志声明。这将导致完美的执行成效。然而因为二进制应用程序不包括任何的日志声明的结果，日志不可能对那个二进制程序开启。以我的观点，以这种较大的代价来换取较小的性能优化是不值得的。

4.2.   当日志状态为启用时，日志的优化。

这是本质上的优化logger的层次。当日志状态为开，Log4j依然需要比较请求的级别与logger的级别。然而， logger可能没有被安排一个级别；它们将从它们的father继承。这样，在继承之前，logger可能需要搜索它的ancestor。 
这里有一个认真的努力使层次的搜索尽可能的快。例如，子logger仅仅连接到它的存在的father logger。 
在先前展示的BasicConfigurator 例子中，名为com.foo.bar 的logger是连接到跟根logger，因此绕过 了不存在的logger com和com.foo。这将显著的改善执行的速度，特别是解析logger的层结构时。 
典型的层次结构的解析的花费是logger彻底关闭时的三倍。

4.3.   日志信息的输出时，日志的优化。

这是主要花费在日志输出的格式化和发送它到它的输出源上。这里我们再一次的付出努力以使格式化执行的尽可能快。同appender一样。实际上典型的花费大约是100-300毫秒。 
详情看org.apache.log4.performance.Logging。 
虽然Log4j有许多特点，但是它的第一个设计目标还是速度。一些Log4j的组件已经被重写过很多次以改善性能。不过，投稿者经常提出了新的优化。你应该满意的知道，以SimpleLayout的配置执行测试已经展示了Log4j的输出同System.out.println一样快。