log4j日志使用详解

一、概述
 Log4j是Apache的一个开放源代码项目，通过使用Log4j， 我们可以控制日志信息输送的目的地是控制台、文件

、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等； 我们也可以控制每一条日志的输出格式

；通过定义每一条日志信息的级别， 我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一

个配置文件来灵活地进行配置，而不需要修改应用的代码。
　　
　　此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中

一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，您可以很方便地将

Log4j集成到J2EE、JINI甚至是SNMP应用中。

二，使用前的准备。
 1、 下载log4j 地址为： http://jakarta.apache.org/log4j/docs/download.html. 
 2、你可能要用到的jar文件有：
  如果需要将日志发送到邮箱，则需要javamail API,JAF API (the JavaBeans Activation Framework) 

下载地址：   http://java.sun.com/products/javamail/
  http://java.sun.com/beans/glasgow/jaf.html
  如果需要jms的支持，则需要jms API  下载地址为：

http://java.sun.com/products/jms/vendors.html
三， Log4j介绍
 Log4j由三个重要的组件构成：日志信息的优先级 priority，日志信息的输出目的地Appender，日志信息的输

出格式（布局）layout。
 1、日志的优先级，
 从低到高，依次有：DEBUG,INFO,WARN,ERROR,分别用来指定这条日志信息的重要程度；如果定义了了输入的级

别为INFO，则只有等于及高于这个级别的才进行处理，此时将输入INFO,WARN,ERROR。值得注意的是，级别中还有两个关

键字，
 ALL:打印所有的日志，
 OFF：关闭所有的日志输出。
 
 2、输出端 Appender

 log4j提供了以下几种常用的输出目的地：
 org.apache.log4j.ConsoleAppender，将日志信息输出到控制台
 org.apache.log4j.FileAppender，将日志信息输出到一个文件
 org.apache.log4j.DailyRollingFileAppender，将日志信息输出到一个，并且每天输出到一个新的日志文件,

按照不同的配置可以定义每月一个日志文件，或者每周，每天，每小时，每分钟等输出一个新的日志文件。
 org.apache.log4j.RollingFileAppender，将日志信息输出到一个文件，通过指定文件的的尺寸，当文件大小

到达指定尺寸的时候会自动把文件改名，如名为example.log的文件会改名为example.log.1，同时产生一个新的

example.log文件。如果新的文件再次达到指定尺寸，又会自动把文件改名为example.log.2，同时产生一个example.log

文件。依此类推，直到example.log. MaxBackupIndex，MaxBackupIndex的值可在配置文件中定义。
 org.apache.log4j.WriterAppender，将日志信息以流格式发送到任意指定的地方。
 org.apache.log4j.jdbc.JDBCAppender，通过JDBC把日志信息输出到数据库中。
 org.apache.log4j.net.SMTPAppender,将日志信息以邮件的方式发送到指定的邮箱。

 3、输出格式（布局）layout
 通过appender可以控制输出的目的地，而如果要控制输出的格式，就可通过log4j的layout组件来实现。通过配

置文件定义一个appender的输出格式，Log4j提供的布局模式有以下几种：
 org.apache.log4j.ConsoleAppender，输出到控制台
 org.apache.log4j.HTMLLayout，以HTML表格形式布局
 org.apache.log4j.PatternLayout，可以灵活地指定布局模式
 org.apache.log4j.SimpleLayout，包含日志信息的级别和信息字符串

 值得一提的是org.apache.log4j.PatternLayout 以Pattern方式的布局，使用Pattern的方式来指定布局。

pattern 的参数如下：ConversionPattern参数的格式含义
 格式名 含义
 %c 输出日志信息所属的类的全名
 %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy-MM-dd 

HH:mm:ss }，输出类似：2002-10-18- 22：10：28 ;比如 %d{HH:mm:ss,SSS} 或 %d{dd MMM yyyy HH:mm:ss,SSS}.
格式可以参考 java类 SimpleDateFormat,不过 按照此类的设置会影响速度。你可以选择更快的方式 %d{ISO8601}, 

