Commons Logging 的使用方法

应用程序中使用好日志（Logging）功能能够方便的调试和跟踪应用程序任意时刻的行为和状态。在大规模的应用开发中尤其重要，毫不夸张的说，Logging是不可或缺的重要组成部分。那么我们需要自己开发一套Logging API吗？答案是否定的，我们不用再造轮子了。java自J2SE 1.4版本开始提供一个新的Java Logging API应用程序接口。它能够很方便地控制和输出日志信息到控制台，文件或其它用户定义的地方，如数据库，电子邮件等。当然还有其它的一些 Logging API，如：log4j、JDK、Logkit等等。

那么这么多的Logging工具，我们该选择那个呢？在我们的程序中如何兼容这些个日志组件呢？一个选择是在我们的程序中使用Commons Logging 组件，然后在发布时根据环境来选择不同的底层实现。

Commons项目Logging组件的办法是将记录日志的功能封装为一组标准的API，使其底层实现可以任意修改和变换。开发者利用这个API来执行记录日志信息的命令，由API来决定把这些命令传递给适当的底层实现。因此，对于开发者来说，Logging组件对于任何具体的底层实现都是中立的。

使用Commons的Logging API非常简单。只需导入Logging的两个必须类、创建一个Log的静态实例，下面展示了这部分操作的代码：

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

public class CommonLogTest {
 private static Log log = LogFactory.getLog(CommonLogTest.class);

    // ...
}

有必要详细说明一下调用LogFactory.getLog()时发生的事情。调用该函数会启动一个发现过程，即找出必需的底层日志记录功能的实现，具体的发现过程在下面列出。注意，不管底层的日志工具是怎么找到的，它都必须是一个实现了Log接口的类，且必须在CLASSPATH之中。Commons Logging API直接提供对下列底层日志记录工具的支持：Jdk14Logger，Log4JLogger，LogKitLogger，NoOpLogger （直接丢弃所有日志信息），还有一个SimpleLog。

⑴ Commons的Logging首先在CLASSPATH中查找commons-logging.properties文件。这个属性文件至少定义org.apache.commons.logging.Log属性，它的值应该是上述任意Log接口实现的完整限定名称。如果找到org.apache.commons.logging.Log属相，则使用该属相对应的日志组件。结束发现过程。

⑵ 如果上面的步骤失败（文件不存在或属相不存在），Commons的Logging接着检查系统属性org.apache.commons.logging.Log。 如果找到org.apache.commons.logging.Log系统属性，则使用该系统属性对应的日志组件。结束发现过程。

⑶ 如果找不到org.apache.commons.logging.Log系统属性，Logging接着在CLASSPATH中寻找log4j的类。如果找到了，Logging就假定应用要使用的是log4j。不过这时log4j本身的属性仍要通过log4j.properties文件正确配置。结束发现过程。

⑷ 如果上述查找均不能找到适当的Logging API，但应用程序正运行在JRE 1.4或更高版本上，则默认使用JRE 1.4的日志记录功能。结束发现过程。

⑸ 最后，如果上述操作都失败（JRE 版本也低于1.4），则应用将使用内建的SimpleLog。SimpleLog把所有日志信息直接输出到System.err。结束发现过程。

    获得适当的底层日志工具之后，接下来就可以开始记录日志信息。作为一种标准的API，Commons Logging API主要的好处是在底层日志机制的基础上建立了一个抽象层，通过抽象层把调用转换成与具体实现有关的日志记录命令。 本文提供的示例程序会输出一个提示信息，告诉你当前正在使用哪一种底层的日志工具。

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

public class CommonLogTest {
 private static Log log = LogFactory.getLog(CommonLogTest.class);

 public static void main(String[] args) {
  log.error("ERROR");
  log.debug("DEBUG");
  log.warn("WARN");
  log.info("INFO");
  log.trace("TRACE");
  System.out.println(log.getClass());
 }

}

请试着在不同的环境配置下运行这个程序。例如，

1. 在不指定任何属性的情况下运行这个程序，这时默认将使用Jdk14Logger；

