即时日志记录:使用 Jabber 增强 log4j 的功能

1/5/2008来源:Java教程人气:6349

学习如何用自己的 appender 来扩展 log4j 框架

级别:高级

Ruth Zamorano ([email protected]),软件架构师,Orange Soft
Rafael Luque ([email protected]), CTO,Orange Soft

2003年 9 月

日志记录不仅是开发和测试周期中的一个重要元素——提供要害调试信息,而且对于系统已部署到生产环境之后调试错误也是很有用的——提供修复错误所需的准确上下文信息。在本文中,Orange Soft 公司(这是一家专业从事面向对象技术、服务器端java 平台和 Web 可访问性的西班牙公司)的共同创办人 Ruth Zamorano 和 Rafael Luque 阐述了如何利用 log4j 的扩展能力,使得分布式 Java 应用程序能够通过即时消息传送(instant messaging,IM)来监视。

不管您编写多少设计良好的测试用例,即使是最小的应用程序也会在部署到生产环境之后隐藏着一个或多个错误。虽然测试驱动的开发和 QA 手段可以提高代码质量 并增强对应用程序的信心,但是当某个系统失败时,开发人员和系统治理员需要了解系统的相关执行上下文信息。有了适当的信息,他们就能确定问题的本质并快速解决问题,从而节省时间和金钱。

监视分布式应用程序要求能够对远程资源进行日志记录——通常是一台中心日志服务器或者系统治理员的计算机。log4j 环境提供一组适用于远程日志记录的 appender,比如 SocketAppenderJMSAppenderSMTPAppender。在本文中,我们将向您展示一种新的远程类(remote-class)appender:IMAppender

让我们首先简要回顾一下 log4j ,然后再深入研究 appender。自然地,理解 appender 的最好方式就是试着编写一个 appender,因此我们将在最后一节实现一个例子 IM(即时消息传送)appender,以说明 AppenderSkeleton 类的工作原理。

读者应该熟悉 log4j 框架。关于 log4j 的更多信息,请参见本文后面的 参考资料 。

log4j 概述
log4j 框架是用 Java 语言编写的事实上的标准日志记录框架。作为 Jakarta 项目的一部分,它在 Apache 软件许可证(Apache Software License)下分发,Apache 软件许可证是由开放源代码促进会(Open Source Initiative ,OSI)认证的一种流行的开放源代码许可证。log4j 环境是完全可配置的,或者通过编程方式完成,或者通过属性中的配置文件或者 xml 格式的配置文件完成。此外,它还答应开发人员无需修改源代码就可以选择性地筛选出日志记录请求。

log4j 环境包括三个主要组件

  • logger(日志记录器):控制要启用或禁用哪些日志记录语句。可以对日志记录器指定如下级别:ALLDEBUGINFOWARNERROR, FATA或OFF

  • layout(布局):根据用户的愿望格式化日志记录请求。

  • appender:向目的地发送格式化的输出。

理解 appender
log4j 框架答应向任何日志记录器附加多个 appender。可以在任何时候对某个日子记录器添加(或删除)appender。附随 log4j 分发的 appender 有多个,包括:

  • ConsoleAppender
  • FileAppender
  • SMTPAppender
  • JDBCAppender
  • JMSAppender
  • NTEventLogAppender
  • SyslogAppender

也可以创建自己的自定义 appender。

log4j 最主要的特性之一就是它的灵活性。遗憾的是,没有多少现存文档说明了如何编写自己的 appender。学习编写 appender 的方式之一就是分析可用的源代码,然后尝试推断 appender 是如何工作的——本文将帮助 您完成这个任务。

揭开面纱
所有的 appender 都必须扩展 org.apache.log4j.AppenderSkeleton 类,这是一个抽象类,它实现了 org.apache.log4j.Appenderorg.apache.log4j.spi.OptionHandler 接口。AppenderSkeleton 类的 UML 类图看起来如图1所示:

图 1. AppenderSkeleton 的 UML 类图