Apache通用日志工具commons-logging和Log4j使用总结

Apache通用日志工具commons-logging和Log4j使用总结

前言

在程序开发中，有时候为了跟踪代码的运行情况，需要在程序代码中加入一些打印代码运行情况的日志代码，在早期的C语言中，一般都是用printf（）函数来实现这些信息的输出，在Java语言中用System..out.println()来实现控制台信息输出。这种输出的信息功能非常有限，如果要输出到文件，就很麻烦。并且，如果以后想去掉（不再输出）这些信息，还需要手动的一行一行去改。当然，也有一种解决办法可以实现处理这个问题，在Java中，可以这么写：

------------------------------------------------------
package org.lavasoft.test1;

/**
* File Name: LogUtil.java
* Created by: IntelliJ IDEA.
* Copyright: Copyright (c) 2003-2006

* Company: LavaSoft( http://lavasoft.blog.51cto.com)
* Author: leizhimin
* Modifier: leizhimin
* Date Time: 2007-5-7 16:38:19
* Readme: 手动日志工具类
*/
public class LogUtil {
private static boolean logSwitch=true; //日志开关,默认为开
public static void log(String smg){
if(logSwitch){
System.out.println(smg);
}
}
} ------------------------------------------------------
package org.lavasoft.test1;

/**
* File Name: ManualLogApp.java
* Created by: IntelliJ IDEA.
* Copyright: Copyright (c) 2003-2006

* Company: LavaSoft( http://lavasoft.blog.51cto.com)
* Author: leizhimin
* Modifier: leizhimin
* Date Time: 2007-5-7 16:38:02
* Readme: 手动日志工具测试
*/
public class ManualLogApp {
public static void main(String[] args){
new ManualLogApp().test();
}

public void test(){
LogUtil.log("我在手动打日志,呵呵!");
}
}

通过这两个类，就实现一个简单的日志工具。当你不想打印日志的时候，可以在LogUtil中改logSwitch的值为flase，那么日志打印功能就关闭了。如果你愿意，你可以将这个开关放到一个配置文件中去修改。还可以让日志打印到文件，但是当你修改实现这个功能的时候，这个日志工具会变得相当的复杂。

为了解决上面的问题，Apache针对不同的语言平台为做了一系列日志工具包，可应用于java、.net、php、c++，这些日志包都是免费的，使用非常方便，可以极大提高编程效率。并且，Apache为了让众多的日志工具有一个相同操作方式，还实现做了一个通用日志工具包commons-logging。

commons-logging是为那些需要建立在不同环境下使用不同日志架构的组件或库的开发者创建的，其中包括Apache Log4j以及Java log的日志架构。把日志信息commons-logging的Log接口，并由commons-logging在运行时决定使用哪种日志架构。
现在，以我见，Apache通用日志工具commons-logging和Log4j已经成为Java日志的标准工具。

下面我Log4j（对Java平台的）和通用日志工具包commons-logging的应用做一个总结。

一、 Log4j的架构

Log4j系统的三大板块：日志写入器、日志输出终端、日志布局模式。

Logger类是日志包的核心，Logger的名称是大小写敏感的，并且名称之间有继承关系。子名由父名做前缀，用点号“.”分隔，如x.y是x.y.z的父亲Logger。

Logger系统中有个根logger，是所有logger的祖先，它总是存在的，并且不可以通过名字获取，可以通过Logger.getRootLogger()来获取。

获取Logger对象的方法很多，可以参考API文档：
static Logger getLogger(Class clazz)
Shorthand for getLogger(clazz.getName()).
static Logger getLogger(String name)
Retrieve a logger named according to the value of the name parameter.
static Logger getLogger(String name, LoggerFactory factory)
Like getLogger(String) except that the type of logger instantiated depends on the type returned by the LoggerFactory.makeNewLoggerInstance(java.lang.String) method of the factory parameter.
static Logger getRootLogger()
Return the root logger for the current logger repository.

在某对象中，用该对象所属的类作为参数，调用Logger.getLogger(Class clazz)以获取logger对象被认为是目前所知最理智的命名logger方法。

用同名参数调用Logger.getLogger(Class clazz)将返回同一个logger对象。Logger的创建可以按照任意顺序，log4j将自动维护logger的继承树。

