Log4j 的详细介绍

1 简介

　　Log4j（log for java）是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

2 配置

第一步：

　　加入log4j-2.10.0.jar(可以选择 log4j 的其他版本)到lib下。

第二步：

　　在 CLASSPATH 下建立log4j.properties，其内容如下所示

log4j.rootCategory=INFO, stdout , R 

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n

log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

log4j.logger.com.neusoft=DEBUG
log4j.logger.com.opensymphony.oscache=ERROR
log4j.logger.net.sf.navigator=ERROR
log4j.logger.org.apache.commons=ERROR
log4j.logger.org.apache.struts=WARN
log4j.logger.org.displaytag=ERROR
log4j.logger.org.springframework=DEBUG
log4j.logger.com.ibatis.db=WARN
log4j.logger.org.apache.velocity=FATAL

log4j.logger.com.canoo.webtest=WARN

log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
log4j.logger.org.hibernate=DEBUG
log4j.logger.org.logicalcobwebs=WARN
  
  

第三步：

　　根据自己的要求，相应的修改其中属性。

第四步：

　　在要输出日志的类中加入相关语句：定义属性，

static Logger logger = Logger.getLogger(LogDemo.class); //LogDemo为相关的类
  
  

在相应的方法中，

if (logger.isDebugEnabled()){
    logger.debug(“System …..”);
}
  
  

3 属性说明

（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 信息不会被显示。

（2）log4j.appender.stdout=org.apache.log4j.ConsoleAppender

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

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
  
  

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

（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信息的开头，可以为任意字符，一般为项目简称。
  
  

（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 的包。

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

4 属性详解

4.1 定义配置文件

　　Log4j 支持两种配置文件格式，一种是 XML（标准通用标记语言下的一个应用）格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法:

① 配置根 Logger

　　Logger 负责处理日志记录的大部分操作，其语法为：

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

   
   
1
  
  

其中，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（包含日志产生的时间、线程、类别等等信息）
  
  

4.2 格式化日志

　　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）导入所有需的commons-logging类：

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
  
  

（2）在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员：

private final Log log = LogFactory.getLog(getClass());
  
  

   
   
1
  
  

LogFactory.getLog()方法的参数使用的是当前类的 class。

（3）使用org.apache.commons.logging.Log类的成员方法输出日志信息：

if (log.isDebugEnabled()){
    log.debug("20");
}
if (log.isInfoEnabled()){
    log.info("15");
}
if (log.isWarnEnabled()){
    log.warn("11");
}
if (log.isErrorEnabled()){
    log.error("20");
}
if (log.isFatalEnabled()){
    log.fatal("1314");
}
  
  

5 应用记录器

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

（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 简介