Log4J是Apache的一个开放源代码项目,它是一个日志操作包。
通过使用Log4J,可以指定日志信息输出的目的地,控制每一条日志的输出格式,定义日志信息的级别。所
有这些功能通过一个配置文件灵活进行配置。
一、LOG4J组成
LOG4J主要由三大组件组成:
. Logger: 决定什么日志信息应该被输出、什么日志信息应该被忽略;
. Appender: 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备;
. Layout: 指定日志信息的输出格式;
一个Logger可以有多个Appender,也就是说日志信息可以同时输出到多个设备上,每个Appender对应
一种Layout(也就是输出的目的地就有一种格式与其对应)。
二、Logger组件分析
1. Logger组件提供的方法:
Logger组件是LOG4J的核心组件,它代表了Log4J的日志记录器,它能够对日志信息进行分类筛选。它
由org.apache.log4j.Logger类实现,提供了如下方法:
package org.apache.log4j;
public class Logger {
// Creation & retrieval methods:得到根Loagger
public static Logger getRootLogger();
//得到一般的Logger
public static Logger getLogger(String name);
// printing methods:Logger的方法
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(是以Properties文件的格式写的)
以上代码定义了一个Logger组件,名称为myLogger,日志级别为WARN。
也就是可以用myLogger调用在Logger中定义的方法,如debug(),info(),等
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(定义了一个日志级别为warn,appender是file,和console)
log4j.appender.file=org.apache.log4j.RollingFileAppender(指定这个file的输入格式)
log4j.appender.file.File=log.txt(指定File的文件)
log4j.apender.console=org.apache.log4j.ConsoleAppender(为console配制Appender)
其中,Log4j提供的appender有以下几种:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
四、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中一些指定日志
内容和格式的预定义符号说明如下:
符号 描述
%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目,通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符,Windows平台为“/r/n”,Unix平台为“/n”
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似: 2002年10月18日 22:10:28,921
%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java:10)
%m 输出信息
五、Log4J的基本用法
1. 定义配置文件
Log4J支持二种配置文件格式:XML和Java属性文件(采用“键=值”形式)。以下为Java属性文件
格式配置文件:
. 配置Logger组件
配置root Logger语法为:log4j.rootLogger=[priority(级别debug,warn,info,erro,fatal)],appenderName,appenderName,...
配置自定义Logger组件语法为:log4j.logger.loggerName=[priority],appenderName,appenderName,...
其中:priority为日志级别,可选值包括FATAL、ERROR、WARN、INFO、DEBUG、ALL;
appenderName指定Appender组件,可指定多个;
. 配置Appender组件
配置日志信息输出目的地Appender, 语法为:
log4j.appender.appenderName=fully.name.of.appender.class
log4j.appender.appenderName.option1=value1
...
log4j.appender.appenderName.optionN=valueN
Log4J提供的Appender有以下几种:
a. org.apache.log4j.ConsoleAppender(控制台);
b. org.apache.log4j.FileAppender(文件);
c. org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件);
d. org.apache.log4j.RollingFileAppender(文件大小到指定尺寸产生一个新的文件);
e. org.apache.log4j.WriteAppender(将日志信息以流格式发送到任意指定地方);
下面为一配置文件示例,文件名为log4j.properties:
##LOGGERS##
#define a logger named AdamLogger
log4j.logger.AdamLogger=All,console,file
##APPENFERS##
#define an appender named console,which is set to be a ConsoleAppender
log4j.appender.console = org.apache.log4j.ConsoleAppender
#define an appender named file,which is set to be a RollingFileAppender
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File = d:/EXAMPLE/Log/log.txt
##LAYOUTS##
# assign a SimpleLayout to console appender
log4j.appender.console.layout = org.apache.log4j.SimpleLayout
# Assign a PatternLayout to file appender
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%t %p %r %c- %m%n
2. 程序中使用Log4j
. 获得日志记录器:
获得rootLogger:Logger rootLogger=Logger.getRootLogger();
获得自定义Logger:Logger myLogger = Logger.getLogger("log4j.logger.myLogger");
. 读取日志记录器,配置Log4J环境;
a. BasicConfigurator.configure(): 自动快速地使用默认Log4J环境;
b. Property.configurator.configure(String configFilename): 读取使用Java属性(Properties)格式的配置文件并配置Log4J环境;
c. DOMConfigurator.configure(String filename): 读取XML形式的配置文件并配置LOG4J环境;
. 输出日志信息;
在程序代码中需要生成日志的地方,调用Logger的各种输出日志方法输出不同级别的日志,例如:
myLogger.debug("Thie is a log message from the " + myLogger.getName());
log4j使用步骤有3个:
3.1. 初始化
3.1.1. Tomcat下的初始化
默认的Log4j initialization典型的应用是在web-server 环境下。在tomcat3.x和tomcat4.x下,你应该将配置文件Log4j.properties放在你的web应用程序的WEB-INF/classes 目录下。
Log4j将发现属性文件,并且以此初始化。这是使它工作的最容易的方法。
你也可以选择在运行tomcat前设置系统属性Log4j.configuration 。对于tomcat 3.x,TOMCAT_OPTS 系统变量是用来设置命令行的选项。对于tomcat4.0,用系统环境变量CATALINA_OPTS 代替了TOMCAT_OPTS。
UNIX 命令行
export TOMCAT_OPTS="-DLog4j.configuration=foobar.txt"
告诉Log4j用文件foobar.txt作为默认的配置文件。这个文件应该放在WEB-INF/classes 目录下。这个文件将被PropertyConfigurator所读。每个web-application将用不同的默认配置文件,因为每个文件是和它的web-application 相关的。
1. export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml"
export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml"
告诉Log4j输出Log4j-internal的调试信息,并且用foobar.xml作为默认的配置文件。这个文件应该放在你的web-application的WEB-INF/classes 目录下。因为有.xml的扩展名,它将被DOMConfigurator所读。每个web-application将用不同的默认配置文件。因为每个文件都和它所在的web-application 相关的。
2. set TOMCAT_OPTS=-DLog4j.configuration=foobar.lcf
-DLog4j.configuratorClass=com.foo.BarConfigurator
告诉Log4j用文件foobar.lcf作为默认的配置文件。这个文件应该放在你的web-application的WEB-INF/classes 目录下。因为定义了Log4j.configuratorClass 系统属性,文件将用自定义的com.foo.barconfigurator类来解析。每个web-application将用不同的默认配置文件。因为每个文件都和它所在的web-application 相关的。
3. set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf
set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf
告诉Log4j用文件foobar.lcf作为默认的配置文件。这个配置文件用URL file:/c:/foobar.lcf定义了全路径名。这样同样的配置文件将被所有的web-application所用。
不同的web-application将通过它们自己的类装载器来装载Log4j。这样,每个Log4j的环境将独立的运作,而没有任何的相互同步。例如:在多个web-application中定义了完全相同的输出源的FileAppenders将尝试写同样的文件。结果好象是缺乏安全性的。你必须确保每个不同的web-application的Log4j配置没有用到同样的系统资源。
3.1.2. Servlet 的初始化
用一个特别的servlet来做Log4j的初始化也是可以的。如下是一个例子:
public class Log4jInit extends HttpServlet {
public void init() {
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("Log4j-init-file");
if(file != null) {
PropertyConfigurator.configure(prefix+file);
}
}
public void doGet(HttpServletRequest req, HttpServletResponse res) {
}
}
在web.xml中定义随后的servlet为你的web-application。
<servlet>
<servlet-name>Log4j-init</servlet-name>
<servlet-class>xx.xx.Log4jInit</servlet-class>
<init-param>
<param-name>Log4j-init-file</param-name>
<param-value>WEB-INF/classes/Log4j.properties</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
写一个初始化的servlet是最有弹性的初始化Log4j的方法。代码中没有任何限制,你可以在servlet的init方法中定义它。
3.2. 根据配置文件初始化log4j
log4j可以使用3中配置器来初始化:BasicConfigurator,DOMConfigurator,PropertyConfigurator
其语法为:
BasicConfigurator.configure (): 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) :读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) :读取XML形式的配置文件。
这里用的是PropertyConfigurator。使用PropertyConfigurator适用于所有的系统。如下的语句:
PropertyConfigurator.configure("log4j.properties");
就以log4j.properties为配置文件初始化好了log4j环境。
注意一点:这个语句只需要在系统启动的时候执行一次。例如,在ActionServlet的init()方法中调用一次。
public class ActionServlet extends HttpServlet{
...
/**
* Initialize global variables
*/
public void init() throws ServletException {
// 初始化Action资源
try{
initLog4j();
...
}catch(IOException e){
throw new ServletException("Load ActionRes is Error");
}
}
...
protected void initLog4j(){
PropertyConfigurator.configure("log4j.properties");
}
...
}//end class ActionServlet
3.3. 在需要使用log4j的地方获取Logger实例
使用Log4j,首先就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:
public static Logger getLogger( String name),
通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。Name一般取本类的名字,比如:
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;
Log4j使得通过软件组件命名logger很容易。我们可以通过Logger的静态的初始化方法在每一个类里定义一个logger,令logger的名字等于类名的全局名,而实现logger的命名。这是一个实效的简单的定义一个logger的方法。因为日志输出带有产生日志的类的名字,这个命名策略使得我们更容易定位到一个日志信息的来源。虽然普通,但却是命名logger的常用策略之一。
Log4j没有限制定义logger的可能。开发员可以自由的按照它们的意愿定义logger的名称。
然而,以类的所在位置来命名Logger好象是目前已知的最好方法。
3.4. 使用Logger对象的debug,info,fatal...方法
log.debug("it is the debug info");
第4章. 优化
一个经常引用的依靠于logging的参数是可以计算的花费。这是一个合理的概念,一个适度的应用程序可能产生成千上万个日志请求。许多努力花在测量和调试logging的优化上。Log4j要求快速和弹性:速度最重要,弹性是其次。
4.1. 日志为禁用时,日志的优化。
当日志被彻底的关闭,一个日志请求的花费等于一个方法的调用加上整数的比较时间。在233mhz的Pentium II 机器上这个花费通常在5-50纳秒之间。
然而,方法调用包括参数构建的隐藏花费。
例如,对于logger cat,logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
引起了构建信息参数的花费,例如,转化整数i和entry[i]到一个string,并且连接中间字符串,不管信息是否被输出。这个参数的构建花费可能是很高,它主要决定于被调用的参数的大小。
避免参数构建的花费应如下,
if(logger.isDebugEnabled())
{
logger.debug("result is" + result );
}
如果logger的debug被关闭这将不会招致参数构建的花费。另一方面,如果logger是debug的话,它将产生两次判断 logger是否能用的花费。一次是在debugenabled,一次是debug。这是无关紧要的,因为判断日志的能用 只占日志实际花费时间的约1%。
在Log4j里,日志请求在Logger 类的实例里。Logger 是一个类,而不是一个接口。这大量的减少了在方法调用上的弹性化的花费。
当然用户采用预处理或编译时间技术去编译出所有的日志声明。这将导致完美的执行成效。然而因为二进制应用程序不包括任何的日志声明的结果,日志不可能对那个二进制程序开启。以我的观点,以这种较大的代价来换取较小的性能优化是不值得的。
4.2. 当日志状态为启用时,日志的优化。
这是本质上的优化logger的层次。当日志状态为开,Log4j依然需要比较请求的级别与logger的级别。然而, logger可能没有被安排一个级别;它们将从它们的father继承。这样,在继承之前,logger可能需要搜索它的ancestor。
这里有一个认真的努力使层次的搜索尽可能的快。例如,子logger仅仅连接到它的存在的father logger。
在先前展示的BasicConfigurator 例子中,名为com.foo.bar 的logger是连接到跟根logger,因此绕过 了不存在的logger com和com.foo。这将显著的改善执行的速度,特别是解析logger的层结构时。
典型的层次结构的解析的花费是logger彻底关闭时的三倍。
4.3. 日志信息的输出时,日志的优化。
这是主要花费在日志输出的格式化和发送它到它的输出源上。这里我们再一次的付出努力以使格式化执行的尽可能快。同appender一样。实际上典型的花费大约是100-300毫秒。
详情看org.apache.log4.performance.Logging。
虽然Log4j有许多特点,但是它的第一个设计目标还是速度。一些Log4j的组件已经被重写过很多次以改善性能。不过,投稿者经常提出了新的优化。你应该满意的知道,以SimpleLayout的配置执行测试已经展示了Log4j的输出同System.out.println一样快。