CSDN博客

img l_walker

org.apache.commons.logging 介绍

发表于2003/1/18 18:04:00  1454人阅读

org.apache.commons.logging 介绍

 

    对多种日志APIs的简单封装包API

 

概述

    本包为服务器端程序的日志处理提供API以使用多种不同的日志系统。包括如下已经实现的:

    ·Log4J Apache Jakarta 项目。每个Log的实例都对应于一个Log4j Category类。

·JDK Logging API JDK1.4及后续版本中。每个Log的实例都是一个java.util.logging.Logger实例。

·LogKit Apache Jakarta 项目。每个Log的实例都对应于一个LogKit Logger类。

    ·NoOpLog 简单地接受将所有的Log实例的日志输出,。

    ·SimpleLog 将所有的Log实例的日志输出到 System.out中。

 

快速开始向导

 

别不耐烦,马上继续下去,下面的例子描述了对logger的典型声明和使用(用调用者的类名来命名):

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFacory;

public class Foo{

    Log log = LogFactory.getLog(this.calss);

    Public void Foo(){

       

        try{

            if(log.isDebugEnabled()){

                log.debug(“About to do something to object” + name);

            }

            name.bar();

        }catch(IllegalStateException e){

            log.error(“Something bad happened to “ + name,e);

        }

       

    }

}

 

除非你配置不同,否则所有的日志输出都将被抛弃。因此,你很想查看此页的剩余部分以理解怎样配置你的日志系统。

 

配置Commons Logging包

 

选择一个LogFactory实现

    从应用观点,首先需要的就是装载一个引用LogFactory实例的对象以便为这个应用创建一个Log实例。这通常通过调用静态的getFactory()方法完成。这个方法实现了如下的发现算法来选择LogFactory实现类的名字并在应用中使用它:

    ·检查org.apache.commons.logging.LogFactory的系统属性。

    ·使用JDK 1.3 JAR服务发现机制(参见

    http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html获得更多信息)来查找名为META-INF/services/org.apache.commons.logging.LogFactory的资源,其中第一行既包含了需要的类名。

  ·在应用程序的classpath中查找名为common-logging.properties的属性文件,其中的org.apache.commons.logging.LogFactory属性定义了期望的实现类的名字。

    ·回到到默认的实现中,这个接下来会介绍。

   

    如果找到commons-logging.properties文件,其中定义的所有属性将被用来配置LogFactory实例的属性。

 

    一旦选中一个实现类的类名,对应的类将从当前线程的类装载器(如果有)中被装载,或者从类装载器中装载LogFactory自己。这将允许在多个类装载器(如servlet容器)中共享一份commons-logging.jar的拷贝,但仍然允许每个web应用程序提供自己的LogFactory的实现,如果需要的话。该类的一个实例将被创建,并且

 

默认LogFactory实现

 

    日志包APIs中包含了一个默认的实现类

org.apache.commons.logging.impl.LogFactoryImpl),当没有发现其他实现类时将选择他。他的主要目的是通过调用getInstance()方法创建(如果需要)并返回一个Log实例。默认实现使用如下规则:

·至多只有一个同名的Log实例被创建。以后的使用相同名字或类参数的getInstance()方法都将调用同一个LogFactory实例,并将返回同一个Log实例。

    ·当一个Log实例确实被创建后,默认的LogFactory实现使用如下的发现机制:

·查找org.apache.commons.logging.Log系统属性(为了和先前的1.0版的API兼容,org.apache.commons.logging.log的系统属性也别将被考虑)。

·查找名为org.apache.commons.logging.Log的工厂配置属性。

·如果Log4J日志系统在应用程序的classpath中是有效的,则使用对应的类包(Log4JcategoryLog)。

·如果应用程序使用JDK1.4系统,则使用Jdk14Logger包。

·如果都没有,则回到默认的不输出日志包(NoOpLog)。

    ·从线程类装载器(任何)中装载这个指定的类,或者从类装载器中装载LogFacory。

·例示一个选定的Log实现类的实例,将此指定的名字作为唯一的参数传给它的构造方法。

 

如果你想让当前的日志输出到System.out上,但没有安装任何三种提供的日志包中的任何一个,一个名为SimpleLog的简单的Log实现将生效。基于上述规则你可以选用它,在命令行包含一个系统属性定义来启动你的应用程序:

    java/

        -D org.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog/

MyApplication

参见SimpleLog的JavaDoc以获得此实现的详细的配置信息。

 

配置日志系统的优先级

 

    基本原理是用户完全为优先的日志系统负责。Common-logging不会改变存在的配置。

 

    每个单独的Log实现都可以提供他自己的配置属性。这在对应的实现类的类发布中说明。

 

    最后,一些Log实现(如Log4J)需要为整个日志系统提供一个外部的配置文件。这个文件需要在实际的日志使用中用一个特别的方法来准备。

   

使用日志包APIs

   

    按如下步骤在应用程序组件中使用日志APIs。

1.      通过调用工厂方法LogFactory.getInstance(String name)获取一个org.apache.commons.logging.Log实例的引用,你的应用程序可以包含多种日志系统的引用以应付各种目的。一个典型的方案是为服务程序的各个主要部件使用他们自己的Log实例。

2.      通过调用适当的方法(debug(),info(),warn(),error(),和fatal())等将信息记录起来(如果对应的级别是可用的)。

 

例如:你可以在你的程序部件中使用如下的技术来初始化和使用一个Log实例:

   

    import org.apache.commons.logging.Log;

    import org.apache.commons.logging.LogFactory;

 

    public class Mycomponent{

        protected Log log = LogFactory.getLog(“my.component”);

       

        //Called once at startup time

public void start(){

           

            log.info(“MyComponent started”);

           

        }

 

        //Called once at shudown time

        public void stop(){

           

            log.info(“MyComponent stopped”);

           

        }

        //Called repeatedly to process a particular argument value

        //which you want logged if debugging is enabled

        public void process(String value){

           

                //Do thie thring concatenation only jif logging is enabled

            if(log.isDebugEnable())

                log.debug(“MyComponent processing” + value);

           

        }

    }

0 0

相关博文

我的热门文章

img
取 消
img