`

Commons Logging 的使用方法

    博客分类:
  • Java
阅读更多

应用程序中使用好日志(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。

 

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

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

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

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

5.最后,如果上述操作都失败(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. 然后指定系统属性 -Jorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog再运行程序,这时日志记录工具将是SimpleLog;

3. 把Log4J的类放入CLASSPATH,只要正确设置了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=%-5p %d [%t] %m%n

分享到:
评论

相关推荐

    commons-logging-1.2_commonslogging_

    在标题"commons-logging-1.2_commonslogging_"中提到的"commons-logging-1.2.jar"就是这个库的1.2版本,它是Spring框架中常用的一个依赖,用于处理日志记录。 Spring框架广泛使用Commons Logging作为其默认的日志...

    commons-logging.jar

    commons-logging-1.0-javadoc.jar, commons-logging-1.0.1-javadoc.jar, commons-logging-1.0.1.jar, commons-logging-1.0.2-javadoc.jar, commons-logging-1.0.2.jar, commons-logging-1.0.3-javadoc.jar, commons-...

    commons-logging-1.2-bin.zip下载

    3. 在代码中创建 `org.apache.commons.logging.Log` 对象,通常通过 `LogFactory.getLog(Class)` 方法获取,然后使用其方法(如 `debug()`, `info()`, `warn()`, `error()` 和 `fatal()`)记录日志。 在某些情况下...

    Commons logging API.chm

    Commons-logging API apache Commons logging API

    commons-logging-1.2

    Commons Logging 是 Apache 组织提供的一款轻量级的日志记录工具库,它的主要目标是为 Java 开发者提供一个简单的接口来使用各种日志框架,如 Log4j、Java Util Logging(JUL)或者 Simple Logging Facade for Java...

    commons-logging-1.2.jar

    使用Commons Logging时,开发者不需要直接实例化特定日志系统的类,而是通过Commons Logging提供的接口(如`org.apache.commons.logging.Log`和`org.apache.commons.logging.LogFactory`)来创建和使用日志对象。...

    commons-logging-1.2.JAR开源包

    在项目中使用"commons-logging-1.2.jar",开发者可以方便地整合各种日志框架,提高开发效率,并且可以根据项目的具体需求调整日志输出的方式和级别,以满足调试、性能监控或生产环境的不同需求。

    commons logging

    Apache Commons Logging 是一个Java日志库,它提供了一个API,允许开发者在他们的应用程序中使用不同的日志框架,而无需直接依赖具体的实现。这个库的主要目标是解决Java日志的分散问题,因为不同的开源项目可能会...

    Apache Commons-logging使用实例

    org.apache.commons.logging.Log 接口中定义的方法,按严重性由高到低的顺序有: * log.fatal(Object message) * log.fatal(Object message, Throwable t) * log.error(Object message) * log.error(Object message...

    commons-logging-1.0.4.jar 免费下载

    Spring 框架广泛使用 Commons Logging 进行日志记录,因为它允许 Spring 与多种日志实现(如 log4j、java.util.logging 或 logback)无缝集成。 描述中提到的 "java spring 中打印信息的jar包" 指的是 Commons ...

    commons-logging-1.1.1.rar

    使用Commons Logging时,我们通常会创建一个`Log`实例,通过`LogFactory.getLog()`方法获取。例如: ```java import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; public class...

    Apache Commons Logging 1.2

    Apache Commons Logging 1.2

    commons-logging-1.2-bin.zip

    开发者可以通过查看这个文件来了解每个类和接口的详细说明、方法签名以及使用示例,这对于理解和使用 Commons Logging API 非常有帮助。 Commons Logging的核心特性包括: - **可插拔性**:由于Commons Logging只...

    spring-framework & commons-logging

    spring-framework & commons-logging spring-framework & commons-logging spring-framework & commons-logging spring-framework & commons-logging spring-framework & commons-logging spring-framework & ...

    commons-logging-1.2-bin2014最新版

    例如,通过`org.apache.commons.logging.LogFactory`类获取一个`Log`实例,然后调用`log.info()`, `log.debug()`等方法进行日志输出。由于 Commons Logging 是一个轻量级的组件,它自身并不执行任何日志记录操作,...

    commons-logging-1.1

    - **适配器**: Commons Logging 使用适配器模式来封装各种日志系统的API,如Log4j的`Log4jLogger`,Java内置日志的`Jdk14Logger`等。 - **日志级别**:包括TRACE、DEBUG、INFO、WARN、ERROR和FATAL,允许开发者...

    commons-logging-1.1.3-bin.zip

    在实际使用中,Commons Logging提供了一系列的Logger接口,如`org.apache.commons.logging.Log`和`org.apache.commons.logging.LogFactory`。通过`LogFactory.getLog(Class)`方法,可以获取与当前类关联的Logger实例...

    commons-logging-1.0.4.zip

    在本文中,我们将深入探讨Commons Logging的核心概念、主要功能和使用方法。 一、项目背景 在Java世界中,日志框架众多,不同的框架有着各自的优点和适用场景。然而,这给开发者带来了选择和集成的困扰。Commons ...

Global site tag (gtag.js) - Google Analytics