二、 Log4j的日志级别（Level）

每个logger都有一个日志级别，用来控制日志的输出。未分配级别的logger将自动继承它最近的父logger的日志级别。Logger的由低到高级别如下：
ALL<DEBUG<INFO<WARN<ERROR<FATAL<OFF

Logger的级别越低，输出的日志越详细。

三、 Log4j的输出终端（Appender接口）

Log4j提供了以下几个实现：
 org.apache.log4j.ConsoleAppender(控制台)
 org.apache.log4j.FileAppender(文件)
 org.apache.log4j.DailyRollingFileAppender(每天都产生一个日志文件)
 org.apache.log4j.RollingFileAppender(文件大小达到指定尺寸时产生一个新的日志文件，文件名称上会自动添加数字序号。)
 org.apache.log4j.WriterAppender(将日志信息以流的格式发送到任意指定的地方)

默认情况下，子logger将继承父logger的所有appenders。

rootlogger拥有目标为system.out的consoleAppender，故默认情况下，所有的logger都将继承该appender。

四、 Log4j的输出布局模式（Layout接口）
Log4j提供Layout有以下几种：
 org.apache.log4j.HTMLLayout（以HTML表格形式布局）
 org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
 org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
 org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

Log4j采用类似C语言中的printf函数的打印格式格式化日志信息。打印参数如下：
%m：输出代码中指定的消息。
%p：输出优先级。
%r：输入自应用启动到输出该log信息耗费的毫秒数。
%c：输出所属的类目，通常就是所在类的全名。
%t：输出产生该日志线程的线程名。
%n：输出一个回车换行符。Windows平台为“\r\n”，UNIX为“\n”。
%d：输出日志时间点的日期或时间，默认格式为ISO8601，推荐使用“%d{ABSOLUTE}”，这个输出格式形如：“2007-05-07 18:23:23,500”，符合中国人习惯。
%l：输出日志事件发生的位置，包括类名、线程名，以及所在代码的行数。

五、 Log4j的配置

在实际使用中，Log4j一般是通过配置文件配置使用的。配置文件有两种，Java properties和XML文件。一般都选用properties文件来配置，因为简洁易读。下面只介绍Java properties的配置方式。

对Log4j的配置就是对rootLogger和子Logger的配置。主要的配置项为：rootLogger、输出终端、输出布局模式。

所有的配置项都必须以log4j开头。

下面给出一个配置文件的示例，用以说明配置的方法。

log4j.properties
-------------------------------------------------------------------------------------------------
1 ### logger的配置 ###
2 #配置根logger
3 log4j.rootLogger=INFO,stdout
4 #配置子logger:org.lavasoft(在org.lavasoft包中类的日志在没有指定子logger名的情况下使用这个logger)
5 log4j.logger.org.lavasoft=ERROR,file
6 #配置子logger:org.lavasoft.test(在org.lavasoft.test包中类的日志在没有指定子logger名的情况下使用这个logger)
7 log4j.logger.org.lavasoft.test=ERROR,file1,stdout
8
9 ### direct log messages to stdout ### (标准的终端输出)
10 #控制台输出
11 log4j.appender.stdout=org.apache.log4j.ConsoleAppender
12 #自定义输出布局
13 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
14 #输出的格式
15 log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
16
17 ### direct messages to file ttt.log ### (输入到文件ttt.log的配置)
18 #输出到滚动文件
19 log4j.appender.file=org.apache.log4j.RollingFileAppender
20 #输出文件最大为10M
21 log4j.appender.file.MaxFileSize=10MB
22 #输出文件最大序号为10
23 log4j.appender.file.MaxBackupIndex=10
24 #输出文件路径
25 log4j.appender.file.File=C:/ttt.log
26 #自定义输出布局
27 log4j.appender.file.layout=org.apache.log4j.PatternLayout
28 #输出格式
29 log4j.appender.file.layout.ConversionPattern=%d %-5p [%t] (%13F:%L) %3x - %m%n
30
31 ### direct messages to file ttt.log ### (输入到文件ttt1.log的配置)
32 #输出到滚动文件
33 log4j.appender.file1=org.apache.log4j.RollingFileAppender
34 #输出文件最大为10M
35 log4j.appender.file1.MaxFileSize=10MB
36 #输出文件最大序号为10
37 log4j.appender.file1.MaxBackupIndex=10
38 #输出文件路径
39 log4j.appender.file1.File=C:/ttt1.log
40 #自定义输出布局
41 log4j.appender.file1.layout=org.apache.log4j.PatternLayout
42 #输出格式
43 log4j.appender.file1.layout.ConversionPattern=%d %-5p [%t] (%13F:%L) %3x - %m%n
44
-------------------------------------------------------------------------------------------------

