Apache的开源项目Log4j

 

1 概念

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

2 log4j的下载

 

3 log4j的结构

 

4 appender的常用类型

 

Øorg.apache.log4j.ConsoleAppender(输出到控制台) 

Øorg.apache.log4j.FileAppender(输出到文件)

Øorg.apache.log4j.DailyRollingFileAppender

 

  (每天产生一个日志文件) 

Øorg.apache.log4j.RollingFileAppender

    (文件大小到达指定尺寸的时候产生一个新的文件)

 

 

5 PatternLayout（自定义布局）

 

# %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式

#    如：%d{yyyy年MM月dd日HH:mm:ss,SSS}，输出类似：2012年01月05日22:10:28,921

# %p 输出优先级，即DEBUG,INFO,WARN,ERROR,FATAL,p前面的数字表示占字位。

# %m 输出代码中指定的消息 

# %C 输出所属的类目,通常就是所在类的全名

# %c 输出Logger.getLogger(Clazzclass)中参数的class名

# %t 输出产生该日志事件的线程名

# %n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”

# %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数

#    如：Testlog.main(TestLog.java:10)

# %F 输出日志消息产生时所在的文件名称

# %L 输出代码中的行号

# %% 输出一个"%"字符

 

 

 

6 Logger控制器的选择

log4j.rootLogger=debug

log4j.logger.com=error

log4j.logger.com.rock=info

7

Log4j支持两种配置文件格式，一种是XML（标准通用标记语言下的一个应用）格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法:

①、配置根Logger

Logger 负责处理日志记录的大部分操作。

其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

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

②、配置日志信息输出目的地 Appender

Appender 负责控制日志记录操作的输出。

其语法为：

log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

…

log4j.appender.appenderName.optionN = valueN

这里的appenderName为在①里定义的，可任意起名。

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

org.apache.log4j.ConsoleAppender（控制台），

org.apache.log4j.FileAppender（文件），

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender

定义一个名为stdout的输出目的地，ConsoleAppender为控制台。

③、配置日志信息的格式（布局）Layout

Layout 负责格式化Appender的输出。

其语法为：

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

格式化日志

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：

%m 输出代码中指定的消息；

%M 输出打印该条日志的方法名；

%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL；

%r 输出自应用启动到输出该log信息耗费的毫秒数；

%c 输出所属的类目，通常就是所在类的全名；

%t 输出产生该日志事件的线程名；

%n 输出一个回车换行符，Windows平台为"rn”，Unix平台为"n”；

%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2002-10-18 22:10:28,921；

%l 输出日志事件的发生位置，及在代码中的行数。

运用在代码中

我们在需要输出日志信息的类中做如下的三个工作：

1、导入所有需的commons-logging类：

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员：

private final Log log = LogFactory.getLog(getClass());

LogFactory.getLog()方法的参数使用的是当前类的class。

3、使用org.apache.commons.logging.Log类的成员方法输出日志信息：

if (log.isDebugEnabled()){

log.debug("111");

}

if (log.isInfoEnabled()){

log.info("222");

}

if (log.isWarnEnabled()){

log.warn("333");

}

if (log.isErrorEnabled()){

log.error("444");

}

if (log.isFatalEnabled()){

log.fatal("555");

}

2.3　如何应用记录器的层次

2.3.1　如何定义及获取不同层次的记录器

任何一个记录器的使用都有两个步骤：

1) 在配置文件中定义相应的记录器。

在配置文件中定义记录器的格式有两种

? 定义根记录器的格式为

log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN

? 定义一个非根记录器的格式为

log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN

……

log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN

我们可以定义任意个非根记录器。

2) 在代码中调用Logger类的取得记录器方法取得相应的记录器对象。

要取得根记录器对象可通过Logger.getRootLogger()函数，要取得非根记录器可通过Logger.getLogger()函数。

理论知道就讲到这里，纸上得来终觉浅，下面，我们来小小演练一下。