`
wangrl
  • 浏览: 152382 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

Log4j和common-logging配置实例教程

 
阅读更多

Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。

 

为什么要用日志(Log?

这个……就不必说了吧。

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

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

 

 

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

 

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

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

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

 

Commons-logging能帮我们做什么?

 

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

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

它甚至不需要配置

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

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文件适当作一些介绍。

这里顺便提示一点:如果不用commons-logging,仅仅单独使用Log4j,操作上反而要稍微麻烦一些,因为Log4j需要多一点点的初始化代码(相比commons-logging而言):

import org.apache.log4j.Logger;

import org.apache.log4j.PropertyConfigurator;

public class TestLog4j {

static Logger logger = Logger.getLogger(TestLog4j.class); //First step

public static void main(String args[]) {

PropertyConfigurator.configure(“log4j.properties”); //Second step

logger.debug(“Here is some DEBUG”); //Third step

logger.info(“Here is some INFO”);

logger.warn(“Here is some WARN”);

logger.error(“Here is some ERROR”);

logger.fatal(“Here is some FATAL”);

}

}

不过也就多出一行。但这至少说明,引用commons-logging并没有使问题复杂化,反而简单了一些。在这里1+1就小于2了。这也验证了前面的结论。

总结

commons-loggingLog4jjar包都放置到classpath下,同时也将Log4j的配置文件放到classpath中,两者就可以很好的合作。

采用Log4j配合commons-logging作为日志系统,是目前Java领域非常非常流行的模式,使用非常非常的普遍。两者的结合带来的结果就是:简单 + 强大。

commons-logging提供了简捷、统一的接口,不需要额外配置,简单;

Log4j功能非常全面、强大;

commons-logging仅仅对Log4j(当然还包括其它LOG实现)作了一层包装,具体的日志输出还是在内部转交给身后的Log4j来处理;而Log4j虽然做了所有的事情,却甘作绿叶,从不以真身示人。

两者堪称绝配。

分享到:
评论

相关推荐

    Apache Commons-logging使用实例

    * 部署日志器:下载 commons-logging.jar 和 log4j.jar 包,能后把它们放到工程的 lib 目录下,引入工程中。 * 指定日志器:在属性文件 common-logging.properties 中设置实现接口的类。例如,设置 Log4j 为所使用的...

    Common-log 和log4j2 配合使用

    将`Common-Log`与`log4j2`结合使用,首先需要在项目中引入`Common-Log`的接口库和`log4j2`的实现库。在Maven项目中,可以在pom.xml文件中添加以下依赖: ```xml <groupId>commons-logging <artifactId>commons...

    用maven + spring mvc +JDBCTEMPLATE +由Slf4j实现Common-Logging+Log4j的日志控制(数据库用MySQL)

    4. **Slf4j** - 日志门面,允许用户在运行时选择不同的日志实现,如Common-Logging或Log4j,提供了统一的API进行日志记录。 5. **MySQL** - 常用的关系型数据库管理系统,用于存储应用的数据。 在搭建项目时,首先...

    common-logging1.1.1jar

    1. **配置日志实现**:通过系统属性(如`java.util.logging.config.file`或`log4j.configuration`)或者在类路径下放置对应的配置文件,指定日志实现及其配置。 2. **获取Log实例**:通过`LogFactory.getLog(Class...

    commons-logging-1.0.4.zip

    这个库的主要目标是为Java应用程序提供一个简单、统一的接口来使用各种日志框架,如log4j、Java内置的日志API(java.util.logging)或简单的控制台输出。在本文中,我们将深入探讨Commons Logging的核心概念、主要...

    commons-logging.jar 版本1.2

    要在项目中使用Commons Logging,需要将"commons-logging.jar"添加到项目的类路径中,然后通过org.apache.commons.logging.LogFactory和org.apache.commons.logging.Log接口来创建和使用日志实例。 6. **最佳实践*...

    日志框架学习之一:commons-logging+log4j

    1. **安装与配置**:介绍如何在项目中引入commons-logging和log4j的依赖,并设置相应的配置文件,如log4j.properties或log4j.xml。 2. **使用API**:讲解如何在代码中通过commons-logging接口来调用log4j的记录方法...

    Spring初步学习入门基础jar包以及commons-logging的jar

    6. **Apache Commons Logging**: `commons-logging-1.2.jar`是一个日志抽象层,允许开发者选择底层的日志实现,如Log4j、Java Util Logging等。通过使用Commons Logging,Spring框架可以保持与特定日志实现的解耦,...

    commons-logging-1.2.rar

    例如,设置`java.util.logging.LogManager`可以影响`Jdk14Logger`的行为,而设置`log4j.properties`或`log4j.xml`可以控制`Log4jLogger`的日志输出。 4. **性能和可扩展性**:由于其轻量级的设计,Commons Logging...

    JBOSS log4j 配置

    本文将详细介绍如何解决 JBOSS 和 Log4j 的冲突,配置 Log4j,及 Log4j 的基本使用方法。 解决 JBOSS 和 Log4j 冲突的配置 为了解决 JBOSS 和 Log4j 的冲突,需要在 JBOSS 服务器中进行以下配置: 1. 配置 $JBOSS...

    quartz2.6.2+Common.Logging.Core+Common.Logging.rar

    例如,如果你选择NLog作为日志实现,你需要配置Common.Logging指向NLog的适配器,并设置适当的日志级别和输出目的地。 总的来说,这个压缩包提供了在.NET 4.0环境中使用Quartz.NET进行任务调度所需的所有组件,同时...

    commons-logging-1.1.1-bin

    Commons Logging的核心理念是解耦应用代码与具体日志实现的绑定,使得开发者可以自由选择日志库,如Log4j、Java内置的java.util.logging(也称JUL)或Jakarta LogKit等。在"commons-logging-1.1.1"这个压缩包中,...

    Spring.Core.dll 和 Common.Logging.dll

    4. **性能优化**:由于Common.Logging仅在实际需要日志记录时才会实例化具体的日志提供者,因此对应用性能的影响较小。 5. **多环境兼容**:适用于桌面应用、Web应用以及服务端应用等多种场景。 结合这两个库,...

    Common Logging日志接口

    "Common Logging"接口支持多种流行的日志框架,包括标签中提到的几个:Logging.dll(可能是项目自定义的日志库)、EntLib.dll(Enterprise Library的日志提供程序)、Log4Net.dll(Apache的Log4net,广泛用于.NET...

    apache-commoms-logging与pdfbox-app-2.0.25的jar包

    Apache Commons Logging 提供了一个接口,使得开发者可以方便地切换不同的日志实现,如 Log4j、Java Util Logging 或者 Simple Logging Facade for Java (SLF4J)。它的主要优点在于解耦了应用程序代码和实际日志实现...

    log日志组件总结

    本文将深入探讨Java中的log日志组件,包括JDK内置的日志(jdkLog)、Apache的Commons Logging(commonLog)以及流行的log4j。了解这些组件的特点和用法,将提升你对Java日志处理的理解。 首先,我们来看看JDK内置的...

    Android-一款简洁漂亮的OkHttpLogging拦截器

    然后,你需要配置OkHttpClient并添加Logging拦截器。以下是一个简单的示例: ```java import okhttp3.OkHttpClient; import okhttp3.logging.HttpLoggingInterceptor; // 创建日志拦截器 HttpLoggingInterceptor ...

    Quartz_Common.Logging.rar

    "Common.Logging"是一个通用的日志记录抽象层,它允许你在应用程序中使用不同的日志实现,如log4net、NLog或System.Diagnostics.Trace,而无需更改代码。通过使用Common.Logging,你可以在开发阶段选择一种日志记录...

    WebShpere_common_log_docview

    3. **Log4J 官方文档**:详细介绍Log4J的功能、配置和使用方法。 4. **JDK 1.4 日志记录API文档**:介绍了JDK 1.4中提供的日志记录API及其使用方式。 5. **Jakarta Commons-Logging官方文档**:提供了JCL的全面指南...

Global site tag (gtag.js) - Google Analytics