commons-logging与log4j的结合使用说明与示例

使用接口分为编程接口和配置接口，编程接口谈软件系统中如何使用日志设施进行日志登记，配置接口规划日志设施的运行。
   

整体介绍

Common-logging为common的原因在于它是一个通用日志封装，被封装的可以是log4j，logkit，以及jsdk 1.4中的log等具体日志系统。在运行当中到底和那种绑定主要依赖配置接口和Common-logging的绑定搜索策略。 日志格式，日志目标多样性特性主要依赖具体日志系统的能力和配置情况。
   

日志级别

在纪录日志的时候,要根据级别来记录我们所需要的日志信息，比如需要纪录debug的信息，或者系统提示信息，或者程序运行情况，以及纪录异常信息和纪录出错堆栈信息等。
   

以下为各种日志的级别：
   

jdk1.4日志纪录在java.util.logging.Level类中定义了下列日志级别常数
   

SERVER：表示一个严重失败。常常将有一个伴随的Throwable。

WARNING: 警告信息.

?       INFO：中等优先级。表示一个构件正在做什么（例如，监视一项任务的运行进度），但不是用来帮助调试该构件。

?       CONFIG：为应用配置期间所生成的消息而设计的。

?        FINE：跟踪信息。该级别和较低优先级的级别应该用来帮助调试某些类，但不应该用来总体的说明该应用的工作方式。

?       FINER：详细的跟踪信息。

?       FINEST：非常详细的跟踪信息。

Log4j在org.apache.log4j.Level类中定义了下列日志级别常数

?       FATAL：表示一个严重失败。导致application的中断。

?       ERROR：表示一个错误事件。可以允许Application可以继续运行。

?       WARN：表示一个有潜在的危险。

?       INFO：表示一个构件正在做重要运行情况，信息比较粗糙。

?      DEBUG：表示一个构件详细的运行情况，用于调试Application。

?      ALL：表示纪录所有级别的日志信息。

Common-logging的日志级别分为6种，从低到高分别为trace，debug，info，warn，error，fatal。

?       FATAL：表示一个严重失败。导致application的中断。

?       ERROR：表示一个错误事件。可以允许Application可以继续运行。

?       WARN：表示一个有潜在的危险。

?       INFO：表示一个构件正在做重要运行情况，信息比较粗糙。

?       DEBUG：表示一个构件详细的运行情况，用于调试Application。

?       TRACE：非常详细的跟踪信息，仅仅用于纪录该日志而已。

日志级别一部分在编程接口中体现，一部分在配置接口中体现。每个级别都有一个对应的便利方法，比如fatal()和info()，通过方法允许把一个分配给一条消息,并记录异常。每条消息都必须分配这些日志级别中的一种级别，以保证日志纪录能够在运行时被轻松地加以控制。
   

应用编程接口

Common-logging的应用程序编程接口主要在org.apache.commons.logging.log接口中定义，这个接口主要定义了两类操作：

1.        一类是级别判断，用于减少不必要的日志操作的参数计算从而提高性能，函数名和参数如下所示：

log.isFatalEnabled();

log.isErrorEnabled();

log.isWarnEnabled();

log.isInfoEnabled();

log.isDebugEnabled();

log.isTraceEnabled();

下面的代码可以很好地解释这一点：

  if (log.isDebugEnabled()) {

        ... 一些高代价操作 ...

        log.debug(theResult);

    }

如果日志设施的级别定义高于debug，这些高代价操作可以避免运行。

2.        一类是日志登记，按照级别登记日志信息，函数名和参数如下所示：

log.fatal(Object message);

log.fatal(Object message, Throwable t);

log.error(Object message);

log.error(Object message, Throwable t);

log.warn(Object message);

log.warn(Object message, Throwable t);

log.info(Object message);

log.info(Object message, Throwable t);

log.debug(Object message);

log.debug(Object message, Throwable t);

log.trace(Object message);

log.trace(Object message, Throwable t);

日志登记操作分又为两小类：一个参数的日志信息登记操作和两个参数的日志信息登记操作。前者对三类用户都适用，后者用于打印日志登记处的出错堆栈信息，所以更适用于开发人员调式与维护使用。注意: trace和debug封装了log4j的debug方法

配置接口

commons-logging的配置可在系统属性中设置，但是这是一个不好的习惯，系统属性会影响同一jvm下的所有类，而且不好控制，所以配置commons-logging的最好位置在commons-logging.properties文件中。使用属性文件配置commons-logging时一定要把其放到软件系统的classpath下。 commons-logging.properties中可以对下面两个属性项进行设置：org.apache.commons.logging.Log commons-logging的缺省 LogFactory. 按照这个项的值来实例化实现应用编程接口log的实例。如果这个项没被设置，LogFactory在软件系统的classpath下按下面的顺序搜索实现log接口的类：

Log4J

JSDK 1.4

JCL SimpleLog

这个规则我们把它称为搜索策略。org.apache.commons.logging.LogFactory 这个项覆盖缺省的LogFactory实现，用来满足应用系统的特定需求，如重新定义搜索策略。

示例代码

注意:一下两个properies文件放在classes目录下,log包会自动找到它们,然后编辑运行程序,就可以看到记录日志得到结果.

