Log4j日志组件 - 终极资料(8)

Log4J是Apache的一个开放源代码项目(http://logging.apache.org/log4j/docs/)，它是一个日志操作包。通过使用Log4J,可以指定日志信息输出的目的地，控制每一条日志的输出格式，定义日志信息的级别。所有这些功能通过一个配置文件灵活进行配置。

一、LOG4J组成

LOG4J主要由三大组件组成：

. Logger: 决定什么日志信息应该被输出、什么日志信息应该被忽略；

. Appender: 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备； . Layout: 指定日志信息的输出格式；

一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应 一种Layout(示例见下图)。 ↗ Appender1 → Layout ／ Logger ﹨

↘ Appender2 → Layout

二、Logger组件

1. Logger组件提供的方法：

Logger组件是LOG4J的核心组件，它代表了Log4J的日志记录器，它能够对日志信息进行分类筛选。它由org.apache.log4j.Logger类实现，提供了如下方法：

java 代码

package org.apache.log4j;

public class Logger {

// Creation & retrieval methods: public static Logger getRootLogger(); public static Logger getLogger(String name);

// printing methods:

public void debug(Object message); public void info(Object message); public void warn(Object message); public void error(Object message); public void fatal(Object message);

// generic printing method:

public void log(Priority p, Object message); }

2. 在配置文件中配置Logger组件

可在Log4J配置文件中配置自己的Logger组件，示例： log4j.logger.myLogger=WARN

以上代码定义了一个Logger组件，名称为myLogger，日志级别为WARN。

3. 日志级别种类：

一共有五种，级别由高到低依次是：fatal、error、warn、info、debug。获得Logger实例后，我们可调用以下方法之一输出日志信息：

public void debug(Object message); //输出debug级别的日志信息； public void info(Object message); //输出info级别的日志信息； public void warn(Object message); //输出warn级别的日志信息； public void error(Object message); //输出error级别的日志信息； public void fatal(Object message); //输出fatal级别的日志信息；

public void log(Priority p, Object message);//输出参数Priority指定级别的日志信息；

以上方法只有当它的级别大于或等于Logger组件配置的日志级别时才调用。以前面我们配置的myLogger为例，它的日志级别为WARN, 那么在程序中，它的warn()、error()、fatal()方法会被执行。对于log()方法，只有当它的参数Priority指定的日志级别大于或等于WARN时，它才会被执行。

4. 为什么需要对日志进行分级？

在写程序的时候，为了调试程序，我们会在很多出错的地方输出大量的日志信息。当程序调试完，不需要这些信息时，将程序中这些输出日志信息代码删除吗？这样费时费力，对于大型程序几乎不可行。通过对日志分级，假如不想输出WARN级别的日志信息，则Logger组件的级别调高即可，省时省心。

5. Logger组件的继承性

Log4J提供了一个root Logger，它是所有Logger组件的“祖先”,它永远存在，且不能通过名字检索或引用，通过Logger.getRootLogger()方法取得它。配置root Logger代码： log4j.rootLogger=INFO,console

可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。例如：

log4j.apache.myLogger=WARN

log4j.apache.myLogger.mySonLogger=,file

以上代码中, mySonLogger是myLogger的子类Logger组件。

Logger组件的继承关系：

. 如果子类Logger组件没有定义日志级别，则将继承父类的日志级别; . 如果子类Logger组件定义了日志级别，就不会继承父类的日志级别;

. 黙认情况下，子类Logger组件会继承父类所有的Appender，把它们加入到自己的Appener;

. 如果把子类Logger组件的additivity标志设为false，那么它就不会继承父类Appender。additivity标志 默认值为false； 以上配置的三个Logger继承关系示例如图：

root Logger: 日志级别=INFO appender清单=console ↑

myLogger: 日志级别=WARN appender清单=null ↑

mySonLogger: 日志级别=null appender清单=file 这三个Logger组件实际日志级别和Appender如下表： Logger组件 日志级别 Appender清单 root Logger INFO console myLogger WARN console(继承)

mySonLogger WARN(继承) file，console(继承)

三、Appender组件

Appender组件决定将日志信息输出到什么地方。支持以下目的地： . 控制台(Console); . 文件(File);

. GUI组件(GUI component);

. 套接口服务器(Remote socket server); . NT的事件记录器(NT Event Logger);

. UNIX Syslog守护进程(Remote UNIX Syslog daemon);

一个Logger可同时对应多个Appender，示例：myLogger配置二个Appender: 一个file, 一个是console： log4j.logger.myAppender=WARN,file,console

log4j.appender.file=org.apache.log4j.RollingFileAppender log4j.appender.file.File=log.txt

log4j.apender.console=org.apache.log4j.ConsoleAppender

四、Layout组件

Layout组件决定日志输出格式，有以下几种类型： . org.apache.log4j.HTMLLayout(以HTML表格形式布局); . org.apache.log4j.PatternLayout(可以灵活地指定布局模式); . org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串); . org.apache.log4j.TTCCLayout(包含日志产生的时间、线程和类别等信息);

为名称为console的Appender配置SimpleLayout，代码如下： log4j.appender.console.layout=org.apache.log4j.SimpleLayout 输出日志格式如下：

WARN - This is a log message from the myLogger

为名称为file的Appender配置PatternLayout，代码如下： log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=%t %p - %m%n 输出日志格式如下：

THREAD-1 WARN - This is a log message from the myLogger

PatternLayout让开发者依照ConversionPattern定义输出格式。ConversionPattern中一些指定日志内容和格式的预定义符号说明如下：

符号 描述

%r 自程序开始后 …… 此处隐藏：6180字，全部文档内容请下载后查看。喜欢就下载吧 ……