%d{ABSOLUTE}, %d{RELATIVE}.或者使用log4j的ISO8601DateFormat, AbsoluteTimeDateFormat, 

RelativeTimeDateFormat 和 DateTimeDateFormat 方式.
 %f 输出日志信息所属的类的类名
 %l 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行
 %m 输出代码中指定的信息，如log(message)中的message
 %M 输出日志信息中所发生的方法名。
 %n 输出一个回车换行符，Windows平台为“/r/n”，Unix平台为“/n”
 %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用debug()输出的，则为DEBUG，依此类推
 %r 输出自应用启动到输出该日志信息所耗费的毫秒数
 %t 输出产生该日志事件的线程名
四、使用
 4.1.1 SimpleLayout 和 FileAppender 方式
以下是以文件的输出方式Appender和简单的布局方式SimpleLayout的例子：

import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.SimpleLayout;
import org.apache.log4j.FileAppender;
public class simpandfile {
   static Logger logger = Logger.getLogger(simpandfile.class);
   public static void main(String args[]) {
      SimpleLayout layout = new SimpleLayout();

      FileAppender appender = null;
      try {
         appender = new FileAppender(layout,"output1.txt",false);
      } catch(Exception e) {}

      logger.addAppender(appender);
      logger.setLevel((Level) Level.DEBUG);

      logger.debug("Here is some DEBUG");
      logger.info("Here is some INFO");
      logger.warn("Here is some WARN");
      logger. error("Here is some ERROR");
      logger.fatal("Here is some FATAL");
   }
}
        
 首先实例化Logger对象。static Logger logger = Logger.getLogger(simpandfile.class);然后指定输出的方

式和布局 appender = new FileAppender(layout,"output1.txt",false);logger.addAppender(appender);
最后定义级别：logger.addAppender(appender);这样完成了log4j日志类的初始化.接着就可以进行日志输出了。这就是

log4j日志类的使用时的一般顺序。因以下程序比较简单，特别的地方将会有注释，将不再解释。


 4.1.2. HTMLLayout 和 WriterAppender


import java.io.*;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.HTMLLayout;
import org.apache.log4j.WriterAppender;
public class htmlandwrite {
   static Logger logger = Logger.getLogger(htmlandwrite.class);
   public static void main(String args[]) {
      HTMLLayout layout = new HTMLLayout();

      WriterAppender appender = null;
      try {
         FileOutputStream output = new FileOutputStream("output2.html");
         appender = new WriterAppender(layout,output);
      } catch(Exception e) {}

      logger.addAppender(appender);
      logger.setLevel((Level) Level.DEBUG);

      logger.debug("Here is some DEBUG");
      logger.info("Here is some INFO");
      logger.warn("Here is some WARN");
      logger. error("Here is some ERROR");
      logger.fatal("Here is some FATAL");
   }
}
        
 

4.1.3. PatternLayout and ConsoleAppender

import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.apache.log4j.ConsoleAppender;
public class consandpatt {
   static Logger logger = Logger.getLogger(consandpatt.class);
   public static void main(String args[]) {

      // Note, %n is newline
      String pattern =  "Milliseconds since program start: %r %n";
             pattern += "Classname of caller: %C %n";
             pattern += "Date in ISO8601 format: %d{ISO8601} %n";
             pattern += "Location of log event: %l %n";
             pattern += "Message: %m %n %n"; 
      
      PatternLayout layout = new PatternLayout(pattern);
      ConsoleAppender appender = new ConsoleAppender(layout);

      logger.addAppender(appender);
      logger.setLevel((Level) Level.DEBUG);

      logger.debug("Here is some DEBUG");
      logger.info("Here is some INFO");
      logger.warn("Here is some WARN");
      logger. error("Here is some ERROR");
      logger.fatal("Here is some FATAL");
   }
}

4.2 使用配置文件来定义输出Appender和布局格式Layout
 log4j支持两种方式的配置方式，.properties 二进制文件和 xml文件的方式。 我们简单讲一下.properties的配

置方式后，将主要讨论 xml文件的配置方式。
 
 4.2.1   我们将以.properties文件的格式定义两种输出方式，一种是输出到文件中，另一种是输出到数据库中

。 
 
 首先定义simple.properties文件,文件定义如下：
 
 #定义了两个输出端
 log4j.rootLogger = INFO,f,db


 # 定义f输出到文件,并且文件是随着大小而增加的
 log4j.appender.f = org.apache.log4j.RollingFileAppender 
 log4j.appender.f.File = F://nepalon//classes//test1.log 
 log4j.appender.f.MaxFileSize = 1000KB 
 log4j.appender.f.MaxBackupIndex = 3 
 log4j.appender.f.layout = org.apache.log4j.PatternLayout
 
 log4j.appender.f.layout.ConversionPattern = %d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n

 #定义db输出到数据库
 log4j.appender.db = org.apache.log4j.jdbc.JDBCAppender
 log4j.appender.db.BufferSize = 40
 log4j.appender.db.Driver = com.microsoft.jdbc.sqlserver.SQLServerDriver
 log4j.appender.db.URL = jdbc:microsoft:sqlserver://127.0.0.1:1433;DatabaseName=test
 log4j.appender.db.User = sa
 log4j.appender.db.Password = 
 log4j.appender.db.layout = org.apache.log4j.PatternLayout
 log4j.appender.db.layout.ConversionPattern = Insert INTO log4j (createDate, thread, priority, 

category, message) values('%d{ISO8601}', '%t', '%-5p', '%c', '%m')

 然后程序中将引用这配置文件。定义如下：

 import org.apache.log4j.Logger;
 import org.apache.log4j. xml.DOMConfigurator;

 public class Test {
 
     static Logger logger = Logger.getLogger(Test.class);
     public static void main(String args[]) {
         //以property方式读到配置文件。
   PropertyConfigurator.configure ( "simple.properties" ) ;
　
         logger.debug("Here is some DEBUG");
         logger.info("Here is some INFO");
         logger.warn("Here is some WARN");
         logger. error("Here is some ERROR");
         logger.fatal("Here is some FATAL");
     }
 }


 4.2.2 以 xml配置

 程序如下：
 import org.apache.log4j.Logger;
 import org.apache.log4j. xml.DOMConfigurator;

 public class Test {
 
     static Logger logger = Logger.getLogger(Test.class);
     public static void main(String args[]) {
         //以XML方式读到配置文件。
    DOMConfigurator.configure(" xmllog4jconfig. xml");

　
         logger.debug("Here is some DEBUG");
         logger.info("Here is some INFO");
         logger.warn("Here is some WARN");
         logger. error("Here is some ERROR");
         logger.fatal("Here is some FATAL");
     }
 }


  xmllog4jconfig. 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="appender" class="org.apache.log4j.FileAppender">
      <param name="File" value="Indentify-Log.txt"/>
      <param name="Append" value="false"/>
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%d [%t] %p - %m%n"/>
      </layout>
   </appender>

   <root>
      <priority value ="debug"/>
      <appender-ref ref="appender"/>
   </root>

 </log4j:configuration>


 对比properties方式和 xml方式，可以看出他们程序中，除了定义读取配置文件的方式不同外,其它的根本就没

有区别了，这也就是log4j的魅力所在了，不需要改变程序，只需要通过改变定义的配置文件， 我们就可以控制日志的输