下面对以上的文件解说，并给出一个应用例子：
logger的配置语法为：级别，输入终端1，输出终端2，…
根logger的配置项为：log4j.rootLogger

子logger的配置项为：
log4j.logger.<子logger名>

在上面的配置项中，配置了一个根logger和两个子logger，名称为：org.lavasoft和org.lavasoft.test，通过该名称，利用Logger.getLogger(String name)可以获取这两个logger对象。

子logger的名字一般都以包名来配置，这样当在程序通过类名获取logger的对象就是与本类包名相同的子logger，这样可以方便控制某个包下面logger的输出。

但是一般不建议设置子logger，一个通用的根logger足够用了。由于继承关系，并且可以在任何地方通过子logger的名字获取logger对象，这样容易导致混乱，比如在org.lavasoft包下的类直接获取了名为org.lavasoft.test子logger的对象，这是不合理的（虽然日志可以打印出来），因为如果直接在类中用Logger.getLogger(Class clazz)方式来获取Logger对象，则获取到的应该是名为org.lavasoft的logger对象，而不会得到名为org.lavasoft.test的logger对象。

以上的配置文件纯粹是为了说明问题才那么写的。

六、 Log4j与通用日志包commons-logging的结合

其实commons-logging中默认都支持Log4j，因此只要同时加载commons-logging包和log4j包，可以不用配置即可用在应用中使用commons-logging的接口方法。

当然，标准的应用的是需要的配置，如果你log4j则这个配置是可选的。下面我说明如何通过配置文件来组合commons-logging和log4j。

配置文件内容很简单，就指定一个日志实现类即可，下面是个示例文件：

commons-logging.properties
--------------------------------------------------------------------------------
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
--------------------------------------------------------------------------------

在使用Log4j作为日志工具的时候，commons-logging.properties的配置可以不要，在下面例子中，你可以尝试删除此文件，而不影响日志输出。

log4j.properties
--------------------------------------------------------------------------------
### logger的配置 ###
#配置根logger
log4j.rootLogger=info,stdout
#配置子logger:org.lavasoft(在org.lavasoft包中类的日志在没有指定子logger名的情况下使用这个logger)
log4j.logger.org.lavasoft=ERROR,file
#配置子logger:org.lavasoft.test(在org.lavasoft.test包中类的日志在没有指定子logger名的情况下使用这个logger)
log4j.logger.org.lavasoft.test=ERROR,file1,stdout

### direct log messages to stdout ### (标准的终端输出)
#控制台输出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
#自定义输出布局
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
#输出的格式
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### direct messages to file ttt.log ### (输入到文件ttt.log的配置)
#输出到滚动文件
log4j.appender.file=org.apache.log4j.RollingFileAppender
#输出文件最大为10M
log4j.appender.file.MaxFileSize=10MB
#输出文件最大序号为10
log4j.appender.file.MaxBackupIndex=10
#输出文件路径
log4j.appender.file.File=C:/ttt.log
#自定义输出布局
log4j.appender.file.layout=org.apache.log4j.PatternLayout
#输出格式
log4j.appender.file.layout.ConversionPattern=%d %-5p [%t] (%13F:%L) %3x - %m%n

### direct messages to file ttt.log ### (输入到文件ttt1.log的配置)
#输出到滚动文件
log4j.appender.file1=org.apache.log4j.RollingFileAppender
#输出文件最大为10M
log4j.appender.file1.MaxFileSize=10MB
#输出文件最大序号为10
log4j.appender.file1.MaxBackupIndex=10
#输出文件路径
log4j.appender.file1.File=C:/ttt1.log
#自定义输出布局
log4j.appender.file1.layout=org.apache.log4j.PatternLayout
#输出格式
log4j.appender.file1.layout.ConversionPattern=%d %-5p [%t] (%13F:%L) %3x - %m%n
--------------------------------------------------------------------------------

