LOG4J基本使用及配置介绍.doc

LOG4J简介
 在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。
     Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接 口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就 是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
常用log4j配置，一般可以采用两种方式，.properties和.xml,下面举两个简单的例子：
一、log4j.xml
<?xml version="1.0" encoding="UTF-8"?>    
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">    

<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' >    

    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">    
        <layout class="org.apache.log4j.PatternLayout">    
            <param name="ConversionPattern"       
                value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n" />    
        </layout>    
        <!--过滤器设置输出的级别-->    
        <filter class="org.apache.log4j.varia.LevelRangeFilter">    
            <param name="levelMin" value="debug" />    
            <param name="levelMax" value="warn" />    
            <param name="AcceptOnMatch" value="true" />    
        </filter>    
    </appender>    

    <appender name="myFile" class="org.apache.log4j.RollingFileAppender">       
        <param name="File" value="D:/output.log" /><!-- 设置日志输出文件名 -->    
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->    
        <param name="Append" value="true" />    
        <param name="MaxBackupIndex" value="10" />    
        <layout class="org.apache.log4j.PatternLayout">    
            <param name="ConversionPattern" value="%p (%c:%L)- %m%n" />    
        </layout>    
    </appender>    

    <appender name="activexAppender" class="org.apache.log4j.DailyRollingFileAppender">    
        <param name="File" value="E:/activex.log" />      
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />      
        <layout class="org.apache.log4j.PatternLayout">    
         <param name="ConversionPattern"      
            value="[%d{MMdd HH:mm:ss SSS\} %-5p] [%t] %c{3\} - %m%n" />    
        </layout>      
    </appender>    

    <!-- 指定logger的设置，additivity指示是否遵循缺省的继承机制-->    
    <logger name="com.runway.bssp.activeXdemo" additivity="false">    
        <priority value ="info"/>      
        <appender-ref ref="activexAppender" />      
    </logger>    

    <!-- 根logger的设置-->    
    <root>    
        <priority value ="debug"/>    
        <appender-ref ref="myConsole"/>    
        <appender-ref ref="myFile"/>       
    </root>    
</log4j:configuration>

(1). 输出方式appender一般有5种：

             org.apache.log4j.RollingFileAppender(滚动文件，自动记录最新日志)
             org.apache.log4j.ConsoleAppender (控制台) 
             org.apache.log4j.FileAppender (文件)
             org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
             org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)

(2). 日记记录的优先级priority，优先级由高到低分为
            OFF ,FATAL ,ERROR ,WARN ,INFO ,DEBUG ,ALL。
            Log4j建议只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG这五个级别。

(3). 格式说明layout中的参数都以%开始，后面不同的参数代表不同的格式化信息（参数按字母表顺序列出）：
                %c        输出所属类的全名，可在修改为 %d{Num} ,Num类名输出的维（如："org.apache.elathen.ClassName",%C{2}将输出elathen.ClassName）
                %d       输出日志时间其格式为 %d{yyyy-MM-dd HH:mm:ss,SSS}，可指定格式 如 %d{HH:mm:ss}
                %l        输出日志事件发生位置，包括类目名、发生线程，在代码中的行数
                %n       换行符
                %m      输出代码指定信息，如info(“message”),输出message
                %p       输出优先级，即 FATAL ,ERROR 等
                %r        输出从启动到显示该log信息所耗费的毫秒数
                %t        输出产生该日志事件的线程名

xml declaration and DTD
xml配置文件的头部包括两个部分：xml声明和DTD声明。头部的格式如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

log4j:configuration (root element)

· xmlns:log4j [#FIXED attribute] : 定义log4j的名字空间，取定值"http://jakarta.apache.org/log4j/"
· appender [* child] : 一个appender子元素定义一个日志输出目的地
· logger [* child] : 一个logger子元素定义一个日志写出器
· root [? child] : root子元素定义了root logger

appender
appender元素定义一个日志输出目的地。

· name [#REQUIRED attribute] : 定义appender的名字，以便被后文引用
· class [#REQUIRED attribute] : 定义appender对象所属的类的全名
· param [* child] : 创建appender对象时传递给类构造方法的参数
· layout [? child] : 该appender使用的layout对象

layout
layout元素定义与某一个appender相联系的日志格式化器。

· class [#REQUIRED attribute] : 定义layout对象所属的类的全名
· param [* child] : 创建layout对象时传递给类构造方法的参数

logger
logger元素定义一个日志输出器。

· name [#REQUIRED attribute] : 定义logger的名字，以便被后文引用
· additivity [#ENUM attribute] : 取值为"true"（默认）或者"false"，是否继承父logger的属性
· level [? child] : 定义该logger的日志级别
· appender-ref [* child] : 定义该logger的输出目的地

root
root元素定义根日志输出器root logger。

· param [* child] : 创建root logger对象时传递给类构造方法的参数
· level [? child] : 定义root logger的日志级别
· appender-ref [* child] : 定义root logger的输出目的地

level
level元素定义logger对象的日志级别。

· class [#IMPLIED attribute] : 定义level对象所属的类，默认情况下是"org.apache.log4j.Level类
· value [#REQUIRED attribute] : 为level对象赋值。可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。当值为"off"时表示没有任何日志信息被输出
· param [* child] : 创建level对象时传递给类构造方法的参数

appender-ref
appender-ref元素引用一个appender元素的名字，为logger对象增加一个appender。

· ref [#REQUIRED attribute] : 一个appender元素的名字的引用
· appender-ref元素没有子元素

param
param元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。

· name and value [#REQUIRED attributes] : 提供参数的一组名值对
· param元素没有子元素
在xml文件中配置appender和layout
创建不同的Appender对象或者不同的Layout对象要调用不同的构造方法。可以使用param子元素来设定不同的参数值。
创建ConsoleAppender对象
ConsoleAppender的构造方法不接受其它的参数。

... ... ... ...
<appender name="console.log" class="org.apache.log4j.ConsoleAppender">
<layout ... >
... ...
</layout>
</appender>
... ... ... ...

创建FileAppender对象
可以为FileAppender类的构造方法传递两个参数：File表示日志文件名；Append表示如文件已存在，是否把日志追加到文件尾部，可能取值为"true"和"false"（默认）。

... ... ... ...
<appender name="file.log" class="org.apache.log4j.FileAppender">
<param name="File" value="/tmp/log.txt" />
<param name="Append" value="false" />
<layout ... >
... ...
</layout>
</appender>
... ... ... ...

创建RollingFileAppender对象
除了File和Append以外，还可以为RollingFileAppender类的构造方法传递两个参数：MaxBackupIndex备份日志文件的个数（默认是1个）；MaxFileSize表示日志文件允许的最大字节数（默认是10M）。

... ... ... ...
<appender name="rollingFile.log" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="/tmp/rollingLog.txt" />
<param name="Append" value="false" />
<param name="MaxBackupIndex" value="2" />
<param name="MaxFileSize" value="1024" />
<layout ... >
... ...
</layout>
</appender>
... ... ... ...

创建PatternLayout对象
可以为PatternLayout类的构造方法传递参数ConversionPattern。

... ... ... ...
<layout class="org.apache.log4j.PatternLayout>
<param name="Conversion" value="%d [%t] %p - %m%n" />
</layout>

xml文件

编号 配置项 配置项描述 示例
1 threshold 阈值项
2 root 根日志属性项

3 priority 级别项（旧）
4 level 级别项（新）
5 category 子日志属性项（旧）
6 logger 子日志属性项（新）
7 appender-ref 输出端控制项
8 additivity appender是否继承设置
9 appender 输出目的地定义项
10 layout 输出格式定义项

详细说明（只针对Log4j常用的，用户可以自定义）Appender
Appender继承关系
Appender基本种类
org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
· ConsoleAppender选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台
· FileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
· DailyRollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
DatePattern='.'yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、
天、时和分。即对应的格式如下：
1)'.'yyyy-MM: 每月
2)'.'yyyy-ww: 每周
3)'.'yyyy-MM-dd: 每天
4)'.'yyyy-MM-dd-a: 每天两次
5)'.'yyyy-MM-dd-HH: 每小时
6)'.'yyyy-MM-dd-HH-mm: 每分钟
n RollingFileAppender 选项
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来
的内容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

详细说明（只针对Log4j，用户可以自定义）Layout
Log4j的Layout基本种类
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
· HTMLLayout选项
LocationInfo=true:默认值是false,输出java文件名称和行号
Title=my app file: 默认值是 Log4J Log Messages.      
n PatternLayout 选项
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
这里需要说明的就是日志信息格式中几个符号所代表的含义：

%X: 信息输出时左对齐；
%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目，通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%: 输出一个"%"字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"输出日志信息换行，可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符， 就从左边交远销出的字符截掉。
· XMLLayout 选项
LocationInfo=true:默认值是false,输出java文件和行号

日志配置文件内容范例  
log4j.properties
view plaincopy to clipboardprint?
1. log4j.rootLogger=DEBUG, CONSOLE    
2. #DEBUG, CONSOLE,FILE,ROLLING_FILE,MAIL,DATABASE    
3. #log4j.threshold=WARN
4.
5. log4j.logger.org.apache=INFO, FILE 
6. log4j.additivity.org.apache=false    
7.   
8. ###################    
9. # Console Appender    
10. ###################    
11. log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender    
12. log4j.appender.Threshold=DEBUG    
13. log4j.appender.CONSOLE.Target=System.out    
14. log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout    
15. log4j.appender.CONSOLE.layout.ConversionPattern=%d [%p] - %m%n    
16.   
17.   
18. #####################    
19. # File Appender    
20. #####################    
21. log4j.appender.FILE=org.apache.log4j.FileAppender    
22. log4j.appender.FILE.File=file.log    
23. log4j.appender.FILE.Append=false    
24. log4j.appender.FILE.layout=org.apache.log4j.PatternLayout    
25. log4j.appender.FILE.layout.ConversionPattern=%d [%p] - %m%n    
26.   
27.   
28. ########################    
29. # Rolling File    
30. ########################    
31. log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender    
32. log4j.appender.ROLLING_FILE.Threshold=ERROR    
33. log4j.appender.ROLLING_FILE.File=rolling.log    
34. log4j.appender.ROLLING_FILE.Append=true    
35. log4j.appender.ROLLING_FILE.MaxFileSize=10KB    
36. log4j.appender.ROLLING_FILE.MaxBackupIndex=1    
37. log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout    
38. log4j.appender.ROLLING_FILE.layout.ConversionPattern=%d [%p] - %m%n    
39.   
40.   
41. ####################    
42. # Socket Appender    
43. ####################    
44. log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender    
45. log4j.appender.SOCKET.RemoteHost=localhost    
46. log4j.appender.SOCKET.Port=5001    
47. log4j.appender.SOCKET.LocationInfo=true    
48. # Set up for Log Facter 5    
49. log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout    
50. log4j.appender.SOCET.layout.ConversionPattern=%d [%p] - %m%n    
51.   
52.   
53. ########################    
54. # Log Factor 5 Appender    
55. ########################    
56. log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender    
57. log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000    
58.   
59.   
60. ########################    
61. # SMTP Appender    
62. #######################    
63. log4j.appender.MAIL=.SMTPAppender    
64. log4j.appender.MAIL.Threshold=FATAL    
65. log4j.appender.MAIL.BufferSize=10    
66. log4j.appender.MAIL.From=wuyh@    
67. log4j.appender.MAIL.SMTPHost=    
68. log4j.appender.MAIL.Subject=Log4J Message    
69. log4j.appender.MAIL.To=test@    
70. log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout    
71. log4j.appender.MAIL.layout.ConversionPattern=%d [%p] - %m%n    
72.   
73.   
74. ########################    
75. # JDBC Appender    
76. #######################    
77. log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender    
78. log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test    
79. log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver    
80. log4j.appender.DATABASE.user=root    
81. log4j.appender.DATABASE.password=    
82. log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES (%d [%p] - %m%n)    
83. log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout    
84. log4j.appender.DATABASE.layout.ConversionPattern=%d [%p] - %m%n    
85.   
86.   
87. log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender    
88. log4j.appender.A1.File=SampleMessages.log4j    
89. log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'    
90. log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout    
91.   
92. ###################    
93. #自定义Appender    
94. ###################    
95. log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender    
96.   
97. log4j.appender.im.host =     
98. log4j.appender.im.username = username    
99. log4j.appender.im.password = password    
100. log4j.appender.im.recipient = wuyh@    
101.   
102. log4j.appender.im.layout=org.apache.log4j.PatternLayout    
103. log4j.appender.im.layout.ConversionPattern =%d [%p] - %m%n   

#注意：在属性配置文件中，属性值的第一个一定是级别，输出端可有可无，以逗号分割。（而xml文件格式没有这种限制）

log4j.xml
view plaincopy to clipboardprint?
1. < xml version="1.0" encoding="UTF-8" >    
2. <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">    
3. <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false" threshold="null">    
4.   
5.   
6. <appender class="org.apache.log4j.ConsoleAppender" name="CONSOLE">    
7. <param name="Target" value="System.out"/>    
8. <param name="Th