log4j使用

发布日期：2010-1-20 10:39:01

log4j介绍

一、前言：

Log4J是Apache的一个开放源代码项目(http://logging.apache.org/log4j/docs/)，它是一个日志操作包。通过使用Log4J,可以指定日志信息输出的目的地，控制每一条日志的输出格式，定义日志信息的级别。所有这些功能通过一个配置文件灵活进行配置。

一、LOG4J组成

LOG4J主要由三大组件组成：

. Logger: 决定什么日志信息应该被输出、什么日志信息应该被忽略；

. Appender: 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备；

. Layout: 指定日志信息的输出格式；

一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应

一种Layout(示例见下图)。

↗ Appender1 → Layout

／

Logger

﹨

↘ Appender2 → Layout

二、主要组件

1、根类别（在类别层次结构的顶部，即全局性的日志级别）

配置根Logger，其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, ...

level 是日志记录的类别

appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

类别level 为 OFF、FATAL、ERROR、WARN、INFO、DEBUG、log、ALL或自定义的优先级。

log4j常用的优先级FATAL>ERROR>WARN>INFO>DEBUG

如果为log4j.rootLogger=WARN，则意味着只有WARN,ERROR,FATAL被输出，DEBUG,INFO将被屏蔽掉。

举例：log4j.rootCategory=INFO,stdout,Runlog,Errorlog

根日志类别为INFO，DEBUG将被屏蔽，其他的将被输出。 stdout,Runlog,Errorlog分别为3个输出目的地。

2、常用输出格式

-X号:X信息输出时左对齐；

%p:日志信息级别

%d{}:日志信息产生时间

%c:日志信息所在地（类名）

%m:产生的日志具体信息

%n:输出日志信息换行

举例：

log4j.appender.stdout.layout.ConversionPattern= %5p %d{yyyy-MM-dd HH:mm:ss} %c %m %n

log4j.appender.Runlog.layout.ConversionPattern= %5p %d{yyyy-MM-dd HH:mm:ss} %c %m %n

log4j.appender.Errorlog.layout.ConversionPattern= %5p %d{yyyy-MM-dd HH:mm:ss} %c %m %n

3、布局

使用的输出布局，其中log4j提供4种布局：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

举例：

输出格式为HTML表格

log4j.appender.stdout.layout=org.apache.log4j.HTMLLayout

输出格式为可以灵活地指定布局模式

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

输出格式为包含日志信息的级别和信息字符串

log4j.appender.stdout.layout=org.apache.log4j.SimpleLayout

输出格式为包含日志产生的时间、线程、类别等等信息

log4j.appender.stdout.layout=org.apache.log4j.TTCCLayout

4、目的地

配置日志信息输出目的地Appender，其语法为

log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

...

log4j.appender.appenderName.option = valueN

appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

log4j支持的输出目的地：

org.apache.log4j.ConsoleAppender 控制台

org.apache.log4j.FileAppender 文件

org.apache.log4j.DailyRollingFileAppender 每天产生一个日志文件

org.apache.log4j.RollingFileAppender （文件大小到达指定尺寸的时候产生一个新的文件），

org.apache.log4j.WriterAppender （将日志信息以流格式发送到任意指定的地方）

org.apache.log4j.net.SMTPAppender 邮件

org.apache.log4j.jdbc.JDBCAppender 数据库

其他如：GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等

举例：

输出到控制台

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender（指定输出到控制台）

log4j.appender.Threshold=DEBUG（指定输出类别）

log4j.appender.CONSOLE.Target=System.out

log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout（指定输出布局）

log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n（指定输出格式）

输出到文件

log4j.appender.FILE=org.apache.log4j.FileAppender（指定输出到文件）

log4j.appender.FILE.File=file.log（指定输出的路径及文件名）

log4j.appender.FILE.Append=false

log4j.appender.FILE.layout=org.apache.log4j.PatternLayout（指定输出的布局）

log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n（指定输出的格式）

输出到文件（轮换"日志文件",当日志文件达到指定大小时，该文件就被关闭并备份，然后创建一个新的日志文件）

log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender（指定输出到文件）

log4j.appender.ROLLING_FILE.Threshold=ERROR（指定输出类别）

log4j.appender.ROLLING_FILE.File=rolling.log（指定输出的路径及文件名）

log4j.appender.ROLLING_FILE.Append=true

log4j.appender.ROLLING_FILE.MaxFileSize=10KB（指定输出到文件的大小）

log4j.appender.ROLLING_FILE.MaxBackupIndex=1

log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout（指定采用输出布局）

log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n（指定采用输出格式）

输出到Socket

log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender（指定输出到Socket）

log4j.appender.SOCKET.RemoteHost=localhost（远程主机）

log4j.appender.SOCKET.Port=5001（远程主机端口）

log4j.appender.SOCKET.LocationInfo=true

log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout（布局）

log4j.appender.SOCET.layout.ConversionPattern =[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n %m[MESSAGE]%n%n（输出格式）

输出到邮件

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender（指定输出到邮件）

log4j.appender.MAIL.Threshold=FATAL

log4j.appender.MAIL.BufferSize=10

log4j.appender.MAIL.From=chenyl@hollycrm.com（发件人）

log4j.appender.MAIL.SMTPHost=mail.hollycrm.com（SMTP服务器）

log4j.appender.MAIL.Subject=Log4J Message

log4j.appender.MAIL.To=chenyl@hollycrm.com（收件人）

log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout（布局）

log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n（格式）

输出到数据库

log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender（指定输出到数据库）

log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test（指定数据库URL）

log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver（指定数据库driver）

log4j.appender.DATABASE.user=root（指定数据库用户）

log4j.appender.DATABASE.password=root（指定数据库用户密码）

log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')（组织SQL语句）

log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout（布局）

log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n（格式）

5、日志类别补充

有时我们需要对某个特定的部分指定有别于根类别的日志类别，可以指定某个包的优先级

如：

log4j.category.com.neusoft.mbip.dm.util=ERROR ，其中com.neusoft.mbip.dm.util为我们需要特别指定日志类别的部分。

或者可以指定输出文件的优先级

log4j.appender.Errorlog.Threshold=ERROR

三、常用log4j配置

常用log4j配置，一般可以采用两种方式，.properties和.xml,下面举两个简单的例子：

.log4j.properties

log4j.rootLogger=ERROR,ErrorFile

log4j.logger.com.mds.sojourner.log = INFO,CONSOLE

log4j.logger.com.mds.sojourner.write = Debug,LOG,MemFile

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

log4j.appender.Threshold=DEBUG

log4j.appender.CONSOLE.Target=System.out

log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

log4j.appender.CONSOLE.layout.ConversionPattern=%d - %m%n

log4j.appender.LOG = org.apache.log4j.DailyRollingFileAppender

log4j.appender.LOG.Threshold=INFO

log4j.appender.LOG.File=../data/imp

log4j.appender.LOG.DatePattern='_'yyyyMMdd_HH'.log'

log4j.appender.LOG.layout=org.apache.log4j.PatternLayout

log4j.appender.LOG.layout.ConversionPattern=%m%n

log4j.appender.ErrorFile=org.apache.log4j.RollingFileAppender

log4j.appender.ErrorFile.Threshold=ERROR

log4j.appender.ErrorFile.File=mds_sojourner_log.log

log4j.appender.ErrorFile.MaxFileSize=10MB

log4j.appender.ErrorFile.MaxBackupIndex=10

log4j.appender.ErrorFile.layout=org.apache.log4j.PatternLayout

log4j.appender.ErrorFile.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n

log4j.appender.MemFile=org.apache.log4j.RollingFileAppender

log4j.appender.MemFile.Threshold=DEBUG

log4j.appender.MemFile.File=mds_memStatus.log

log4j.appender.MemFile.MaxFileSize=10MB

log4j.appender.MemFile.MaxBackupIndex=1

log4j.appender.MemFile.layout=org.apache.log4j.PatternLayout

log4j.appender.MemFile.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n

log4j.xml

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

</layout>

</appender>

</layout>

</appender>

</logger>

</logger>

<root>

<appender-ref ref="console" />

<appender-ref ref="file" />

</root>

</log4j:configuration>

- log4j - isDebugEnabled()

log4j进阶

log4j - isDebugEnabled() 仅仅是为了效率

if (log.isDebugEnabled()) {

......

log.debug(XXX);

}

如上所示，开发时，突然被要求先判断log的级别后再进行log输出，说是为了效率。有点纳闷：log4j不是可以自动判断log的级别并进行相应的输出么？为何还要在在自己的代码里进行判断呢？

网上搜了下，恍然大悟，请看以下示例：

StringBuffer strBuf = new StringBuilder();

strBuf.append("name : ");

strBuf.append(userObj.getName());

......

log.debug(strBuf.toString());

应该明白了吧，如果事先就判断log级别的话，从StringBuffer的对象创建一直到log的输出都是没有必要的代码。所以，这样就提高代码的效率了。

当然拉，如果log仅仅是输出一个简单的基本数据类型的话，效率问题可以忽略。但是，为了简单，还是一律＋上的好！

程序动态修改配置文件

例子如下：

配置文件片段：

log4j.rootLogger=debug,ErrorFile

log4j.appender.ErrorFile=org.apache.log4j.RollingFileAppender

log4j.appender.ErrorFile.Threshold=debug

log4j.appender.ErrorFile.File=error.log

log4j.appender.ErrorFile.MaxFileSize=10MB

log4j.appender.ErrorFile.MaxBackupIndex=10

log4j.appender.ErrorFile.layout=org.apache.log4j.PatternLayout

log4j.appender.ErrorFile.layout.ConversionPattern=%d %-5p [%t] %-17c{2} (%13F:%L) %3x - %m%n

修改记录文件名为demofile.log

private static Logger logger = Logger.getLogger(Main.class); static { Appender appender = Logger.getRootLogger().getAppender("ErrorFile"); if (appender instanceof RollingFileAppender) { RollingFileAppender fappender = (RollingFileAppender) appender; if (!fappender.getFile().startsWith("demofile.log")) { fappender.setFile("demofile.log"); fappender.activateOptions(); } } }

。。

Page updated

Google Sites

Report abuse