JAVA & XML & JAVASCRIPT & AJAX & CSS

Web 2.0 技术储备............

  BlogJava :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理 ::
  77 随笔 :: 17 文章 :: 116 评论 :: 0 Trackbacks

为什么要用日志(Log?

这个……就不必说了吧。

为什么不用System.out.println()?

功能太弱;不易于控制。如果暂时不想输出了怎么办?如果想输出到文件怎么办?如果想部分输出怎么办?……

为什么同时使用commons-loggingLog4j?为什么不仅使用其中之一?

Commons-loggin的目的是为“所有的Java日志实现”提供一个统一的接口,它自身的日志功能平常弱(只有一个简单的SimpleLog?),所以一般不会单独使用它。

Log4j的功能非常全面强大,是目前的首选。我发现几乎所有的Java开源项目都会用到Log4j,但我同时发现,所有用到Log4j的项目一般也同时会用到commons-loggin。我想,大家都不希望自己的项目与Log4j绑定的太紧密吧。另外一个我能想到的“同时使用commons-loggingLog4j”的原因是,简化使用和配置。

       强调一点,“同时使用commons-loggingLog4j”,与“单独使用Log4j”相比,并不会带来更大的学习、配置和维护成本,反而更加简化了我们的工作。我想这也是为什么“所有用到Log4j的项目一般也同时会用到commons-loggin”的原因之一吧。

 

Commons-logging能帮我们做什么?

l         提供一个统一的日志接口,简单了操作,同时避免项目与某个日志实现系统紧密a耦合

l         很贴心的帮我们自动选择适当的日志实现系统(这一点非常好!)

l         它甚至不需要配置

 

这里看一下它怎么“‘很贴心的’帮我们‘自动选择’‘适当的’日志实现系统”:

1)        首先在classpath下寻找自己的配置文件commons-logging.properties,如果找到,则使用其中定义的Log实现类;

2)        如果找不到commons-logging.properties文件,则在查找是否已定义系统环境变量org.apache.commons.logging.Log,找到则使用其定义的Log实现类;

3)        否则,查看classpath中是否有Log4j的包,如果发现,则自动使用Log4j作为日志实现类;

4)        否则,使用JDK自身的日志实现类(JDK1.4以后才有日志实现类);

5)        否则,使用commons-logging自己提供的一个简单的日志实现类SimpleLog

(以上顺序不保证完全准确,请参考官方文档)

 

可见,commons-logging总是能找到一个日志实现类,并且尽可能找到一个“最合适”的日志实现类。我说它“很贴心”实际上是因为:1、可以不需要配置文件;2、自动判断有没有Log4j包,有则自动使用之;3、最悲观的情况下也总能保证提供一个日志实现(SimpleLog)。

       可以看到,commons-logging对编程者和Log4j都非常友好。

       为了简化配置commons-logging,一般不使用commons-logging的配置文件,也不设置与commons-logging相关的系统环境变量,而只需将Log4jJar包放置到classpash中就可以了。这样就很简单地完成了commons-loggingLog4j的融合。如果不想用Log4j了怎么办?只需将classpath中的Log4jJar包删除即可。

就这么简单!

代码应该怎么写?

我们在需要输出日志信息的“每一人”类中做如下的三个工作:

1、导入所有需的commongs-logging类:

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

如果愿意简化的话,还可以两行合为一行:

import org.apache.commons.logging.*;

 

2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员:

private static Log log = LogFactory.getLog(YouClassName.class);

注意这里定义的是static成员,以避免产生多个实例。

LogFactory.getLog()方法的参数使用的是当前类的class,这是目前被普通认为的最好的方式。为什么不写作LogFactory.getLog(this.getClass())?因为static类成员访问不到this指针!

 

3、使用org.apache.commons.logging.Log类的成员方法输出日志信息:

log.debug("111");

log.info("222");

log.warn("333");

log.error("444");

log.fatal("555");

