log4j使用

2018/04/26

摘要

控制日志信息输送的目的地是控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别, 我们能够更加细致地控制日志的生成过程。

配置

第一步

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

第二步

在CLASSPATH下建立log4j.properties,相应的修改其中属性。

第三步

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

// 定义属性
static Logger log = Logger.getLogger(LogDemo.class); //LogDemo为相关的类
// 在相应的方法中
if (logger.isDebugEnabled()){
    logger.debug("System …..");
}

定义log4j.properties

配置根Logger
log4j.rootLogger = [ level ] , appenderName, appenderName, …
log4j.rootCategory=INFO, stdout , R
  level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。
  Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。
  在这里定义了INFO级别,只有等于及高于这个级别的才进行处理。
  ALL:打印所有的日志,OFF:关闭所有的日志输出。
  appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
配置日志信息输出目的地 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(负责格式化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(包含日志产生的时间、线程、类别等等信息)
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 输出日志事件的发生位置,及在代码中的行数;
log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
  定义名为R的输出端的类型为每天产生一个日志文件。
log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log
  定义名为R的输出端的文件名为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
  指定com.neusoft包下的所有类的等级为DEBUG。
log4j.logger.com.opensymphony.oscache=ERROR
log4j.logger.net.sf.navigator=ERROR
  这两句是把这两个包下出现的错误的等级设为ERROR,如果项目中没有配置EHCache,则不需要这两句。

运用在代码中

导入所有需的commons-logging类:

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

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

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

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

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

if (log.isDebugEnabled()){
  log.debug("111");
}
if (log.isInfoEnabled()){
  log.info("222");
}
if (log.isWarnEnabled()){
  log.warn("333");
}
if (log.isErrorEnabled()){
  log.error("444");
}
if (log.isFatalEnabled()){
  log.fatal("555");
}

目录