log4j入门、详解

log4j入门、详解

log4j入门、详解

作者 雪飘寒 雪飘寒 日期 2010-05-18 2012-06-06 版本 1.0 1.1 备注 创建 第二次修改，添加章节6.1 目录

log4j ............................................................................ 1 目录 ............................................................................. 1 1. Log4j简介 .................................................................. 2 2. 下载与使用 ................................................................... 3

2.1下载log4j的jar文件 ....................................................... 3 2.2 编写一个测试类 ............................................................. 3 2.3 编写配置文件 ............................................................... 4 2.4 输出结果 .................................................................. 4 3. Log4j构成 .................................................................. 5 4. Log4j使用方法 ............................................................... 5

4.1 properties配置文件详解 .................................................... 5 4.2 XML配置文件详解 ........................................................... 8 4.3 properties比较详细的例子 .................................................. 10 4.4 在代码中使用Log4j ........................................................ 12 4.5 注意事项 ................................................................. 13 5. Properties文件实例说明 ...................................................... 13 6. 注意事项 ................................................................... 16

6.1 为什么使用logger之前要判断日志输入级别？ ..................................... 16

1

log4j入门、详解

1. Log4j简介

在应用程序中添加日志记录总的来说基于三个目的：

监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作； 跟踪代码运行时轨迹，作为日后审计的依据；

担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥了代码的主体。

在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包Log4j。

官方站点：http://logging.apache.org/log4j/ Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

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

2

log4j入门、详解

2. 下载与使用

2.1下载log4j的jar文件

下载地址：http://logging.apache.org/log4j/1.2/download.html 将jar文件导入到工程中，N多方法，以eclipse为例

2.2 编写一个测试类

package test; import org.apache.log4j.Logger; public class HelloLog4j { private static Logger logger = Logger.getLogger(HelloLog4j.class); public static void main(String[] args) { // 记录debug级别的信息 logger.debug(\); // 记录info级别的信息 logger.info(\); // 记录error级别的信息 logger.error(\); } } 3

log4j入门、详解

2.3 编写配置文件

在类路径下（src文件夹下）创建log4j.properties文件，配置文件log4j.properties内容如下: log4j.rootLogger=debug,appender1 log4j.appender.appender1=org.apache.log4j.ConsoleAppender log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout 2.4 输出结果

[main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message. [main] INFO com.coderdream.log4j.HelloLog4j - This is info message. [main] ERROR com.coderdream.log4j.HelloLog4j - This is error message. 4

log4j入门、详解

3. Log4j构成

通过配置文件可知，我们需要配置3个方面的内容： 1、根目录（级别和目的地）； 2、目的地（控制台、文件等等）； 3、输出样式。

下面我们来看看Log4J的类图：

Logger - 日志写出器，供程序员输出日志信息

Appender - 日志目的地，把格式化好的日志信息输出到指定的地方去 ConsoleAppender - 目的地为控制台的Appender FileAppender - 目的地为文件的Appender

RollingFileAppender - 目的地为大小受限的文件的Appender

Layout - 日志格式化器，用来把程序员的logging request格式化成字符串 PatternLayout - 用指定的pattern格式化logging request的Layout

4. Log4j使用方法

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

4.1 properties配置文件详解

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式，Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties（key=value）文件。下面我们介绍使用properties文件做为配置文件的方法： （1）配置根Logger，其语法为：

log4j.rootLogger = level,appenderName1,appenderName2, ?

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

5