这里的log,就是上面第二步中定义的类成员变量,其类型是org.apache.commons.logging.Log,通过该类的成员方法,我们就可以将不同性质的日志信息输出到目的地(目的地是哪里?视配置可定,可能是stdout,也可能是文件,还可能是发送到邮件,甚至发送短信到手机……详见下文对log4j.properties的介绍):

l         debug()   输出“调试”级别的日志信息;

l         info()      输出“信息”级别的日志信息;

l         warn()    输出“警告”级别的日志信息;

l         error()     输出“错误”级别的日志信息;

l         fatal()      输出“致命错误”级别的日志信息;

根据不同的性质,日志信息通常被分成不同的级别,从低到高依次是:“调试(DEBUG)”“信息(INFO)”“警告(WARN)”“错误(ERROR)”“致命错误(FATAL)”。为什么要把日志信息分成不同的级别呢?这实际上是方便我们更好的控制它。比如,通过Log4j的配置文件,我们可以设置“输出‘调试’及以上级别的日志信息”(即“调试”“信息”“警告”“错误”“致命错误”),这对项目开发人员可能是有用的;我们还可以设置“输出“警告”及以上级别的日志信息”(即“警告”“错误”“致命错误”),这对项目最终用户可能是有用的。

       仅从字面上理解,也可以大致得出结论:最常用的应该是debug()info();而warn()error()fatal()仅在相应事件发生后才使用。

 

 

从上面三个步骤可以看出,使用commons-logging的日志接口非常的简单,不需要记忆太多东西:仅仅用到了两个类Log, LogFactory,并且两个类的方法都非常少(后者只用到一个方法,前者经常用到的也只是上面第三步中列出的几个),同时参数又非常简单。

上面所介绍的方法是目前被普通应用的,可以说是被标准化了的方法,几乎所有的人都是这么用。如果不信,或想确认一下,就去下载几个知名的Java开源项目源代码看一下吧。

 

下面给出一个完整的Java类的代码:

 

package liigo.testlog;

 

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

 

 

public class TestLog

{

    private static Log log = LogFactory.getLog(TestLog.class);

 

    public void test()

    {

        log.debug("111");

        log.info("222");

        log.warn("333");

        log.error("444");

        log.fatal("555");

    }

 

    public static void main(String[] args)

    {

        TestLog testLog = new TestLog();

        testLog.test();

    }

}

 

 

只要保证commons-loggingjar包在classpath中,上述代码肯定可以很顺利的编译通过。那它的执行结果是怎么样的呢?恐怕会有很大的不同,请继续往下看。

 

Log4j在哪里呢?它发挥作用了吗?

应该注意到,我们上面给出的源代码,完全没有涉及到Log4j——这正是我们所希望的,这也正是commons-logging所要达到的目标之一。

可是,怎么才能让Log4j发挥它的作用呢?答案很简单,只需满足“classpath中有Log4jjar包”。前面已经说过了,commons-logging会自动发现并应用Log4j。所以只要它存在,它就发挥作用。(它不存在呢?自然就不发挥作用,commons-logging会另行选择其它的日志实现类。)

 

注意:配置文件log4j.propertiesLog4j来说是必须的。如果classpath中没有该配置文件,或者配置不对,将会引发运行时异常。

 

       这样,要正确地应用Log4j输出日志信息,log4j.properties的作用就很重要了。好在该文件有通用的模板,复制一份(稍加修改)就可以使用。几乎每一个Java项目目录内都会有一个log4j.properties文件,可下载几个Java开源项目源代码查看。本文最后也附一个模板性质的log4j.properties文件,直接复制过去就可以用,或者根据自己的需要稍加修改。后文将会log4j.properties文件适当作一些介绍。

posted on 2006-03-16 22:48 Web 2.0 技术资源 阅读(1032) 评论(1)  编辑  收藏 所属分类: JAVA

评论

# re: commons-logging和Log4j 日志管理..... 2006-10-25 14:47 yb
好文章,谢谢  回复  更多评论
  


只有注册用户登录后才能发表评论。


网站导航: