• log4j 悟寰轩


    Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。

    log4j--log for java (java的日志)

       在强调可重用组件开发的今天,除了自己从头到尾开发一个可重用的日志操作类外,Apache为我们提供了一个强有力的日志操作包-Log4j。
       此外,通过Log4j其他语言接口,您可以在C、C++、.Net、PL/SQL程序中使用Log4j,其语法和用法与在Java程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块。而且,通过使用各种第三方扩展,您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。
       说明:下面分为三部分,
       第一部分讲解如何配置log4j;
       第二部分为对log4j.properties配置文件中的各个属性的讲解;
       第三部分为对log4j的详细讲解。
       如果只想配置上log4j,那么只需要看前两个部分就可以,如果想对log4j深入了解,则还需看第三部分。
       使用的license: Apache License V2.0
     1 Log4j配置
     2 
     3 第一步
     4 
     5  加入log4j-1.2.8.jar到lib下。
     6 
     7   
     8 
     9 第二步
    10 
    11  在CLASSPATH下建立log4j.properties。内容如下:
    12 
    13   1 log4j.rootCategory=INFO, stdout , R
    14 
    15   2 
    16 
    17   3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    18 
    19   4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    20 
    21   5 log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n
    22 
    23   6 
    24 
    25   7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
    26 
    27   8 log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log
    28 
    29   9 log4j.appender.R.layout=org.apache.log4j.PatternLayout
    30 
    31   10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n
    32 
    33   11 
    34 
    35   12 log4j.logger.com.neusoft=DEBUG
    36 
    37   13 log4j.logger.com.opensymphony.oscache=ERROR
    38 
    39   14 log4j.logger.net.sf.navigator=ERROR
    40 
    41   15 log4j.logger.org.apache.commons=ERROR
    42 
    43   16 log4j.logger.org.apache.struts=WARN
    44 
    45   17 log4j.logger.org.displaytag=ERROR
    46 
    47   18 log4j.logger.org.springframework=DEBUG
    48 
    49   19 log4j.logger.com.ibatis.db=WARN
    50 
    51   20 log4j.logger.org.apache.velocity=FATAL
    52 
    53   21 
    54 
    55   22 log4j.logger.com.canoo.webtest=WARN
    56 
    57   23 
    58 
    59   24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
    60 
    61   25 log4j.logger.org.hibernate=DEBUG
    62 
    63   26 log4j.logger.org.logicalcobwebs=WARN
    64 
    65   
    66 
    67 第三步
    68 
    69  相应的修改其中属性,修改之前就必须知道这些都是干什么的,在第二部分讲解。
    70 
    71   
    72 
    73 第四步
    74 
    75  在要输出日志的类中加入相关语句:
    76 
    77   定义属性:static Logger logger = Logger.getLogger(LogDemo.class); //LogDemo为相关的类
    78 
    79   在相应的方法中:
    80 
    81   if (logger.isDebugEnabled()){
    82 
    83   logger.debug(“System …..”);
    84 
    85   }
    86 
    87   
      1 定义配置文件
      2   Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法:
      3   ①、配置根Logger
      4   Logger 负责处理日志记录的大部分操作。
      5   其语法为:
      6   log4j.rootLogger = [ level ] , appenderName, appenderName,  7   其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志,OFF:关闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
      8   ②、配置日志信息输出目的地 Appender
      9   Appender 负责控制日志记录操作的输出。
     10   其语法为:
     11   log4j.appender.appenderName = fully.qualified.name.of.appender.class
     12   log4j.appender.appenderName.option1 = value1
     13   …
     14   log4j.appender.appenderName.optionN = valueN
     15   这里的appenderName为在①里定义的,可任意起名。
     16   其中,Log4j提供的appender有以下几种:
     17   org.apache.log4j.ConsoleAppender(控制台),
     18   org.apache.log4j.FileAppender(文件),
     19   org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
     20   org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),可通过log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
     21   org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
     22   例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender
     23   定义一个名为stdout的输出目的地,ConsoleAppender为控制台。
     24   ③、配置日志信息的格式(布局)Layout
     25   Layout 负责格式化Appender的输出。
     26   其语法为:
     27   log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
     28   log4j.appender.appenderName.layout.option1 = value1
     29   …
     30   log4j.appender.appenderName.layout.optionN = valueN
     31   其中,Log4j提供的layout有以下几种:
     32   org.apache.log4j.HTMLLayout(以HTML表格形式布局),
     33   org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
     34   org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
     35   org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
     36 格式化日志信息
     37   Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下:
     38   %m 输出代码中指定的消息
     39   %p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
     40   %r 输出自应用启动到输出该log信息耗费的毫秒数
     41   %c 输出所属的类目,通常就是所在类的全名
     42   %t 输出产生该日志事件的线程名
     43   %n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n”
     44   %d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921
     45   %l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。
     46 在代码中使用Log4j
     47   我们在需要输出日志信息的类中做如下的三个工作:
     48   1、导入所有需的commongs-logging类:
     49   import org.apache.commons.logging.Log;
     50   import org.apache.commons.logging.LogFactory;
     51   2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员:
     52   private final Log log = LogFactory.getLog(getClass());
     53   LogFactory.getLog()方法的参数使用的是当前类的class。
     54   3、使用org.apache.commons.logging.Log类的成员方法输出日志信息:
     55   if (log.isDebugEnabled()){
     56   log.debug("111");
     57   }
     58   if (log.isInfoEnabled()){
     59   log.info("222");
     60   }
     61   if (log.isWarnEnabled()){
     62   log.warn("333");
     63   }
     64   if (log.isErrorEnabled()){
     65   log.error("444");
     66   }
     67   if (log.isFatalEnabled()){
     68   log.fatal("555")
     69   }
     70   2.3 如何应用记录器的层次
     71   2.3.1 如何定义及获取不同层次的记录器
     72   任何一个记录器的使用都有两个步骤:
     73   1) 在配置文件中定义相应的记录器。
     74   在配置文件中定义记录器的格式有两种
     75   ? 定义根记录器的格式为
     76   log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN
     77   ? 定义一个非根记录器的格式为
     78   log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN
     79   ……
     80   log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN
     81   我们可以定义任意个非根记录器。
     82   2) 在代码中调用Logger类的取得记录器方法取得相应的记录器对象。
     83   要取得根记录器对象可通过Logger.getRootLogger()函数,要取得非根记录器可通过Logger.getLogger()函数。
     84   理论知道就讲到这里,纸上得来终觉浅,下面,我们来小小演练一下。
     85   例4-a:
     86   package TestLog4j;
     87   import org.apache.log4j.Logger;
     88   import org.apache.log4j.PropertyConfigurator;
     89   import org.apache.log4j.Priority;
     90   import TestLog4j.TestLog4j2.TestLog4j2;
     91   public class TestLog4j
     92   {
     93   static Logger logger = Logger.getLogger(TestLog4j.class.getName()); //(2)
     94   public TestLog4j(){}
     95   public static void main(String[] args)
     96   {
     97   //同时输出到控制台和一个文件的实例并实现了Logger的继承
     98   PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");
     99   logger.debug("Start of the main() in TestLog4j");
    100   logger.info("Just testing a log message with priority set to INFO");
    101   logger.warn("Just testing a log message with priority set to WARN");
    102   logger.error("Just testing a log message with priority set to ERROR");
    103   logger.fatal("Just testing a log message with priority set to FATAL");
    104   logger.log(Priority.WARN, "Testing a log message use a alternate form");
    105   logger.debug(TestLog4j.class.getName());
    106   TestLog4j2 testLog4j2 = new TestLog4j2(); //(1)
    107   testLog4j2.testLog();
    108   }
    109   }
    110   在类TestLog4j中我们调用了另一个类TestLog4j2,下面看一下类TestLog4j2的代码。
    111   例4-b:
    112   package TestLog4j.TestLog4j2;
    113   import org.apache.log4j.Logger;
    114   import org.apache.log4j.PropertyConfigurator;
    115   import org.apache.log4j.Priority;
    116   public class TestLog4j2
    117   {
    118   static Logger logger = Logger.getLogger(TestLog4j2.class.getName()); //(1)
    119   public TestLog4j2(){}
    120   public void testLog()
    121   {
    122   //同时输出到控制台和一个文件的实例
    123   PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");
    124   logger.debug("2Start of the main()");
    125   logger.info("2Just testing a log message with priority set to INFO");
    126   logger.warn("2Just testing a log message with priority set to WARN");
    127   logger.error("2Just testing a log message with priority set to ERROR");
    128   logger.fatal("2Just testing a log message with priority set to FATAL");
    129   logger.log(Priority.DEBUG, "Testing a log message use a alternate form");
    130   logger.debug("2End of the main()");
    131   }
    132   }
    133   最后我们来看一下配置文件。
    134   例4-c:
    135   log4j2.properties文件内容
    136   #1区
    137   #### Use two appenders, one to log to console, another to log to a file
    138   log4j.rootLogger = debug, stdout
    139   #2区
    140   #Print only messages of priority WARN or higher for your category
    141   log4j.logger.TestLog4j= , R
    142   log4j.logger.TestLog4j.TestLog4j2=WARN
    143   #3区
    144   #### First appender writes to console
    145   log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    146   log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    147   # Pattern to output the caller's file name and line number.
    148   log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n
    149   #4区
    150   #### Second appender writes to a file
    151   log4j.appender.R=org.apache.log4j.RollingFileAppender
    152   log4j.appender.R.File=F:\\nepalon\\classes\\TestLog4j\\example.log
    153   # Control the maximum log file size
    154   log4j.appender.R.MaxFileSize=100KB
    155   # Archive log files (one backup file here)
    156   log4j.appender.R.MaxBackupIndex=1
    157   log4j.appender.R.layout=org.apache.log4j.PatternLayout
    158   log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n
    159   先看一下运行结果。
    160   在控制台中的结果为:
    161   DEBUG [main] (?:?) - Start of the main() in TestLog4j
    162   INFO [main] (?:?) - Just testing a log message with priority set to INFO
    163   WARN [main] (?:?) - Just testing a log message with priority set to WARN
    164   ERROR [main] (?:?) - Just testing a log message with priority set to ERROR
    165   FATAL [main] (?:?) - Just testing a log message with priority set to FATAL
    166   WARN [main] (?:?) - Testing a log message use a alternate form
    167   DEBUG [main] (?:?) - TestLog4j.TestLog4j
    168   WARN [main] (?:?) - 2Just testing a log message with priority set to WARN
    169   ERROR [main] (?:?) - 2Just testing a log message with priority set to ERROR
    170   FATAL [main] (?:?) - 2Just testing a log message with priority set to FATAL
    171   输出文件的结果为:
    172   2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - Start of the main() in TestLog4j
    173   2003-12-19 04:19:44:INFO main TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
    174   2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
    175   2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
    176   2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
    177   2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Testing a log message use a alternate form
    178   2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - TestLog4j.TestLog4j
    179   2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to WARN
    180   2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to ERROR
    181   2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to FATAL
    182   首先,先来看一下配置文件都有些什么东西。
    183   1) 在1区中定义了一个根记录器。这个根记录器具有DEBUG级别并有一个名称为stdout的输出端appender。
    184   2) 2区中的内容是这一节的重点,也是应用到记录器层次的地方,但其实也只有两句,充分体现了log4j的简单性。在这里,我们定义了两个名称分别为TestLog4j和TestLog4j.TestLog4j2设计器。
    185   ? 在定义TestLog4j记录器时没有指定级别,所以它的级别继承自它的父记录器,即根记录器,所以它的级别也为DEBUG。在定义TestLog4j记录器时又定义了一个名称为R的输出端,所以它的输出端有两个,一个从根记录器继承而来的名为stdout的输出端,另一个为在此定义的名为R的输出端。在此需要注意的是,在定义记录器时必须先定义记录器的级别,然后才是记录器的输出端。如果只想定义输出端而不定义级别,则虽然级别可以为空,但逗号分隔符不能省略。如定义TestLog4j记录器的做法。
    186   ? 在定义TestLog4j.TestLog4j2记录器时又指定了它的级别,由于一个记录器的级别只能有一个,所以新指定的级别将覆写掉它的父记录器的级别(这就象Java中的多态)。我们没有定义TestLog4j.TestLog4j2记录器的输出端,所以它的输出端将从它的父记录器中继承而来。它的父记录器为estLog4j记录器,所以它和estLog4j记录器一样具有两个名称分别为 stdout和R的输出端。
    187   3) 剩下的3区和4区分别设置了两个输出端的参数值。
    188   接下来,回到我们的代码,看一下是如何取得记录器,在取记录器时又发生了什么。
    189   1) 例4-a中的代码(2)中,语句Logger.getLogger()中的参数TestLog4j.class.getName()的值为 TestLog4j. TestLog4j,所以此语句的结果是取得一个名为TestLog4j. TestLog4j的记录器的对象。但在配置文件中并没有定义这样的记录器,所以最终将返回与所需的名称TestLog4j. TestLog4j最接近的记录器对象,即名为TestLog4j的记录器的对象。
    190   2) 例4-b中的代码(1)的原理与例4-a中的代码(2)相似,期望取得的是名为TestLog4j.TestLog4j2. TestLog4j2的记录器对象,但最终返回的是TestLog4j.TestLog4j2记录器的对象。
     1 到目前为止,这篇文章讲的都是如何在application中应用log4j,而Java现在的应用主流是J2EE和J2ME。现在,我们来看一下要如何在 J2EE开发中应用log4j。其实在Web application中应用log4j也很简单,与在application中应用log4j不同之处就是要在所有应用log4j的代码之前对log4j进行初始化。所以,我们在web application中就要把log4j的初始化工作独立出来,把它放在Servlet中。下面,我们看一个例子。
     2   例5-a:
     3   进行初始化的Servlet:
     4   import org.apache.log4j.PropertyConfigurator;
     5   import javax.servlet.http.HttpServlet;
     6   import javax.servlet.http.HttpServletRequest;
     7   import javax.servlet.http.HttpServletResponse;
     8   /**
     9   * log4j.jar的初始化类,参考web.xml
    10   */
    11   public class Log4jInit extends HttpServlet
    12   {
    13   public void init()
    14   {
    15   //通过web.xml来动态取得配置文件
    16   String prefix = getServletContext().getRealPath("/");
    17   String file = getInitParameter("log4j-init-file");
    18   // 如果没有给出相应的配置文件,则不进行初始化
    19   if(file != null)
    20   {
    21   PropertyConfigurator.configure(prefix+file); //(1)
    22   }
    23   }
    24   public void doGet(HttpServletRequest req, HttpServletResponse res)
    25   {}
    26   }
    27   下面来看一下这个Servlet在web.xml中的定义。
    28   例5-b:
    29   <servlet>
    30   <servlet-name>log4j-init</servlet-name>
    31   <servlet-class>TestLog4j.Log4jInit</servlet-class>
    32   <init-param>
    33   <param-name>log4j-init-file</param-name>
    34   <param-value>sort.properties</param-value>
    35   </init-param>
    36   <load-on-startup>1</load-on-startup>
    37   </servlet>
    38   因为log4j的初始化要在所有的log4j调用之前完成,所以在web.xml文件中,我们一定要把对应的Servlet定义的load-on-startup应设为1,以便在Web容器启动时即装入该Servlet。
    39   完成了这两个步骤这后,我们就可以象在application开发中一样在web application任何地方应用log4j了。下面是在javabean中的应用的一个例子。
    40   例5-c:
    41   import org.apache.log4j.Logger;
    42   public class InfoForm
    43   {
    44   static Logger logger = Logger.getLogger(InfoForm.class);
    45   protected String title;
    46   protected String content;
    47   public InfoForm() {}
    48   public void setTitle(Object value)
    49   {
    50   logger.debug("nepalon:title = " + title);
    51   title = value;
    52   }
    53   public String getTitle()
    54   {
    55   logger.debug("nepalon:title = " + title);
    56   return title;
    57   }
    58   public void setContent(String value)
    59   {
    60   content = value;
    61   logger.debug("nepalon: content() = " + content);
    62   }
    63   public String getContent()
    64   {
    65   logger.debug("nepalon: content = \n" + content);
    66   return content;
    67   }
    68   }
  • 相关阅读:
    MPMoviePlayerController导致statusBar消失,导致内存泄露leak
    OpenRisc-35-基于orpsoc,eCos的sd card controller的测试实验
    编程之美读书笔记---单链表反序---要求只遍历一次
    POJ 3892 RSA Factorization
    hdu1200(来来回回串起来)
    余世维《有效沟通》听课笔记
    Java--Eclipse关联Java源码
    Why Python?
    《超级时间整理术》晨读笔记
    《放弃的艺术》晨读笔记
  • 原文地址:https://www.cnblogs.com/sunxucool/p/2802703.html
Copyright © 2020-2023  润新知