log4j config

 

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

1、定义配置文件 

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。 

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

配置根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.optionN = 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.optionN = valueN 

其中，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）

org.apache.log4j.PatternLayout（可以灵活地指定布局模式）

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

2、在代码中使用Log4j 

下面将讲述在程序代码中怎样使用Log4j。

i、得到记录器使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为： public static Logger getLogger( String name)，通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如： static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ; 

ii、读取配置文件当获得了日志记录器之后，第二步将配置Log4j环境，其语法为： BasicConfigurator.configure ()：自动快速地使用缺省Log4j环境。 PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。 DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。 

iii、插入记录信息（格式化日志信息）当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;

Logger.info ( Object message ) ;

Logger.warn ( Object message ) ;

Logger.error ( Object message ) ;

iv、代码例子注释：蓝色–文件名红色–用到log4j的地方

Hello.java

import org.apache.log4j.*;

public class Hello {

   static Logger logger = Logger.getLogger(Hello.class);

   public static void main(String argv[]) {

      PropertyConfigurator.configure("Hello.properties");

      logger.debug("Hello world.");

      logger.info("What a beatiful day.");

      try {

         // 假如这里出现了异常

      throw new NullPointerException(); 

      } catch (Exception e) {

         logger.warn("NullPointerException", e);   

      }

 }

}　

log4j.properties

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.

log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

#log4j.appender.R=org.apache.log4j.RollingFileAppender

log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB

# Keep one backup file

log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout

log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

log4j.xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

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

      <!--==============================================-->

      <!--                                              -->

      <!--           rolling file Appender                      -->

      <!--==============================================-->

      <appender name="B1" class="org.apache.log4j.RollingFileAppender">

            <param name="File" value="log.htm" />

            <param name="Append" value="false" />

            <layout class="org.apache.log4j.PatternLayout">

                <param name="ConversionPattern" value="%d [%t] %p -%m%n" />

            </layout>

      </appender>

      <!--==============================================-->

      <!--                                              -->

      <!--           console Appender                         -->

      <!--==============================================-->

      <appender name="A1" class="org.apache.log4j.ConsoleAppender">

            <layout class="org.apache.log4j.PatternLayout">

                <param name="ConversionPattern" value="%d [%t] %p - %m%n" />

            </layout>

      </appender>

      <!-- define root-->

      <root>

            <level value="INFO" />

            <appender-ref ref="A1" />



            <appender-ref ref="B1" />

      </root>

</log4j:configuration>