dwys0343

技术整理

  BlogJava :: 首页 :: 联系 :: 聚合  :: 管理
  1 Posts :: 16 Stories :: 0 Comments :: 0 Trackbacks

动态配置 log4j

配置外部配置文件来配置的基本步骤
1.1
 一个运用配置文件的实例
Log4j
之所以能成功的原因之一是它的灵活性。但如果只是简单的调用 BasicConfigurator.configure() 来进行配置工作,那么所有的配置都是在函数中写死的,以后修改配置就要修改原代码,这就不能体现出 log4j 的灵活性了,所以基本上不会通过 BasicConfigurator.configure() 来进行配置工作的。
为了增加软件的灵活性,最常用的做法就是使用配置文件,如 web.xml 之于 J2EE struts-config.xml 之于 struts 一样, log4j 也提供了让我们把配置信息从程序转移到配置文件中的方法。 Log4j 提供了两种方式的配置文件: XML 文件和 Java property 配置文件。通过把配置信息转移到外部文件中,当我们要修改配置信息时,就可以直接修改配置文件而不用去修改代码了,下面,我们就来完成一个通过配置文件来实现 log4j 的实例。
2-a
package TestLog4j;
import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.Priority; public class TestLog4j 
{
static Logger logger = Logger.getLogger(TestLog4j.class.getName());
public TestLog4j(){}

public static void main(String[] args)
{
//
通过 BasicConfigurator 类来初始化
//BasicConfigurator.configure();
//
1 )通过配置文件来初始化
PropertyConfigurator.configure("F:\\nepalon\\log4j.properties");

logger.debug("Start of the main() in TestLog4j");
  // 代码( 2
logger.info("Just testing a log message with priority set to INFO");
logger.warn("Just testing a log message with priority set to WARN");
logger.error("Just testing a log message with priority set to ERROR");
logger.fatal("Just testing a log message with priority set to FATAL");
logger.log(Priority.WARN, "Testing a log message use a alternate form");
logger.debug(TestLog4j.class.getName());
  // 代码( 2
}
}
在这个例子中,我们用 PropertyConfigurator.configure("F:\\nepalon\\log4j.properties") 代替 BasicConfigurator.configure() 进行配置。 PropertyConfigurator.configure() 函数的参数可以是一个 properties 文件所在路径的 String 对象,可以是一个 properties 文件所在路径的 URL 对象,也可以是一个 properties 对象。通过 PropertyConfigurator.configure() 可以通过指定的 properties 文件来配置信息。如果要用 XML 文件进行信息配置,可以在代码中调用 DOMConfigurator() 函数来进行配置工作。在这里,我们只以 properties 文件来完成例子。接着,我们来看一下 log4j.properties 文件中都有些什么东西:
2-b
log4j.rootLogger = DEBUG, A1
log4j.appender.A1 = org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout = org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern = %-4r [%t] %-5p %c %x - %m%n
运行这个实例,运行结果为
0 [main] DEBUG TestLog4j.TestLog4j - Start of the main() in TestLog4j
20 [main] INFO TestLog4j.TestLog4j - Just testing a log message with priority set to INFO

20 [main] WARN TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
20 [main] ERROR TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
20 [main] FATAL TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
180 [main] WARN TestLog4j.TestLog4j - Testing a log message use a alternate form
180 [main] DEBUG TestLog4j.TestLog4j - TestLog4j.TestLog4j
下面,我们分析一下这个配置文件。
1) 
由于每一个 Logger 对旬都有一个级别,文件的第一行就是定义了一个 Logger 及其级别。在这里定义了一个根记录器( root logger ),这涉及到记录器的层次问题,在些暂时不深入讨论,在后面的章节再进行讨论。
2) 
第二行定义了一个名为 A1 的输出流,这个流就是控制台,所以通过 Logger 对象打印的信息会在控制台输出。
3) 
第三行定义了打印信息的布局。在这里我们用 PatternLayout 作为此记录器的布局, PatternLayout 允许你以灵活的格式来打印信息。
4) 
第四行指定的打印信息的具体格式,从结果可知,这个实例的打印格式为:当前打印语句所使用的时间  [ 日志所在的线程 打印的级别   当前日志所在的类的全名   日志信息。
现在我们来修改一下这个记录器的级别,把第一行的 DEBUG 改为 INFO ,再运行程序,结果将变为:
0 [main] INFO TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
10 [main] WARN TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
10 [main] ERROR TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
10 [main] FATAL TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
10 [main] WARN TestLog4j.TestLog4j - Testing a log message use a alternate form
由于这个 Logger 的级别变为 INFO ,而代码( 2 )是调用 debug() 函数来输出日志信息时只能当记录器级别为 DEBUG 时才输出信息,所以代码( 2 )将不输出信息。
1.2
 实例原理
1.2.1  初始化配置信息
如果要通过 JAVA properties 文件来配置信息,那么在代码中就要通过 PropertyConfigurator.configure() 函数从 properties 文件中加载配置信息,这个函数有三种参数形式:一个 properties 文件所在路径的 String 对象,可以是一个 properties 文件所在路径的 URL 对象,也可以是一个 properties 对象。如果要用 XML 文件来配置信息,则可用类型的
DOMConfigurator()
函数来从一个 XML 文件中加载配置信息。
1.2.2
 输出端 Appender
在上面的例子中,我们都是简单的把日志信息输出到控制台中。其实在 log4j 中还可以把日志信息输出到其它的输出端,对于同一个日志信息,我们还可以让它同时输出到多个输出端中,如同时在控制台和文件中进行打印。一个输出端就是一个 appender 。要在配置文件中定义一个 appender 有三步:

在定义一个记录器的同时定义出该记录器的输出端 appender 。在例 2 的配置文件的第一句 log4j.rootLogger = DEBUG, A1 中,我们定义了一个根记录器,它的级别为 DEBUG ,它有一个 appender 名为 A1 。定义根记录器的格式为 log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN 。同一个记录器可有多个输出端。
2) 
定义 appender 的输出目的地。定义一个 appender 的输出目的地的格式为 log4j.appender.appenderName = fully.qualified.name.of.appender.class log4j 提供了以下几种常用的输出目的地:
org.apache.log4j.ConsoleAppender ,将日志信息输出到控制台
 org.apache.log4j.FileAppender ,将日志信息输出到一个文件
org.apache.log4j.DailyRollingFileAppender ,将日志信息输出到一个,并且每天输出到一个新的日志文件
org.apache.log4j.RollingFileAppender ,将日志信息输出到一个文件,通过指定文件的的尺寸,当文件大小到达指定尺寸的时候会自动把文件改名,如名为 example.log 的文件会改名为 example.log.1 ,同时产生一个新的 example.log 文件。如果新的文件再次达到指定尺寸,又会自动把文件改名为 example.log.2 ,同时产生一个 example.log 文件。依此类推,直到 example.log. MaxBackupIndex MaxBackupIndex 的值可在配置文件中定义。
org.apache.log4j.WriterAppender ,将日志信息以流格式发送到任意指定的地方。
 org.apache.log4j.jdbc.JDBCAppender ,通过 JDBC 把日志信息输出到 数据库 中。
在例 2 中, log4j.appender.A1 = org.apache.log4j.ConsoleAppender 定义了名为 A1 appender 的输出目的地为控制台,所以日志信息将输出到控制台。
3) 
定义与所选的输出目的地相关的参数,定义格式为:
log4j.appender.appenderName.optionName1 = value1
……
log4j.appender.appenderName.optionNameN = valueN
其中一个最常用的参数 layout 将在下面介绍。
1.2.3  输出格式(布局)layout
通过 appender 可以控制输出的目的地,而如果要控制输出的格式,就可通过 log4j layout 组件来实现。通过配置文件定义一个 appender 的输出格式,也通常需要两个步骤:
1) 
定义 appender 的布局模式。定义一个 appender 的布局模式的格式为 log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class Log4j 提供的布局模式有以下几种:
org.apache.log4j.HTMLLayout ,以 HTML 表格形式布局
org.apache.log4j.PatternLayout ,可以灵活地指定布局模式
org.apache.log4j.SimpleLayout ,包含日志信息的级别和信息字符串
在例 2  中 log4j.appender.A1.layout = org.apache.log4j.PatternLayout 定义了名为 A1 appender 的布局模式为 PatternLayout
2) 
定义与所选的布局模式相关的设置信息,定义格式为:
log4j.appender.appenderName.layout.optionName1 = value1
……
log4j.appender.appenderName.layout.optionNameN = valueN
选择了不同的布局模式可能会有不同的设置信息。实例 2 所选的布局模式 PatternLayout 的一个 PatternLayout ConversionPattern  ,通过定义这个 PatternLayout 的值,我们可以指定输出信息的输出格式。在例 2 的配置文件中的定义如下 log4j.appender.A1.layout.ConversionPattern = %-4r [%t] %-5p %c %x - %m%n 。在下面,我们将介绍布局模式 PatternLayout 的参数 ConversionPattern 的各个值代表的含义。
1.2.4
  ConversionPattern 参数的格式含义
格式名   含义
%c 
输出日志信息所属的类的全名

%d  输出日志时间点的日期或时间,默认格式为 ISO8601 ,也可以在其后指定格式,比如: %d{yyy-MM-dd HH:mm:ss } ,输出类似: 2002-10-18 - 22 10 28
%f 
输出日志信息所属的类的类名
%l 
输出日志事件的发生位置,即输出日志信息的语句处于它所在的类的第几行
%m 
输出代码中指定的信息,如 log(message) 中的 message
%n 
输出一个回车换行符, Windows 平台为 “\r\n” Unix 平台为 “\n”
%p 
输出优先级,即 DEBUG INFO WARN ERROR FATAL 。如果是调用 debug() 输出的,则为 DEBUG ,依此类推
%r 
输出自应用启动到输出该日志信息所耗费的毫秒数
%t 
输出产生该日志事件的线程名
1.3
 定义多个输出目的地的实例
从上面的实例原理中我们已经知道,同一个日志信息可以同时输出到多个输出目的地,在这个例子中,我们将实现一个把日志信息同时输出到控制器、一个文件中的实例和 数据库 中。这个实例的 Java 代码我们沿用例 2 中的代码,我们只需修改配置文件即可。这也体现了 log4j 的灵活性。
3-a
create table log4j(
logID int primary key identity,
message varchar(1024),
priority varchar(10),
milliseconds int,
category varchar(256),
thread varchar(100),
NDC varchar(256),
createDate datetime,
location varchar(256),
caller varchar(100),
method varchar(100),
filename varchar(100),
line int
)
3-b
#1 
定义了两个输出端
log4j.rootLogger = INFO, A1, A2,A3

#2 
定义 A1 输出到控制器
log4j.appender.A1 = org.apache.log4j.ConsoleAppender
#3 
定义 A1 的布局模式为 PatternLayout
log4j.appender.A1.layout = org.apache.log4j.PatternLayout
#4 
定义 A1 的输出格式
log4j.appender.A1.layout.ConversionPattern = %-4r [%t] %-5p %c - %m%n

#5 
定义 A2 输出到文件
log4j.appender.A2 = org.apache.log4j.RollingFileAppender
#6 
定义 A2 要输出到哪一个文件
log4j.appender.A2.File = F:\\nepalon\\classes\\example3.log
#7 
定义 A2 的输出文件的最大长度
log4j.appender.A2.MaxFileSize = 1KB
#8 
定义 A2 的备份文件数
log4j.appender.A2.MaxBackupIndex = 3
#9 
定义 A2 的布局模式为 PatternLayout
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
#10 
定义 A2 的输出格式
log4j.appender.A2.layout.ConversionPattern = %d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n

#11
  定义 A3 输出到数据库
log4j.appender.A3 = org.apache.log4j.jdbc.JDBCAppender
log4j.appender.A3.BufferSize = 40
log4j.appender.A3.Driver = com.microsoft.jdbc.sqlserver.SQLServerDriver
log4j.appender.A3.URL = jdbc:microsoft:sqlserver://127.0.0.1:1433;DatabaseName=nepalon
log4j.appender.A3.User = sa
log4j.appender.A3.Password = 
log4j.appender.A3.layout = org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern = INSERT INTO log4j (createDate, thread, priority, category, message) values(getdate(), '%t', '%-5p', '%c', '%m')
配置文件中的 6 7 8 行显示了输出端为 RollingFileAppender 的特有参数及其运用的方法。 11 区显示了输出端为 JDBCAppender 的特有参数及其运用方法。在这着重讲解一下 6 7 8 行的作用。 6 行指定日志信息输出到哪个文件, 7 行指定日志文件的最大长度,最后要详细介绍 8 行。第 8 行的参数是设置备份文件的个数的参数,在这里我们设置为 3 ,表示最多有 3 个备份文件,具体作用为:

1)  example3.log 文件的大小超过 K 时,就把文件改名为 example3.log.1 ,同时生成一个新的 example3.log 文件
2) 
example3.log 文件的大小再次超过 1K ,又把文件改名为 example3.log.1 。但由于此时 example3.log.1 已存在,则先把 example3.log.1 更名为 example3.log.2 ,再把 example3.log 文件改名为 example3.log.1
3) 
同理,当 example3.log 文件的大小再次超过 1K ,先把 example3.log.2 文件更名为 example3.log.3 ,把 example3.log.1 文件更名为 example3.log.2 ,再把 example3.log 文件改名为 example3.log.1
4) 
example3.log 文件的大小再次超过 1K ,先把 example3.log.2 文件更名为 example3.log.3 ,旧的 example3.log.3 文件将被覆盖;把 example3.log.1 文件更名为 example3.log.2 ,旧的 example3.log.2 文件被覆盖;最后把 example3.log 文件改名为 example3.log.1 并覆盖掉旧的 example3.log.1 文件。
运行结果将分为两部分
在控制器中:
0 [main] INFO TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
11 [main] WARN TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
21 [main] ERROR TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR 21 [main] FATAL TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
21 [main] WARN TestLog4j.TestLog4j - Testing a log message use a alternate form
在文件 example3.log 中:
2003-12-18 04:23:02:INFO main TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
2003-12-18 04:23:02:WARN main TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
2003-12-18 04:23:02:ERROR main TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
2003-12-18 04:23:02:FATAL main TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
2003-12-18 04:23:02:WARN main TestLog4j.TestLog4j - Testing a log message use a alternate form
1.4
 配置 log4j 的总结
这个教程到这里,关于配置 log4j 的配置文件的基本原理已经讲完了,而且通过例 3 我们已经可以完成基本的日志工作了。现在,我们就做一个总结。配置一个配置文件的基本步骤如下:
1) 
定义一个 Logger 。在定义 Logger 时指定该 Logger 的级别级其输出目的地。定义 Logger 的格式为
log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN

2) 
定义 appender 的输出目的地。定义一个 appender 的输出目的地的格式为
log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j
提供的输出端有 ConsoleAppender FileAppender  DailyRollingFileAppender RollingFileAppender WriterAppender

3)  定义 appender 的除布局模式外的其它相关参数,如例 3 中第 6 7 8 定义了 A2 的相关参数。定义格式为
log4j.appender.appenderName.optionName1 = value1
……
log4j.appender.appenderName.optionNameN = valueN
如果除了布局模式外不需要定义别的参数,可跳过这一步(如例 3 中的 A1 )。
4) 
定义 appender 的布局模式。定义一个 appender 的布局模式的格式为
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

布局模式其实也是步骤 3 )中的一个部分,只是布局模式参数是每一个 appender 必须定义的参数。 Log4j 提供的布局模式有 HTMLLayout PatternLayout SimpleLayout
5) 
定义与所选的布局模式相关的设置信息,定义格式为
og4j.appender.appenderName.layout.optionName1 = value1
……
log4j.appender.appenderName.layout.optionNameN = valueN
2
 记录器的层次 Logger hierarchy
2.1
 何为记录器的层次 hierarchy
首先,我们先看一下何为层次,以我们最熟悉的继承为例,下面是一张类图

在这个继承体系中,类 B 是类 C 的父类,类 A 是类 C 的祖先类,类 D 是类 C 的子类。这些类之间就构成一种层次关系。在这些具有层次关系的类中,子类都可继承它的父类的特征,如类 B 的对象能调用类 A 中的非 private 实例变量和函数;而类 C 由于继承自类 B ,所以类 B 的对象可以同时调用类 A 和类 B 中的非 private 实例变量和函数。
log4j 中,处于不同层次中的 Logger 也具有象类这样的继承关系。
2.2
 记录器的层次
如果一个应用中包含了上千个类,那么也几乎需要上千个 Logger 实例。如何对这上千个 Logger 实例进行方便地配置,就是一个很重要的问题。 Log4J 采用了一种树状的继承层次巧妙地解决了这个问题。在 Log4J Logger 是具有层次关系的。它有一个共同的根,位于最上层,其它 Logger 遵循类似包的层次。下面我们将进行介绍。
2.2.1  根记录器root logger
就象一个 Java 中的 Object 类一样, log4j 中的 logger 层次中有一个称之为根记录器的记录器,其它所有的记录器都继承自这个根记录器。根记录器有两个特征:
1) 
根记录器总是存在。就像 Java 中的 Object 类一样,因为用 log4j 输出日志信息是通过记录器来实现的,所以只要你应用了 log4j ,根记录器就肯定存在的。
2) 
根记录器没有名称,所以不能通过名称来取得根记录器。但在 Logger 类中提供了 getRootLogger() 的方法来取得根记录器。
2.2.2
 记录器的层次
Logger
遵循类似包的层次。如
static Logger rootLog = Logger.getRootLogger();
static Logger log1 = Logger.getLogger("test4j");
static Logger log2 = Logger.getLogger("test4j.test4j2");
static Logger log3 = Logger.getLogger("test4j.test4j2.test4j2");
那么 rootLog log2 的祖先子记录器, log1 log2 的父子记录器, log3 log2 的子记录器。记录器象 Java 中的类继承一样,子记录器可以继承父记录器的设置信息,也可以可以覆写相应的信息。
首先先看一下记录器层次中的继承有什么用处。假设程序中的每个包都具有一些基本的日志信息,而包中的不同包可能会有些额外的日志信息要输出,这种情况就可以象处理 Java 中的类一样,运用 Logger 中的层次关系来达到目的。假设有个名为 A 的包,我包下的所有类都要把日志信息输出到控制台中; A.B 包除了输出到控制台外还要输出到文件中; A.C 包除了输出到控制台中还要输出到 HTML 文档中。这样我们就可以通过定义一个父记录器 A ,它负责把日志信息输出到控制台中;定义一个 A 的子记录器 A.B ,它负责把日志信息输出到文件中;定义一个 A 的子记录器 A.C ,它负责把日志信息输出到 HTML 文档中。

记录器遵循的是类似包的层次,这样做为我们带来了大大的方便。 Logger 类中的 getLogger() 方法可以取得 Logger 对象,这个方法有三种参数形式 String Class URL ,其实不论是用哪一种,最终都是通过记录器的名字来取得记录器对象的。如果要取得一个名为 A.B 的记录器对象,我们可以 Logger.getLogger(“A.B”) 。但从上面的例子中,我们都是通过 Logger.getLogger(TestLog4j.class.getName()) 这种方法来取得记录器对象。这是为什么呢?现在我们假设 A.B 的包下有一个类 BClass ,那么我们调用 BClass.class.getName() 得到的是这个类的全名 A.B.BClass 。所以当调用 Logger.getLogger(BClass.class.getName()) 时,最理想的情况是返回名为 A.B.BClass 的记录器对象。但是如果不存在名为 A.B.BClass 的记录器时它会怎样呢?其实通过 Logger 类的 getLogger 方法取得记录器时存在下面两种情况:
1) 
如果存在与所要找的名字完全相同的记录器,则返回相应的记录器对象。
当调用 Logger.getLogger(BClass.class.getName()) 时,如果定义了名为 A.B.BClass 的记录器,它就返回该记录器的对象。
2) 
但如果找不到,它会尝试返回在记录器层次中与所要找的记录器最接近的记录器对象。
当调用 Logger.getLogger(BClass.class.getName()) 时,如果没有定义了名为 A.B.BClass 的记录器,那会尝试返回名为 A.B 的记录器的对象;如果又没有定义名为 A.B 的记录器,它会尝试返回名为 A 的记录器的对象;如果也没定义名为 A 的记录器,它就会返回根记录器的对象,而根记录器是必须存在的,所以你总能得到一个记录器对象。
好了,现在我们回到前面的问题,我们为什么总要通过 Logger.getLogger(BClass.class.getName()) 这种以类全名作为参数来取得记录器对象呢?其实这是为了管理方便。因为我们在定义 设计 Logger 时也遵循类似包的规则,使设计器的名称与程序中的类包对应。如上面的假设中我们的程序中有 A 包, A 包下有 B 包和 C 包, B 包下又有类 BClass ,那么我们就可使设计器的名为 A A.B A.C A.B.BClass ,以此类推。那么当我们通过类命名来取得设计器对象时,总能取到与所要的设计器最接近的设计器对象。
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() 函数。
理论知道就讲到这里,纸上得来终觉浅,下面,我们来小小演练一下。
4-a
package TestLog4j;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.Priority;
import TestLog4j.TestLog4j2.TestLog4j2;

