1.1
准备工作
一。
Tomcat
已正确配置与使用。
二。软件下载:
log4j------http://www.apache.org/dist/jakarta/log4j/jakarta-log4j-1.2.8.zip
1.2. Log4j
简介
在强调可重用组件开发的今天,除了自己从头到尾开发一个可重用的日志操作类外,
Apache
为我们提供了一个强有力的日志操作包
-Log4j
。
Log4j
是
Apache
的一个开放源代码项目,通过使用
Log4j
,我们可以控制日志信息输送的目的地是控制台、文件、
GUI
组件、甚至是套接口服务器、
NT
的事件记录器、
UNIX Syslog
守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。
此外,通过
Log4j
其他语言接口,您可以在
C
、
C++
、
.Net
、
PL/SQL
程序中使用
Log4j
,其语法和用法与在
Java
程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块。而且,通过使用各种第三方扩展,您可以很方便地将
Log4j
集成到
J2EE
、
JINI
甚至是
SNMP
应用中。本文介绍的
Log4j
版本是
1.2.8
,怎样通过一个配置文件来灵活地进行配置,主要的应用平台是
Tomcat4.
1.3
。
Log4j
的配置。
首先到
jakarta
下载一个
log4j
的组件。把
jakarta-log4j-1.2.8\dist\lib
下的
log4j-1.2.8.jar
文件
copy
到
classpath
指定的目录下!可以是
Tomcat
的
common\lib
目录下,也可以是你需要用到
log4j
的
application
下的
lib
目录。
1.4
在
Application
目录下的
web.xml
文件加入以后代码
log4j
com.apache.jakarta.log4j.Log4jInit
log4j
/WEB-INF/log4j.properties
1
这段代码的意思是说,在
Tomcat
启动时加载
com.apache.jakarta.log4j.Log4jInit
这个名叫
Log4jInit.class
这个类文件。其中
Log4jInit.class
的源代码如下
package com.apache.jakarta.log4j;
import org.apache.log4j.PropertyConfigurator;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class Log4jInit extends HttpServlet {
public void init() {
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("log4j");
// if the log4j-init-file is not set, then no point in trying
System.out.println("................log4j start");
if(file != null) {
PropertyConfigurator.configure(prefix+file);
}
}
public void doGet(HttpServletRequest req, HttpServletResponse res) {
}
}
这段代码很简单,可以看出,在加载的过程中,程序会读取
/WEB-INF/log4j.properties
这个文件
这个文件就是本文的重点,也就是
log4j
的配置文件。
# Set root logger level to DEBUG and its only appender to A1
#log4j
中有五级
logger
#FATAL 0
#ERROR 3
#WARN 4
#INFO 6
#DEBUG 7
#
配置根
Logger
,其语法为:
#log4j.rootLogger = [ level ] , appenderName, appenderName, …
log4j.rootLogger=INFO, A1 ,R
#
这一句设置以为着所有的
log
都输出
#
如果为
log4j.rootLogger=WARN,
则意味着只有
WARN,ERROR,FATAL
#
被输出,
DEBUG,INFO
将被屏蔽掉
.
# A1 is set to be a ConsoleAppender.
#log4j
中
Appender
有几层如控制台、文件、
GUI
组件、甚至是套接口服务器、
NT
的事件记录器、
UNIX Syslog
守护进程等
#ConsoleAppender
输出到控制台
log4j.appender.A1=org.apache.log4j.ConsoleAppender
# A1
使用的输出布局,其中
log4j
提供
4
种布局
. org.apache.log4j.HTMLLayout
(以
HTML
表格形式布局)
#org.apache.log4j.PatternLayout
(可以灵活地指定布局模式),
#org.apache.log4j.SimpleLayout
(包含日志信息的级别和信息字符串),
#org.apache.log4j.TTCCLayout
(包含日志产生的时间、线程、类别等等信息)
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
#
灵活定义输出格式
具体查看
log4j javadoc org.apache.log4j.PatternLayout
#d
时间
....
log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
#R
输出到文件
RollingFileAppender
的扩展,可以提供一种日志的备份功能。
log4j.appender.R=org.apache.log4j.RollingFileAppender
#
日志文件的名称
log4j.appender.R.File=log4j.log
#
日志文件的大小
log4j.appender.R.MaxFileSize=100KB
#
保存一个备份文件
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.TTCCLayout
#log4j.appender.R.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
配置以这里就差不多了,如果你想更深入了解配置文件的各个细节,可以去查看
docs
。还有,在文章的最后面我们提供配置文件中一些主要的语法。下面我们来看看怎样在程序中使用
log4j.
1.4
Log4j
的使用。
使用
Log4j
,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:
public static Logger getLogger( String name)
,
必须在使用前要把这个类导入
import org.apache.log4j.Logger;
name
一般是类文件的名字,如下:
static Logger logger = Logger.getLogger ("".class.getName () ) ;
您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方,其语法如下:
logger.debug ( Object message ) ;
logger.info ( Object message ) ;
logger.warn ( Object message ) ;
logger.error ( Object message ) ;
为什么这里要分级别的呢?试想一下,我们在写程序的时候,为了调试程序,会在很多会出错的地方加入大量的
logger.info();
信息。当然程序调试完毕,我们不需要这些输出信息了,那怎么办呢?以前的做法是把每个程序中的
logger.info
删除,但这是不现实的,如果程序不大还可以,但如果程序很多,做这些事情就很烦人了。但因为
log4j
分级别了,当我们不需要输出这样调试时用到的
log.info()
时,我们可以把输出的级别调高,如调到
warn,
或
error
级别,这样
info
级别及以下的级别就不会出输出了,是不是很方便的呢?
其实除了这种使用方式,
log4j
还有其它的使用方面,不需要配置文件,直接在程序中定义输入出级别,层次等信息,如果要了解这方法的使用,可以参考文档。
1.5
。附注:
以下是配置文件的一些重要的语法
定义配置文件
其实您也可以完全不使用配置文件,而是在代码中配置
Log4j
环境。但是,使用配置文件将使您的应用程序更加灵活。
Log4j
支持两种配置文件格式,一种是
XML
格式的文件,一种是
Java
特性文件(键
=
值)。下面我们介绍使用
Java
特性文件做为配置文件的方法:
配置根
Logger
,其语法为:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,
level
是日志记录的优先级,分为
OFF
、
FATAL
、
ERROR
、
WARN
、
INFO
、
DEBUG
、
ALL
或者您定义的级别。
Log4j
建议只使用四个级别,优先级从高到低分别是
ERROR
、
WARN
、
INFO
、
DEBUG
。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了
INFO
级别,则应用程序中所有
DEBUG
级别的日志信息将不被打印出来。
appenderName
就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
配置日志信息输出目的地
Appender
,其语法为
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN
其中,
Log4j
提供的
appender
有以下几种:
org.apache.log4j.ConsoleAppender
(控制台),
org.apache.log4j.FileAppender
(文件),
org.apache.log4j.DailyRollingFileAppender
(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender
(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender
(将日志信息以流格式发送到任意指定的地方)
配置日志信息的格式(布局),其语法为:
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
其中,
Log4j
提供的
layout
有以下几种:
org.apache.log4j.HTMLLayout
(以
HTML
表格形式布局),
org.apache.log4j.PatternLayout
(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout
(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout
(包含日志产生的时间、线程、类别等等信息)