1.     commons-logging.properties 

#设置记录日志使用

log4jorg.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger

org.apache.commons.logging.LogFactory=org.apache.commons.logging.impl.Log4jFactory

设置记录日志使用jdk1.4 logging包

#org.apache.commons.logging.Log=org.apache.commons.logging.impl.Jdk14Logger

#设置记录日志使用LogKit

#org.apache.commons.logging.Log=org.apache.commons.logging.impl.LogKitLogger

#设置记录日志使用SimpleLog

#org.apache.commons.logging.Log=org.apache.commons.logging.impl. SimpleLog

2.     log4j.properties 

#log4j会解析这个文件

log4j.debug=false

#暂时还不清楚这两个属性的作用,测试的时候总是不起作用

log4j.disableOverride=true

log4j.disable=INFO

#设置记录所有类的日志的优先级别

log4j.rootLogger=DEBUG,dest1,dest2

#设置这个包记录日志为假的话

#dist1,dist2就不会记录com.xxxx.commons.logging.test.LoggingSample的日志,只有dist3会记录.

#反之,会记录,这样就会重复记录

log4j.additivity.com.xxxx.commons.logging.test.LoggingSample=false

#特别指定某个特殊包的日志级别和目标设备

log4j.category.com.xxxx.commons.logging.test.LoggingSample=WARN, dest3

#这个目标设备用来debug

log4j.appender.dest1=org.apache.log4j.ConsoleAppender

#log4j.appender.dest1.layout=org.apache.log4j.SimpleLayout

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

#%-4r %-5p [%t] %37c %3x - %m%n

log4j.appender.dest1.layout.ConversionPattern=%d %p %c - <%m> (%F.%M:%L) %t%n

#这个目标设备用来trace

log4j.appender.dest2=org.apache.log4j.RollingFileAppender

#该文件记录日志的级别(INFO以下的级别不记录)

log4j.appender.dest2.Threshold=INFO

#文件保存路径

log4j.appender.dest2.File=c:/log4jlog.htm

#是否往文件追加信息

log4j.appender.dest2.Append=true

#设置文件最大值

log4j.appender.dest2.MaxFileSize=5KB

#设置备份文件的最大数量

log4j.appender.dest2.MaxBackupIndex=10

#使用一个html格式来记录日志

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

#是否打印该消息的代码行

log4j.appender.dest2.layout.LocationInfo=true

#设置该日志的html的标题

log4j.appender.dest2.layout.Title=My app title

 

#这个目标设备用来trace指定类或包

log4j.appender.dest3=org.apache.log4j.DailyRollingFileAppender

#log4j.appender.dest3.Threshold=DEBUG

log4j.appender.dest3.File=c:/SpecPackageLog.htm

log4j.appender.dest3.Append=false

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

log4j.appender.dest3.layout.LocationInfo=true

log4j.appender.dest3.layout.Title=My app title 2

LoggingSample.java

package com.xxxx.commons.logging.test;

 

import org.apache.commons.logging.*;

 

/**

 * commons-logging和log4j结合的使用方法

 * <p>Title: commons-logging-1_0_4源代码</p>

 * <p>Description: commons-logging-1_0_4源代码</p>

 * <p>Copyright: Copyright (c) 2004</p>

 * <p>Company: xxxx</p>

 * @author 王建

 * @version 1.0

 */

public class LoggingSample {

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

  public static void main(String[] args) {

    org.apache.log4j.PropertyConfigurator.configure("E:/Commons-logging-1_0_4/classes/com/xxxx/commons/logging/test/log4j.properties");

 

    LoggingSample LoggingSample = new LoggingSample();

    //trace，debug，info，warn，error，fatal

    LoggingSample.trace();

    LoggingSample.debug();

    LoggingSample.info();

    LoggingSample.warn();

    LoggingSample.error();

    LoggingSample.fatal();

//    com.xxxx.commons.logging.test.LoggingSample

//        LoggingSample1 = new com.xxxx.commons.logging.test.LoggingSample();

//    LoggingSample1.trace();

//    LoggingSample1.debug();

//    LoggingSample1.info();

//    LoggingSample1.warn();

//    LoggingSample1.error();

//    LoggingSample1.fatal();

  }

 

  public LoggingSample() {}

 

  public void trace() {

    if (log.isTraceEnabled())

      log.trace("trace---系统开始trace记录日志");

  }

 

  public void debug() {

    if (log.isDebugEnabled())

      log.debug("debug---系统开始debug记录日志");

  }

 

  public void info() {

    if (log.isInfoEnabled())

      log.info("info---系统开始info记录日志");

  }

 

  public void warn() {

    if (log.isWarnEnabled())

      log.warn("warn---系统开始warn记录日志");

  }

 

  public void error() {

    if (log.isErrorEnabled())

      log.error("error---系统开始error记录日志", new Throwable("测试log.error"));

  }

 

  public void fatal() {

    if (log.isFatalEnabled())

      log.fatal("fatal---系统开始fatal记录日志", new Throwable("测试log.fatal"));

  }

}

总结

建议在使用配置文件时,通过使用多试试几种情况,这样就会很快了解那些配置符的用法了.