Commons 阅读笔记 之 Logging 篇

摘要:

本文描述了apache commons中的commons loggings部分，Commons Logging和Log4J用来提供日志支持。

<!-- end of summary line -->

介绍
命令行参数解析、应用程序配置和日志记录，作为一个应用程序的骨架，随处可见。因此，Apache软件组织开发出了一套通用的类库，用来帮助软件开发人员完成这些“骨架”的建立。其中：
&#8226;Commons CLI用于命令行解析
&#8226;Commons Configuration用于读取properties格式或者XML格式的配置信息
&#8226;Commons Logging和Log4J用来提供日志支持。
这些通用的类库都在http://jakarta.apache.org/commons/index.html网址上提供下载

Apache组织开发了一套用于支持Logging的Log4J，Java 1.4版本也引入了一套内置的Logging框架，如果开发者想在这两套Logging系统之间自由的切换，该怎么办呢？答案就是，使用Commons Logging。Commons Logging定义了一套抽象的Logging接口，用户可以通过配置，使这些接口指向任何一个已存在的Logging系统。

&#8226;使用抽象Logging接口
问题：
你在编写一个可以重复使用的库，需要写入Log信息，但你不想使你的Logging功能绑定在Apache Log4J或者JDK 1.4 Logging框架上。
解决方案：

public static void main(String［］ args) {//自己替换［］

  System.setProperty("org.apache.commons.logging.Log",
      "org.apache.commons.logging.impl.Jdk14Logger");
  Log log = LogFactory.getLog("com.discursive.jccook.SomeApp");

  if (log.isTraceEnabled()) {
    log.trace("This is a trace message");
  }

  if (log.isDebugEnabled()) {
    log.debug("This is a debug message");
  }

  log.info("This is an informational message");
  log.warn("This is a warning");
  log.error("This is an error");
  log.fatal("This is fatal");

}

LogFactory.getLog方法会根据底层环境返回一个适当的Log实现。如果用户想指定一个具体的Logging系统实现，可以设置org.apache.commons.logging.Log系统属性。例如：
System.setProperty("org.apache.commons.logging.Log",
"org.apache.commons.logging.impl.Log4JLogger");
这样就会使用Log4J作为Logging系统。
org.apache.commons.logging.Log可以设定为：
&#8226;org.apache.commons.logging.impl.Log4JLogger  使用Log4J
&#8226;org.apache.commons.logging.impl.Jdk14Logger  使用JDK 1.4 Logging框架
&#8226;org.apache.commons.logging.impl.SimpleLog  使用Commons Logging内置的简单Log实现
其他：
总结一下，Commons Logging会按照下列顺序来指定具体的Log实现。
&#8226;如果定义了org.apache.commons.logging.Log系统参数，实用指定的Logging实现。
&#8226;如果在CLASSPATH里发现了Log4J，使用Log4J。
&#8226;如果使用的是JDK1.4，使用JDK1.4内置的Logging框架。
&#8226;如果都没有找到，则使用Commons Logging内置的简单Log实现。


Jakarta Commons Logging学习笔记 转载

1、Commons-Loggin简介

　　Jakarta Commons Logging (JCL)提供的是一个日志(Log)接口(interface)，同时兼顾轻量级和不依赖于具体的日志实现工具。 它提供给中间件/日志工具开发者一个简单的日志操作抽象，允许程序开发人员使用不同的具体日志实现工具。用户被假定已熟悉某种日志实现工具的更高级别的细节。JCL提供的接口，对其它一些日志工具，包括Log4J, Avalon LogKit, and JDK 1.4等，进行了简单的包装，此接口更接近于Log4J和LogKit的实现.

2、快速入门

　　JCL有两个基本的抽象类：Log(基本记录器)和LogFactory(负责创建Log实例)。当commons-logging.jar被加入到CLASSPATH之后，它会心可能合理地猜测你喜欢的日志工具，然后进行自我设置，用户根本不需要做任何设置。默认的LogFactory是按照下列的步骤去发现并决定那个日志工具将被使用的（按照顺序，寻找过程会在找到第一个工具时中止）:

寻找当前factory中名叫org.apache.commons.logging.Log配置属性的值

寻找系统中属性中名叫org.apache.commons.logging.Log的值

如果应用程序的classpath中有log4j,则使用相关的包装(wrapper)类(Log4JLogger)

如果应用程序运行在jdk1.4的系统中，使用相关的包装类(Jdk14Logger)

使用简易日志包装类(SimpleLog)


3、开发使用logging


//在程序文件头部import相关的类
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
......
//在类中获取一个实例
public class MYCLASS
{
private static Log log = LogFactory.getLog(MyCLASS.class);
...
　}

日志信息被送往记录器，如上例中的log。这个发送过程，是通过调用Log接口中定义的方法完成的，不同方法跟不同的级别联系在一起，日志信息通过哪个级别的方法发送，就标明了日志信息的级别。org.apache.commons.logging.Log接口中定义的方法,按严重性由高到低的顺序有：


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);
除此以外，还提供下列方法以便代码保护.

log.isFatalEnabled();

log.isErrorEnabled();

log.isWarnEnabled();

log.isInfoEnabled();

log.isDebugEnabled();

log.isTraceEnabled();

　　信息级别
　　确保日志信息在内容上和反应问题的严重程度上的恰当，是非常重要的。

fatal非常严重的错误，导致系统中止。期望这类信息能立即显示在状态控制台上。

error其它运行期错误或不是预期的条件。期望这类信息能立即显示在状态控制台上。

warn使用了不赞成使用的API、非常拙劣使用API, '几乎就是'错误, 其它运行时不合需要和不合预期的状态但还没必要称为 "错误"。期望这类信息能立即显示在状态控制台上。

info运行时产生的有意义的事件。期望这类信息能立即显示在状态控制台上。

debug系统流程中的细节信息。期望这类信息仅被写入log文件中。

trace更加细节的信息。期望这类信息仅被写入log文件中。

通常情况下，记录器的级别不应低于info.也就是说，通常情况下debug的信息不应被写入log文件中。
　　工作机理

生命周期
JCL LogFactory必须实现建立/断开到日志工具的连接，实例化/初始化/解构一个日志工具.

异常处理
JCL Log 接口没有指定任何异常处理,对接口的实现必须捕获并处理异常。


多线程
JCL Log 和 LogFactory 的实现，必须确保任何日志工具对并行的要求.


　　记录器的设置
　　JCL采用的记录器的不同其设置内容也不同。Log4J是默认首选记录器，对其设置可通过系统属性(system properties)或一个属性文件进行设置，下面是其设置参数。
<table border="1"><tr><td>参数</td><td>值域</td><td>默认值</td><td>说明</td></tr><tr><td>log4j.configuration</td><td></td><td>log4j.properties</td><td>指定配置文件的名字</td></tr><tr><td>log4j.rootCategory</td><td>priority [, appender]*</td><td></td><td>设定根记录器的级别</td></tr><tr><td>log4j.logger&lt;.logger.name&gt;</td><td>DEBUG, INFO, WARN, ERROR, or FATAL</td><td>设定logger.name这个记录器的级别</td></tr><tr><td>log4j.appender&lt;.appender&gt;.Threshold</td><td>priority</td><td>指定记录设备appender(console, files, sockets, and others)的最低级别。</td></tr></table><br /><!-- Added by RelatedTopic, plugin for Bo-Blog 2.0.0 -->