log4j基础与使用

一 概念

1.1 背景

     在应用程序中添加日志记录的目的：
    1:  调试器，向文件或控制台打印代码的调试信息，因为可以通过配置文件设置是否输出打印信息，所以比通过 System.out打出调试信息更优雅。
    2:  统计审计,监视代码中变量的变化情况。

1.2 log4j简介

Apache为我们提供了一个强有力的日志操作包-Log4j。

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以

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

二 使用

   2.1简单的例子

    1:定义配置文件

log4j.properties

log4j.rootLogger = DEBUG , A1 , R

log4j.appender.A1 = org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout = org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %c ] - [ %p ]  %m%n

log4j.appender.R = org.apache.log4j.RollingFileAppender 
log4j.appender.R.File = c:log4j.log 
log4j.appender.R.MaxFileSize = 100KB 
log4j.appender.R.MaxBackupIndex = 1  
log4j.appender.R.layout = org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern = %5p  [ %t ]  (%F:%L) - %m%n

2:在代码中使用log4j

  import  com.foo.Bar;
  import  org.apache.log4j.Logger;
  import  org.apache.log4j.BasicConfigurator;
  public   class  MyApp  ... {
   // Define a static logger variable so that it references the
   // Logger instance named "MyApp".
   static Logger logger = Logger.getLogger(MyApp.class);//得到记录器
   public static void main(String[] args) ...{
     // Set up a simple configuration that logs on the console.
     BasicConfigurator.configure();//自动快速地使用缺省Log4j环境
     logger.info("Entering application.");
     Bar bar = new Bar();
     bar.doIt();
     logger.info("Exiting application.");//.插入记录信息
   }
 }

三：详细说明

1:配置文件

  Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。
  Log4J运行时，不对环境做任何假定，尤其是没有默认的存放器。

  Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：

配置根Logger，其语法为：
log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
配置日志信息输出目的地Appender，其语法为
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

配置日志信息的格式（布局），其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN其中，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

 

2 读取

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。

   　(BasicConfigurator.configure给根记录器增加一个ConsoleAppender，输出格式通过PatternLayout设为"%-4r [%t] %-5p %c %x - %m%n"，还有根记录器的默认级别是Level.DEBUG. )

 
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

用servlet配置log4j:

在Application目录下的web.xml文件加入以后代码

< servlet >
     < servlet-name > log4j-init </ servlet-name >
     < servlet-class > com.apache.jakarta.log4j.Log4jInit </ servlet-class >
     < init-param >
       < param-name > log4j </ param-name >
       < param-value > /WEB-INF/log4j.properties </ param-value >
     </ init-param >
     < load-on-startup > 1 </ load-on-startup >
</ servlet >

 

public   class  Log4jInit  extends  HttpServlet  ... {

  public void init() ...{
    String prefix =  getServletContext().getRealPath("/");
    String file = getInitParameter("log4j");
    // if the log4j-init-file is not set, then no point in trying
    System.out.println("................log4j start");
    if(file != null) ...{
      PropertyConfigurator.configure(prefix+file);
    }
  }
public void doGet(HttpServletRequest req, HttpServletResponse res) ...{
  }
}

 

spring 中配置log4j

web.xml中

< context-param >    
  < param-name > log4jConfigLocation </ param-name >    
  < param-value > /WEB-INF/classes/log4j.properties </ param-value >
</ context-param >
< listener >    
  < listener-class > org.springframework.web.util.Log4jConfigListener </ listener-class >
</ listener >  

 

五 参考

www.log4j.org

http://hedong.3322.org/archives/000195.html

http://www-128.ibm.com/developerworks/cn/java/l-log4j/index.html