public class TestLog4j 
{
static Logger logger = Logger.getLogger(TestLog4j.class.getName());
  // 2
public TestLog4j(){}

public static void main(String[] args)
{
//
同时输出到控制台和一个文件的实例并实现了 Logger 的继承
PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");

logger.debug("Start of the main() in TestLog4j");
logger.info("Just testing a log message with priority set to INFO");
logger.warn("Just testing a log message with priority set to WARN");
logger.error("Just testing a log message with priority set to ERROR");
logger.fatal("Just testing a log message with priority set to FATAL");
logger.log(Priority.WARN, "Testing a log message use a alternate form");
logger.debug(TestLog4j.class.getName());
TestLog4j2 testLog4j2 = new TestLog4j2();
  // 1
testLog4j2.testLog();
}
}
在类 TestLog4j 中我们调用了另一个类 TestLog4j2 ,下面看一下类 TestLog4j2 的代码。
4-b
package TestLog4j.TestLog4j2;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.Priority;

public class TestLog4j2 
{
static Logger logger = Logger.getLogger(TestLog4j2.class.getName());
  // 1
public TestLog4j2(){}

public void testLog()
{
//
同时输出到控制台和一个文件的实例
PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");
logger.debug("2Start of the main()");
logger.info("2Just testing a log message with priority set to INFO");
logger.warn("2Just testing a log message with priority set to WARN");
logger.error("2Just testing a log message with priority set to ERROR");
logger.fatal("2Just testing a log message with priority set to FATAL");
logger.log(Priority.DEBUG, "Testing a log message use a alternate form");
logger.debug("2End of the main()");
}
}
最后我们来看一下配置文件。
4-c
log4j2.properties
文件内容
1
#### Use two appenders, one to log to console, another to log to a file
log4j.rootLogger = debug, stdout

#2

#Print only messages of priority WARN or higher for your category
log4j.logger.TestLog4j= , R
log4j.logger.TestLog4j.TestLog4j2=WARN

#3

#### First appender writes to console
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

#4

#### Second appender writes to a file
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=F:\\nepalon\\classes\\TestLog4j\\example.log

# Control the maximum log file size

log4j.appender.R.MaxFileSize=100KB
# Archive log files (one backup file here)
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n
先看一下运行结果。
在控制台中的结果为:
DEBUG [main] (?:?) - Start of the main() in TestLog4j
INFO [main] (?:?) - Just testing a log message with priority set to INFO
WARN [main] (?:?) - Just testing a log message with priority set to WARN
ERROR [main] (?:?) - Just testing a log message with priority set to ERROR
FATAL [main] (?:?) - Just testing a log message with priority set to FATAL
WARN [main] (?:?) - Testing a log message use a alternate form
DEBUG [main] (?:?) - TestLog4j.TestLog4j
WARN [main] (?:?) - 2Just testing a log message with priority set to WARN
ERROR [main] (?:?) - 2Just testing a log message with priority set to ERROR
FATAL [main] (?:?) - 2Just testing a log message with priority set to FATAL
输出文件的结果为:
2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - Start of the main() in TestLog4j
2003-12-19 04:19:44:INFO main TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Testing a log message use a alternate form
2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - TestLog4j.TestLog4j
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to WARN
2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to ERROR

2003-12-19  04:19:44:FATAL main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to FATAL