2. 然后指定系统属性 -Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog再运行程序，这时日志记录工具将是SimpleLog；

3. 把Log4J的类放入CLASSPATH，默认情况下log4j会在类路径上寻找log4j.properties，如果找到就加载，否则查找系统属性log4j.properties，若还是没有找到，则报告错误。因此只要正确设置了log4j的log4j.properties配置文件并放在合适位置，就可以得到Log4JLogger输出的信息。

如果没有设置log4j.properties配置文件，则会输出以下提示：

class org.apache.commons.logging.impl.Log4JLogger
log4j:WARN No appenders could be found for logger (CommonLogTest).
log4j:WARN Please initialize the log4j system properly.

附:
1. commons-logging.properties文件
# commons-logging.properties
# org.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog
# simplelog.properties
# # Logging detail level,
# # Must be one of ("trace", "debug", "info", "warn", "error", or "fatal").
#org.apache.commons.logging.simplelog.defaultlog=trace
org.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog

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

2. log4j.properties

log4j.rootLogger=WARN,STDOUT
log4j.appender.STDOUT=org.apache.log4j.ConsoleAppender
log4j.appender.STDOUT.ImmediateFlush=true
log4j.appender.STDOUT.layout=org.apache.log4j.PatternLayout
log4j.appender.STDOUT.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ss.S} [%c] %m%n 

事实上，Log完全可以分装一个类，而不必每个类要log，都得

定义private static  Log testLogger = LogFactory.getLog(xxx.class);

最普通的实现：
package moxtv.central.util;

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

/**
 * 
 * @author weip
 * @time 2006-4-30 16:38:27
 * 
 */
public class Logger {

    /**
     * 
     */
    private static Log sysLogger = LogFactory.getLog(Logger.class);

    /**
     * 
     * @author weip
     * @time 2006-4-30 16:39:57
     * @param obj
     *            Object
     */
    public static void debug(Object obj) {
        sysLogger.debug(obj);
    }

    /**
     * 
     * @author weip
     * @time 2006-4-30 16:41:39
     * @param obj
     *            Object
     */
    public static void info(Object obj) {
        sysLogger.info(obj);
    }

    /**
     * 
     * @author weip
     * @time 2006-4-30 16:42:28
     * @param obj
     *            Object
     */
    public static void warn(Object obj) {
        sysLogger.warn(obj);
    }

    /**
     * 
     * @author weip
     * @time 2006-4-30 16:42:50
     * @param obj
     *            Object
     */
    public static void error(Object obj) {
        sysLogger.error(obj);
    }

    /**
     * 
     * @author weip
     * @time 2006-4-30 16:42:58
     * @param obj
     *            Object
     */
    public static void fatal(Object obj) {
        sysLogger.fatal(obj);
    }

}

另外一种重构后的实现，但似乎也没有带来更大的益处
package moxtv.central.util;

import java.lang.reflect.Method;

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

/**
 * Logger的重构，也许不大合适
 * @author weip
 * @time 2006-4-30 17:24:49
 *
 */
public class Logger2 {

    /**
     * 
     */
    private static Log sysLogger = LogFactory.getLog(Logger.class);
    /**
     * 
     */
    public static final String DEBUG = "debug";

    /**
     * 
     */
    public static final String INFO = "info";

    /**
     * 
     */
    public static final String WARN = "warn";

    /**
     * 
     */
    public static final String ERROR = "error";

    /**
     * 
     */
    public static final String FATAL = "fatal";
    
    /**
     * generic method instead of the five methods above
     * 
     * @author weip
     * @time 2006-4-30 16:51:31
     * @param obj
     *            Object
     * @param level
     *            String
     * 
     */
    public static void log(Object obj, String level) {

        Method method;
        try {
            method = sysLogger.getClass().getMethod(level,
                    new Class[] {Object.class });

            method.invoke(sysLogger, new Object[] {obj });
        } catch (Exception e) {

            e.printStackTrace();
            throw new RuntimeException("It should be a unreachalbe point");
        }
    }
}