下面是TestLog工程的一个类HelloWorld.java，通过运行该类，可以看到日志的输出情况。

org.lavasoft.test. HelloWorld.java
--------------------------------------------------------------------------------
package org.lavasoft.test;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
* File Name: HelloWorld.java
* Created by: IntelliJ IDEA.
* Copyright: Copyright (c) 2003-2006
* Company: LavaSoft( http://lavasoft.blog.51cto.com)
* Author: leizhimin
* Modifier: leizhimin
* Date Time: 2007-5-6 17:49:55
* Readme:
*/
public class HelloWorld {
public static void main(String args[]) {
Log log1=LogFactory.getLog(HelloWorld.class);
log1.info("11111111通过class对象来获取logger对象.");
log1.error("111111111.....error");
new HelloWorld().test();
}

public void test(){

//获取(配置文件中)名称为log4j.logger.org.lavasoft.test的logger对象
Log log2=LogFactory.getLog("org.lavasoft.test");
log2.info("2222222222222222");
log2.error("222222HelloWorld的Error!");

//获取(配置文件中)名称为log4j.logger.org.lavasoft的logger对象
Log log3=LogFactory.getLog("org.lavasoft");
log3.info("3333333333333333");
log3.error("33333..........errrr");

//获取当前类所在
Log log4=LogFactory.getLog(this.getClass());
log4.info("44444444");
log4.error("44444444 ....error");
}
}
--------------------------------------------------------------------------------

运行org.lavasoft.test. HelloWorld.java，结果如下：
22:45:27,953 ERROR HelloWorld:20 - 111111111.....error
22:45:27,953 ERROR HelloWorld:20 - 111111111.....error
22:45:27,968 ERROR test:29 - 222222HelloWorld的Error!
22:45:27,968 ERROR test:29 - 222222HelloWorld的Error!
22:45:27,968 ERROR lavasoft:34 - 33333..........errrr
22:45:27,968 ERROR HelloWorld:39 - 44444444 ....error
22:45:27,968 ERROR HelloWorld:39 - 44444444 ....error

打开C盘，下面有两个日志文件ttt.log、ttt1.log，内容如下：
ttt.log
--------------------------------------------------------------------------------
2007-05-08 22:45:27,953 ERROR [main] (HelloWorld.java:20) - 111111111.....error
2007-05-08 22:45:27,968 ERROR [main] (HelloWorld.java:29) - 222222HelloWorld的Error!
2007-05-08 22:45:27,968 ERROR [main] (HelloWorld.java:34) - 33333..........errrr
2007-05-08 22:45:27,968 ERROR [main] (HelloWorld.java:39) - 44444444 ....error
--------------------------------------------------------------------------------

ttt1.log
--------------------------------------------------------------------------------
2007-05-08 22:45:27,953 ERROR [main] (HelloWorld.java:20) - 111111111.....error
2007-05-08 22:45:27,968 ERROR [main] (HelloWorld.java:29) - 222222HelloWorld的Error!
2007-05-08 22:45:27,968 ERROR [main] (HelloWorld.java:39) - 44444444 ....error
--------------------------------------------------------------------------------

从两个日志文件输出信息（类、loging的行数）可以看到，通过名称org.lavasoft.test获取的logger打印的ERROR级别的日志记录在C:/ttt1.log里面，而通过名称org.lavasoft获取的logger打印的ERROR级别的日志记录在C:/ttt.log里面，通过LogFactory.getLog(this.getClass())和LogFactory.getLog(HelloWorld.class);记录的日志实质上根据该类所在的包名来获取logger，因此实质上获取的是离他最近的logger（离它最近的logger就是该包上定义的logger对象，名称为org.lavasoft.test）。

其实仔细研究一下输出的logger就很容易看出其中的所以然，上面这种定义子logger的方法不推荐在项目中使用，一般只定义一个rootlogger就行了。

为了交流研究方便，我把TestLog整个工程的源代码（用IntellJ IDEA 5.12做的）打包放在附件里，当然也可以很容易的将此源代码加入Eclipse或者NetBean工程。