首先,先来看一下配置文件都有些什么东西。
1) 
1 区中定义了一个根记录器。这个根记录器具有 DEBUG 级别并有一个名称为 stdout 的输出端 appender
2) 2
区中的内容是这一节的重点,也是应用到记录器层次的地方,但其实也只有两句,充分体现了 log4j 的简单性。在这里,我们定义了两个名称分别为 TestLog4j TestLog4j.TestLog4j2设计 器。
在定义 TestLog4j 记录器时没有指定级别,所以它的级别继承自它的父记录器,即要记录器,所以它的级别也为 DEBUG 。在定义 TestLog4j 记录器时又定义了一个名称为 R 的输出端,所以它的输出端有两个,一个从根记录器继承而来的名为 stdout 的输出端,另一个为在此定义的名为 R 的输出端。在此需要注意的是,在定义记录器时必须先定义记录器的级别,然后才是记录器的输出端。如果只想定义输出端而不定义级别,则虽然级别可以为空,但逗号分隔符不能省略。如定义 TestLog4j 记录器的做法。
在定义 TestLog4j.TestLog4j2 记录器时又指定了它的级别,由于一个记录器的级别只能有一个,所以新指定的级别将覆写掉它的父记录器的级别(这就象 Java 中的多态)。我们没有定义 TestLog4j.TestLog4j2 记录器的输出端,所以它的输出端将从它的父记录器中继承而来。它的父记录器为 estLog4j 记录器,所以它和 estLog4j 记录器一样具有两个名称分别为 stdout R 的输出端。
3) 
剩下的 3 区和 4 区分别设置了两个输出端的参数值。
接下来,回到我们的代码,看一下是如何取得记录器,在取记录器时又发生了什么。
1) 
4-a 中的代码( 2 )中,语句 Logger.getLogger() 中的参数 TestLog4j.class.getName() 的值为 TestLog4j. TestLog4j ,所以此语句的结果是取得一个名为 TestLog4j. TestLog4j 的记录器的对象。但在配置文件中并没有定义这样的记录器,所以最终将返回与所需的名称 TestLog4j. TestLog4j 最接近的记录器对象,即名为 TestLog4j 的记录器的对象。
2) 
4-b 中的代码( 1 )的原理与例 4-a 中的代码( 2 )相似,期望取得的是名为 TestLog4j.TestLog4j2. TestLog4j2 的记录器对象,但最终返回的是 TestLog4j.TestLog4j2 记录器的对象。

log4j与J2EE的结合


到目前为止,这篇文章讲的都是如何在 application 中应用 log4j ,而 Java 现在的应用主流是 J2EE J2ME 。现在,我们来看一下要如何在 J2EE 开发中应用 log4j 。其实在 Web application 中应用 log4j 也很简单,与在 application 中应用 log4j 不同之处就是要在所有应用 log4j 的代码之前对 log4j 进行初始化。所以,我们在 web application 中就要把 log4j 的初始化工作独立出来,把它放在 Servlet 中。下面,我们看一个例子。
5-a
进行初始化的 Servlet
import org.apache.log4j.PropertyConfigurator;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
* log4j.jar
的初始化类,参考 web.xml
*/
public class Log4jInit extends HttpServlet 
{
public void init() 
{
//
通过 web.xml 来动态取得配置文件
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("log4j-init-file");

// 
如果没有给出相应的配置文件,则不进行初始化
if(file != null) 
{
PropertyConfigurator.configure(prefix+file);
  // 1
}
}

public void doGet(HttpServletRequest req, HttpServletResponse res) 

{} 
}
下面来看一下这个 Servlet web.xml 中的定义。
5-b
<servlet>
<servlet-name>log4j-init</servlet-name>
<servlet-class>TestLog4j.Log4jInit</servlet-class>
<init-param>
<param-name>log4j-init-file</param-name>
<param-value>sort.properties</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
因为 log4j 的初始化要在所有的 log4j 调用之前完成,所以在 web.xml 文件中,我们一定要把对应的 Servlet 定义的 load-on-startup 应设为 1 ,以便在 Web 容器启动时即装入该 Servlet
完成了这两个步骤这后,我们就可以象在 application 开发中一样在 web application 任何地方应用 log4j 了。下面是在 javabean 中的应用的一个例子。
5-c
import org.apache.log4j.Logger;

public class InfoForm 
{
static Logger logger = Logger.getLogger(InfoForm.class);

protected String title;
protected String content;

public InfoForm() {}

public void setTitle(Object value) 
{
logger.debug("nepalon:title = " + title);
title = value;
}

public String getTitle() 
{
logger.debug("nepalon:title = " + title);
return title;
}

public void setContent(String value) 
{
content = value;
logger.debug("nepalon: content() = " + content);
}

public String getContent() 
{
logger.debug("nepalon: content = \n" + content);
return content;
}
}

posted on 2006-12-29 13:55 特兰克斯 阅读(280) 评论(0)  编辑  收藏 所属分类: Log

只有注册用户登录后才能发表评论。


网站导航: