log4j 简明使用文档

1.下载

http://jakarta.apache.org/log4j/docs/download.html

2.log4j的简明手册（english）

http://jakarta.apache.org/log4j/docs/manual.html

3.安装

    log4j不需要安装，只需要把
①LOG4J_HOME/dist/lib/log4j-VERSION.jar
②LOG4J_HOME/dist/classes
③一 个JAXP编译 XML的剖析器（即parser.jar文件）.
放在classpath中你就可以使用。（LOG4J_HOME是你放置log4j的目录）

4.使用

4．1  简介

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

4．2  使用Java特性文件做为配置文件的方法：

4．2．1  配置根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（将日志信息以流格式发送到任意指定的地点）

4．2．2  设置日志信息的格式（布局），其语法为：

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（包含日志产生的时间、线程、类别等等信息）

4．3  在代码中使用Log4j

4．3．1  得到记录器

    使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)，

    通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;

4．3．2  读取配置文件

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

4．3．3  插入记录信息（格式化日志信息）

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

Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;

5.  示例(源文件和属性文件)
//TestLog4j.java
package TestLog;
 
import java.io.IOException;
import java.net.URL;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
 
public class TestLog4j
{
 
        private static Logger
        logger=Logger.getLogger(TestLog.TestLog4j.class.getName());
        public TestLog4j()
        {
        }
        public static void main(String argv[])
        {
                 String resource ="/TestLog/TestLog4j.properties";
                          URL configFileResource =
                            TestLog4j.class.getResource(resource);
                  PropertyConfigurator.configure(configFileResource);
        logger.debug("Hello, my name is Maggie Simpson.");
                 logger.info("info");
        }
}
 
//TestLog4j.properties
 
#设置logger和level
log4j.rootCategory=DEBUG, R
#文件大小达到指定尺寸时产生新文件
log4j.appender.R=org.apache.log4j.RollingFileAppender
#输出的日志文件名
log4j.appender.R.File=log.html
#文件格式
log4j.appender.R.layout=org.apache.log4j.HTMLLayout
#指定文件大小
log4j.appender.R.MaxFileSize=3KB
#产生新文件，原文件名为log.html.1,...,log.html.MaxBackupIndex
log4j.appender.R.MaxBackupIndex=2