出方式，是否输出，输出格式。 我们可以通过定义不同的 xml文件来控制输出方式.以下是各种输出方式与布局的例子。
 
 4.2.3 比较简单的一个。
 <? xml version="1.0" encoding="gb2312" ?>
 <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
 <log4j:configuration  xmlns:log4j=" http://jakarta.apache.org/log4j/">
 <!--
  配置输出的日志目录为在控制台。
  格式采用为PatternLoyout,并且样式为：%d{ISO8601} %r [%c :: %p %m]%n
 -->   
   <appender name="CA" class="org.apache.log4j.ConsoleAppender">    
      <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d{ISO8601} %r [%c :: %p %m]%n"/>
      </layout>
   </appender>

   <root>
      <priority value ="debug"/>
     <appender-ref ref="CA"/>
   </root>

 </log4j:configuration>
 
 4.2.4 文件的输出 pattern的布局
 <? xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

 <log4j:configuration  xmlns:log4j=" http://jakarta.apache.org/log4j/">
        
   <appender name="appender" class="org.apache.log4j.FileAppender">
      <param name="File" value="Indentify-Log.txt"/>
      <param name="Append" value="false"/>
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%d [%t] %p - %m%n"/>
      </layout>
   </appender>

   <root>
      <priority value ="debug"/>
     <appender-ref ref="appender"/>
   </root>

 </log4j:configuration>

 4.2.5 控制台的输出 和简单的布局
 <? xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

 <log4j:configuration  xmlns:log4j=" http://jakarta.apache.org/log4j/">
        
   <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
      <layout class="org.apache.log4j.SimpleLayout"/>
   </appender>

   <root>
     <priority value ="debug" />
      <appender-ref ref="ConsoleAppender"/>
   </root>

 </log4j:configuration>

 4.2.6 定义三种输出方式，按照不同的级别，选择不同的输出方式.debug,info,级别通过System.out来打印。
 WARN,FATAL通过System.err来输出。ERROR,FATAL发送到邮箱。

 <? xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
 <log4j:configuration>
     <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
         <param name="Target" value="System.out" />
         <layout class="org.apache.log4j.PatternLayout">
              <param name="ConversionPattern" value="[%d{ISO8601}] %-5p %c %m %n" />
          </layout>
         <filter class="org.apache.log4j.varia.LevelRangeFilter">
              <param name="LevelMin" value="DEBUG"/>
              <param name="LevelMax" value="INFO"/>
         </filter>
     </appender>
     <appender name="STDERR"  class="org.apache.log4j.ConsoleAppender">
         <param name="Target" value="System.err" />
         <layout class="org.apache.log4j.PatternLayout">
              <param name="ConversionPattern" value="[%d{ISO8601}] %-5p %c %m %n" />
         </layout>
         <filter class="org.apache.log4j.varia.LevelRangeFilter">
              <param name="LevelMin" value="WARN"/>
             <param name="LevelMax" value="FATAL"/>
         </filter>
     </appender>

     <!--                          -->
     <!-- Declare the SMTPAppender -->
     <!--                          -->
     <appender name="EMAIL"  class="org.apache.log4j.net.SMTPAppender">
         <param name="BufferSize" value="512" />
         <param name="SMTPHost" value="mail.suiyuanwu.com" />
         <param name="From" value="log4j@server5" />
         <param name="To" value="web@suiyuanwu.com" />
         <param name="Subject" value="[SMTPAppender] Application message" />
         <layout class="org.apache.log4j.PatternLayout">
              <param name="ConversionPattern" value="[%d{ISO8601}]%n%n%-5p%n%n%c%n%n%m%n%n" />
         </layout>
         <filter class="org.apache.log4j.varia.LevelRangeFilter">
              <param name="LevelMin" value="ERROR"/>
              <param name="LevelMax" value="FATAL"/>
         </filter>
     </appender>

     <!--                           -->
     <!-- setup log4j's root logger -->
     <!--                           -->
     <root>
         <level value="all" />
         <appender-ref ref="STDOUT"/>
         <appender-ref ref="STDERR"/>
         <appender-ref ref="EMAIL" />
     </root>
 </log4j:configuration>
    
五、参考资料
 1. http://www.vipan.com/htdocs/log4jhelp.html
         Don't Use System.out.println! Use Log4j - Vipan Singla 
 2. http://jakarta.apache.org/log4j/docs/manual.html
  Short introduction to log4j - Ceki Gülcü - March 2002
 3. http://www-128.ibm.com/developerworks/cn/java/jw-log4j/
 log4j提供了对日志记录的控制
 4. http://logging.apache.org/log4j/docs/documentation.html
 log4j提供的文档。