Log4j入门

Log4j入门

苏玉召 2009-9-18

一、概述

日志记录通常有三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计和分析；跟踪代码运行轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

二、Log4j简介

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

此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。通过使用各种第三方扩展，可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。

三、Log4j组成

Log4j由三个重要的组件构成：Logger、Appender和Layout，Log4j 允许开发人员定义多个Logger，每个Logger拥有自己的名字，Logger之间通过名字来表明隶属关系。有一个 Logger称为Root，它永远存在，且不能通过名字检索或引用，可以通过Logger.getRootLogger（）方法获得，其它Logger通过 Logger.getLogger（String name）方法。

Appender则是用来指明将所有的log信息存放到什么地方，Log4j中支持多种appender，如 console、files、GUI components、NT Event Loggers等，一个Logger可以拥有多个Appender，也就是你既可以将Log信息输出到屏幕，同时存储到一个文件中。

Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。

四、配置文件

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

五、在代码中使用Log4j

1．获取记录器

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

2．读取配置文件

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

DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

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

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

Logger.debug ( Object message )

Logger.info ( Object message )

Logger.warn ( Object message )

Logger.error ( Object message )

参考

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

http://www.log4j.org/

http://www.log4j.org/log4j/faq.html

http://jakarta.apache.org/log4j