日志是应用软件中不可缺少的部分,Apache的开源项目Log4j是一个功能强大的日志组件,提供方便的日志记录。以下是个人经验,具体请参考Log4j文档指南。
Log4j下载
在apache网站:http://logging.apache.org/log4j/1.2/download.html 可以免费下载到Log4j最新版本的软件包。
Log4j使用
Log4j的包下载完成后,解压,将其中打包好的的log4j-1.x.x.jar导入你的工程lib中。
Log4j之所以受欢迎的原因之一是它的灵活性。Log4j提供了灵活的配置方法,默认是调用BasicConfigurator.configure()来进行配置,但如果只是简单的调用BasicConfigurator.configure()来进行配置工作,那么所有的配置都是固定的,不方便以后修改配置。另一种是动态配置,Log4j提供了PropertyConfigurator.configure(……)来动态配置,参数可以是一个properties文件所在路径的String对象,可以是一个properties文件所在路径的URL对象,也可以是一个properties对象。如果要用XML文件来配置信息,则可用类型的DOMConfigurator()函数来从一个XML文件中加载配置信息。这种方式更方便修改配置。动态配置例子如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
package
http
;
import
org
.
apache
.
log4j
.
BasicConfigurator
;
import
org
.
apache
.
log4j
.
Logger
;
import
org
.
apache
.
log4j
.
PropertyConfigurator
;
import
org
.
apache
.
log4j
.
xml
.
DOMConfigurator
;
public
class
Log4jDemo
{
static
Logger
log
=
Logger
.
getLogger
(
Log4jDemo
.
class
.
getClass
(
)
)
;
public
static
void
main
(
String
[
]
args
)
{
BasicConfigurator
.
configure
(
)
;
//默认配置
PropertyConfigurator
.
configure
(
"c:/log4j.properties"
)
;
//动态配置,参数可以是一个properties文件所在路径的String对象
//可以是一个properties文件所在路径的URL对象,也可以是一个properties对象
DOMConfigurator
.
configure
(
"c:/log4j.xml"
)
;
//XML配置文件
//PropertyConfigurator.configure()的参数还可以是XML、Properties对象
//下面就可使用log4j
log
.
info
(
"info"
)
;
log
.
debug
(
"debug"
)
;
log
.
error
(
"error"
)
;
log
.
warn
(
"warn"
)
;
}
}
|
J2EE应用log4j
在J2EE应用使用Log4j,必须先在启动服务时加载Log4j的配置文件进行初始化,可以在web.xml中进行。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
import
java
.
io
.
IOException
;
import
java
.
io
.
PrintWriter
;
import
javax
.
servlet
.
ServletException
;
import
javax
.
servlet
.
http
.
HttpServlet
;
import
javax
.
servlet
.
http
.
HttpServletRequest
;
import
javax
.
servlet
.
http
.
HttpServletResponse
;
public
class
J2eeLog4jDemo
extends
HttpServlet
{
public
void
destroy
(
)
{
super
.
destroy
(
)
;
}
public
void
doGet
(
HttpServletRequest
request
,
HttpServletResponse
response
)
throws
ServletException
,
IOException
{
}
public
void
doPost
(
HttpServletRequest
request
,
HttpServletResponse
response
)
throws
ServletException
,
IOException
{
}
public
void
init
(
)
throws
ServletException
{
//通过web.xml来动态取得配置文件
String
prefix
=
getServletContext
(
)
.
getRealPath
(
"/"
)
;
String
file
=
getInitParameter
(
"log4j"
)
;
//如果没有给出相应的配置文件,则不进行初始化
if
(
file
!=
null
)
{
PropertyConfigurator
.
configure
(
prefix
+
file
)
;
}
}
}
|
Web.xml 代码
|
<
servlet
>
<
servlet
-
name
>
j2eelog4jdemo
<
servlet
-
name
>
<
servlet
-
class
>
J2eeLog4jDemo
<
servlet
-
class
>
<
init
-
param
>
<
param
-
name
>
log4j
<
param
-
name
>
<
param
-
value
>
log4j
.
properties
<
param
-
value
>
<
/
init
-
param
>
<
load
-
on
-
startup
>
1
<
load
-
on
-
startup
>
//设为1时,Web容器启动即进行加载
<
/
servlet
>
|
Spring配置Log4j
Spring中配置Log4j只要配置applicationContext.xml文件,Log4j的配置文件放在Web工程的根目录下,默认是objectname/root下,可以在web.xml中设置工程根目录。
web.xml 代码
|
<
context
-
param
>
<
param
-
name
>
webAppRootKey
<
param
-
name
>
<
param
-
value
>
webapp
.
root
<
param
-
value
>
<
/
context
-
param
>
|
配置applicationContext.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<
context
-
param
>
<
param
-
name
>
log4jConfigLocation
<
param
-
name
>
<
param
-
value
>
/
WEB
-
INF
/
log4j
.
properties
<
param
-
value
>
<
/
context
-
param
>
<
context
-
param
>
<
param
-
name
>
log4jRefreshInterval
<
param
-
name
>
<
param
-
value
>
60000
<
param
-
value
>
<
/
context
-
param
>
<
listener
>
<
listener
-
class
>
org
.
springframework
.
web
.
util
.
Log4jConfigListener
<
listener
-
class
>
<
/
listener
>
|
Spring提供了一个Log4jConfigListener,本身就能通过web.xml中配置来指定位置加载log4j配置文件和log输出路径,注意该listener需要放在spring的Listener之前。使用Spring中的Log4jConfigListener有如如下好处:
1. 动态的改变记录级别和策略,不需要重启Web应用。
2. 把log文件定在/WEB-INF/logs/而不需要写绝对路径。 因为系统把web目录的路径压入一个叫webapp.root的系统变量。这样写log文件路径时不用写绝对路径了。log4j.appender.logfile.File=${webapp.root}/WEB-INF/logs/myfuse.log。
3.可以把log4j.properties和其他properties一起放在/WEB-INF/ ,而不是Class-Path。
4.log4jRefreshInterval为6000表示 开一条watchdog线程每6秒扫描一下配置文件的变化。
同时使用commons-logging和Log4j
(1)首先在classpath下寻找自己的配置文件commons-logging.properties,如果找到,则使用其中定义的Log实现类
(2)如果找不到commons-logging.properties文件,则在查找是否已定义系统环境变量org.apache.commons.logging.Log,找到则使用其定义的Log实现类
(3)否则,查看classpath中是否有Log4j的包,如果发现,则自动使用Log4j作为日志实现类
(4)否则,使用JDK自身的日志实现类(JDK1.4以后才有日志实现类)
(5)否则,使用commons-logging自己提供的一个简单的日志实现类SimpleLog
将commons-logging和Log4j的jar包都放置到classpath下,同时也将Log4j的配置文件放到classpath中,两者就可以很好的合作,实现如下:
1
2
3
4
5
6
7
8
9
10
11
12
|
package
com
.
doctorcom
.
model
;
import
org
.
apache
.
commons
.
logging
.
Log
;
public
class
LogFactorySupport
{
public
Log
getLog
(
)
{
Log
log
=
org
.
apache
.
commons
.
logging
.
LogFactory
.
getLog
(
LogFactorySupport
.
class
)
;
log
.
info
(
""
)
;
log
.
debug
(
""
)
;
}
}
|
Log4j配置内容
Log4j配置内容主要是依据配置文件log4j.properties:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
#指定根Logger,及日志输出级别
#大于等于该级别的日志将被输出( DEBUG < INFO < WARN < ERROR < FATAL ),设为OFF可以关闭日志
log4j
.
rootLogger
=
DEBUG
,
A1
,
A2
#指定log输出目的,这里设为输出日志到指定目录的文件my.log中
log4j
.
appender
.
A1
=
org
.
apache
.
log4j
.
FileAppender
log4j
.
appender
.
A1
.
File
=
\
\
logs
\
\
my
.
log
#当前根目录下
#指定日志信息的格式
log4j
.
appender
.
A1
.
layout
=
org
.
apache
.
log4j
.
PatternLayout
log4j
.
appender
.
A1
.
layout
.
ConversionPattern
=
%
r
%
d
{
yyyy
-
MM
-
dd
HH
:
mm
:
ss
}
%
c
%
p
-
%
m
%
n
#把A2输出到控制台
log4j
.
appender
.
A2
=
org
.
apache
.
log4j
.
ConsoleAppender
log4j
.
appender
.
A2
.
layout
=
org
.
apache
.
log4j
.
SimpleLayout
#还可以单独指定输出某个包的日志级别
#log4j.logger.com.study.HelloLog4j=INFO
|
1、配置根Logger,其语法为: log4j.rootLogger = [ level ] , appenderName, appenderName2
level:日志的级别,指定这条日志信息的重要性。分为ALL < DEBUG < INFO < WARN < ERROR < FATAL。一般常用的为 DEBUG , INFO ,WARN ,ERROR四种,分别对应Logger类的四种方法
debug(Object message ) ;
info(Object message ) ;
warn(Object message ) ;
error(Object message ) ;
如果设置级别为INFO,则优先级大于等于INFO级别(如:INFO、WARN、ERROR)的日志信息将可以被输出,小于该级别的如:DEBUG将不会被输出
appenderName :就是指定日志信息输出目的地,比如(打印到控制台,输出到文件等)。同一条日志信息可以配置多个输出目的地。
2、配置log输出目的地
Log4j提供以下几种:
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
3、log信息的格式
org.apache.log4j.HTMLLayout(HTML表格形式)
org.apache.log4j.SimpleLayout(简单格式的日志,只包括日志信息的级别和指定的信息字符串 ,如:DEBUG - Hello)
org.apache.log4j.TTCCLayout(日志的格式包括日志产生的时间、线程、类别等等信息)
org.apache.log4j.PatternLayout(灵活地自定义日志格式)
当使用org.apache.log4j.PatternLayout来自定义信息格式时,可以使用
log4j.appender.A1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %p -%m%n 来格式化信息
%c 输出所属类的全名,可写为 %c{Num} ,Num类名输出的范围 如:"com.sun.aaa.classB", %C{2}将使日志输出输出范围为:aaa.classB
%d 输出日志时间其格式为 可指定格式 如 %d{HH:mm:ss}等
%l 输出日志事件发生位置,包括类目名、发生线程,在代码中的行数
%n 换行符
%m 输出代码指定信息,如info(“message”),输出message
%p 输出日志的优先级,即 FATAL ,ERROR 等
%r 输出从启动到显示该条日志信息所耗费的时间(毫秒数)
%t 输出产生该日志事件的线程名
更详细参数信息可参看类org.apache.log4j.PatternLayout的API doc文档