欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

基于java配置log4j日志详解

程序员文章站 2022-07-02 13:04:58
1.Log4j 1.1了解Log4j Log4j是Apache的一个开源项目,通过使用log4j,我们可以控制日志信息输送的目的地可以是控制台、文件、GUI组件,我们也可以控制每一条日志的输出格式,通过定义每一条日志信息的级别,我们能够更加细致的控制日志的生成过程。 1.2配置Log4j步骤(jav ......

1.log4j

1.1了解log4j

log4j是apache的一个开源项目,通过使用log4j,我们可以控制日志信息输送的目的地可以是控制台、文件、gui组件,我们也可以控制每一条日志的输出格式,通过定义每一条日志信息的级别,我们能够更加细致的控制日志的生成过程。

1.2配置log4j步骤(java项目)

在java程序中配置log4j日志共分为4步:

1.第一步

加入log4j-1.2.8.jar(可以选择log4j的更高版本)到lib下。

如果使用maven项目,也可以选择在pom.xml中新增依赖:

<!-- 加入log4j支持 -->

<dependency>

<groupid>log4j</groupid>

<artifactid>log4j</artifactid>

<version>1.2.17</version>

</dependency>

2.第二步

在classpath下建立log4j.prope相应的修改其中属性,修改之前就必须知道这些都是干log4j.rootlogger=info,stdout,r

#setting
#logger
log4j.rootlogger=debug,stdout
#appender
log4j.appender.stdout=org.apache.log4j.consoleappender
log4j.appender.stdout.append = true

#过滤(不记录)info级别以下的消息
log4j.appender.stdout.threshold = info
#layout
log4j.appender.stdout.layout=org.apache.log4j.patternlayout
#conversion
log4j.appender.stdout.layout.conversionpattern=[%p] %d{yyyy-mm-dd hh\:mm\:ss,sss} method\:%l%n%m%n

 消息级别:all<debug<info<warn<error<fatal<off

4.第四步

在要输出日志的类中加入相关语句:

定义属性:static logger logger = logger.getlogger(logdemo.class); //logdemo为相关的类

在相应的方法中:

if (logger.isdebugenabled()){

logger.debug("system …..");

}

1.3配置说明

以下是配置文件log4j.properties的配置说明。

1、log4j.rootcategory=info, stdout , r

此句为将等级为info的日志信息输出到stdout和r这两个目的地,stdout和r的定义在下面的代码,可以任意起名。等级可分为off、fatal、error、warn、info、debug、all,如果配置off则不打出任何信息,如果配置为info这样只显示info、warn、error的log信息,而debug信息不会被显示,具体讲解可参照第三部分定义配置文件中的logger。

2、log4j.appender.stdout=org.apache.log4j.consoleappender

此句为定义名为的输出端是哪种类型,可以是

org.apache.log4j.consoleappender(控制台),

org.apache.log4j.fileappender(文件),

org.apache.log4j.dailyrollingfileappender(每天产生一个日志文件),

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

org.apache.log4j.writerappender(将日志信息以流格式发送到任意指定的地方)

具体讲解可参照第三部分定义配置文件中的appender。

3、log4j.appender.stdout.layout=org.apache.log4j.patternlayout

此句为定义名为stdout的输出端的layout是哪种类型,可以是

org.apache.log4j.htmllayout(以html表格形式布局),

org.apache.log4j.patternlayout(可以灵活地指定布局模式),

org.apache.log4j.simplelayout(包含日志信息的级别和信息),

org.apache.log4j.ttcclayout(包含日志产生的时间、、类别等等信息)

具体讲解可参照第三部分定义配置文件中的layout。

4、log4j.appender.stdout.layout.conversionpattern= [qc] %p [%t] %c.%m(%l) | %m%n

如果使用pattern布局就要指定的打印信息的具体格式conversionpattern,打印参数如下:

%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 输出日志事件的发生位置,及在代码中的行数;

[qc]是log信息的开头,可以为任意字符,一般为项目简称。

输出的信息

[ts] debug [main] abstractbeanfactory.getbean(189) | returning cached instance of singleton bean 'myautoproxy'

具体讲解可参照第三部分定义配置文件中的格式化日志信息。

5、log4j.appender.r=org.apache.log4j.dailyrollingfileappender

此句与第3行一样。定义名为r的输出端的类型为每天产生一个日志文件。

6、log4j.appender.r.file=d:\\tomcat 5.5\\logs\\qc.log

此句为定义名为r的输出端的文件名为d:\\tomcat 5.5\\logs\\qc.log可以自行修改。

7、log4j.appender.r.layout=org.apache.log4j.patternlayout

与第4行相同。

8、log4j.appender.r.layout.conversionpattern=%d-[ts] %p %t %c - %m%n

与第5行相同。

9、log4j.logger.com. neusoft =debug

指定com.neusoft包下的所有类的等级为debug。

可以把com.neusoft改为自己项目所用的包名。

10、log4j.logger.com.opensymphony.oscache=error

11、log4j.logger.net.sf.navigator=error

这两句是把这两个包下出现的错误的等级设为error,如果项目中没有配置ehcache,则不需要这两句。

12、log4j.logger.org.apache.commons=error

13、log4j.logger.org.apache.struts=warn

这两句是struts的包。

14、log4j.logger.org.displaytag=error

这句是displaytag的包。(qc问题列表页面所用)

15、log4j.logger.org.springframework=debug

此句为spring的包。

16、log4j.logger.org.hibernate.ps.preparedstatementcache=warn

17、log4j.logger.org.hibernate=debug

此两句是hibernate的包。

以上这些包的设置可根据项目的实际情况而自行定制。

1.4配置文件详解

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

1.5格式化日志

当log4j.applender.appendlername=org.apache.log4j.patternlayout时,那么表示想要自定义输出格式,因此需要设置log4j.appender.stdout.layout.conversionpattern。

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.6定义及获取不同层次的记录器

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

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()函数。

1.7基于java web项目配置log4j

到目前为止,这篇文章讲的都是如何在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了。