2011年5月22日星期日

  Log4j详解

概述:

Log4j有三个主要的组件:记录器(Loggers)、输出源( Appenders)和布局(Layouts)。

下面是apach Log4J的类图

3889d0d4-9d5a-3af3-8b20-926b0a043666

 

Logger:

Log4j 允许开发人员定义多个Logger,每个Logger拥有自己的名字,Logger之间通过名字来表明隶属关系。

(1). Logger的命名规则
Logger由一个String类的名字识别,logger的名字是大小写敏感的,且名字之间具有继承的关系,子名有父名作为前缀,用点号.分隔。如:x.y是x.y.z的父亲。
根logger (Root logger)是所有logger的祖先,它具有如下属性:1) 它总是存在的;2) 它不可以通过名字获得。
通过调用public static Logger Logger.getRootLogger()获得Root logger;通过调用public static Logger Logger.getLogger(String name)或者public static Logger Logger.getLogger(Class clazz)获得(或者创建)一个named logger。后者相当于调用Logger.getLogger(clazz.getName())。
在某对象中,用该对象所属的类为参数,调用Logger.getLogger(Class clazz)获得logger是目前所知的最理智的命名logger的方法。

(2). Log level
每个logger都被分配了一个日志级别 (log level),用来控制日志信息的输出。未被分配level的logger将继承它最近的父logger的level。
每条输出到logger的日志请求(logging request)也都有一个level,如果该request的level大于等于该logger的level,则该request将被处理(称为enabled);否则该request将被忽略。(只有级别高过配置中规定的级别的信息才能真正的输出),故可得知:
logger的level越低,表示该logger越详细;
logging request的level越高,表示该logging request越优先输出。
Loggers日志记录的优先级【priority】由低到高为: Level.ALL < Level.DEBUG < Level.INFO < Level.WARN < Level.ERROR < Level.FATAL < Level.OFF 
Log4j建议只使用OFF 、FATAL、ERROR、WARN、INFO、DEBUG 、ALL这五个级别。

appender:

(1). 输出方式【appender】----日志目的地,把格式化好的日志信息输出到指定的地方去。一般有5种:

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

 

(2). 布局【layout】----日志格式化器。其中,Log4j提供的layout有以下几种:

org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,说明中的参数都以%开始,后面不同的参数代表不同的格式化信息(参数按字母表顺序列出):
%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        输出产生该日志事件的线程名

 

一个log4j配置(XML)实例:

   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/">
   4:  
   5:     <!-- ========================== 自定义输出格式说明================================ -->
   6:     <!-- %p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL -->
   7:     <!-- #%r 输出自应用启动到输出该log信息耗费的毫秒数 -->
   8:     <!-- #%c 输出所属的类目,通常就是所在类的全名 -->
   9:     <!-- #%t 输出产生该日志事件的线程名 -->
  10:     <!-- #%n 输出一个回车换行符,Windows平台为“\r\n”,Unix平台为“\n” -->
  11:     <!-- #%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 
  12:         22:10:28,921 -->
  13:     <!-- #%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java:10) -->
  14:     <!-- ========================================================================== -->
  15:  
  16:     <!-- ========================== 输出方式说明================================ -->
  17:     <!-- Log4j提供的appender有以下几种: -->
  18:     <!-- org.apache.log4j.ConsoleAppender(控制台), -->
  19:     <!-- org.apache.log4j.FileAppender(文件), -->
  20:     <!-- org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件), -->
  21:     <!-- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件), -->
  22:     <!-- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) -->
  23:     <!-- ========================================================================== -->
  24:     <!-- 输出到日志文件 -->
  25:     <appender name="filelog_appender" class="org.apache.log4j.RollingFileAppender">
  26:         <!-- 设置File参数:日志输出文件名 -->
  27:         <param name="File" value="log/testlog4jxml_all.log" />
  28:         <!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 -->
  29:         <param name="Append" value="true" />
  30:         <!-- 设置文件大小 -->
  31:         <param name="MaxFileSize" value="1MB" />
  32:         <!-- 设置文件备份 -->
  33:         <param name="MaxBackupIndex" value="10000" />
  34:         <!-- 设置输出文件项目和格式 -->
  35:         <layout class="org.apache.log4j.PatternLayout">
  36:             <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p (%c:%L)- %m%n" />
  37:         </layout>
  38:     </appender>
  39:  
  40:     <!-- 输出到日志文件 每天一个日志 -->
  41:     <appender name="filelog_daily" class="org.apache.log4j.DailyRollingFileAppender">
  42:         <param name="File" value="log/daily.log" />
  43:         <param name="DatePattern" value="'daily.'yyyy-MM-dd'.log'" />
  44:         <layout class="org.apache.log4j.PatternLayout">
  45:             <param name="ConversionPattern"
  46:                 value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] (%c:%L) - %m%n" />
  47:         </layout>
  48:     </appender>
  49:  
  50:     <!-- 输出到控制台中 -->
  51:     <appender name="console" class="org.apache.log4j.ConsoleAppender">
  52:         <layout class="org.apache.log4j.PatternLayout">
  53:             <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p: %m%n" />
  54:             <!-- "%-5p: [%t] [%c{3}.%M(%L)] | %m%n" -->
  55:         </layout>
  56:     </appender>
  57:  
  58:     <appender name="EMAIL_QQ" class="org.apache.log4j.net.SMTPAppender">
  59:         <param name="Threshold" value="INFO" />
  60:         <param name="BufferSize" value="128" />
  61:         <param name="SMTPHost" value="smtp.qq.com" />
  62:         <param name="SMTPUsername" value="cjjvictory" />
  63:         <param name="SMTPPassword" value="***" />
  64:         <param name="From" value="cjjvictory@qq.com" />
  65:         <param name="To" value="cjjvictory@gmail.com" />
  66:         <param name="Subject" value="测试邮件发送" />
  67:         <param name="LocationInfo" value="true" />
  68:         <param name="SMTPDebug" value="true" />
  69:         <layout class="org.cjj.log4j.extend.PatternLayout_zh">
  70:             <param name="ConversionPattern" value="[%d{ISO8601}] %-5p %c %m%n" />
  71:         </layout>
  72:     </appender>
  73:  
  74:     <!--- 异步测试,当日志达到缓存区大小时候执行所包的appender -->
  75:     <appender name="ASYNC_test" class="org.apache.log4j.AsyncAppender">
  76:         <param name="BufferSize" value="10" />
  77:         <appender-ref ref="EMAIL_QQ" />
  78:     </appender>
  79:  
  80:     <!-- 设置包限制输出的通道 -->
  81:     <category name="org.cjj" additivity="false">
  82:         <!-- 日志输出级别,起码可以有5个级别,可以扩展自己的级别,邮件发送必须是ERROR级别不好用,所以最后自己扩展一个邮件发送级别 -->
  83:         <level value="ERROR" />
  84:         <appender-ref ref="filelog_daily" />
  85:         <appender-ref ref="daily_appender" />
  86:         <appender-ref ref="console" />
  87:         <appender-ref ref="ASYNC_test" />
  88:     </category>
  89:  
  90: </log4j:configuration>  

没有评论:

发表评论