OK,现在我们来研究下Java相关的日志。
日志记录是应用程序运行中必不可少的一部分。具有良好格式和完备信息的日志记录可以在程序出现问题时帮助开发人员迅速地定位错误的根源。对于开发人员来说,在程序中使用日志API记录日志并不复杂,不过遵循一些最佳实践可以更好的利用日志。本系列介绍了在Java程序中记录日志的最佳实践,同时也介绍了如何使用开源软件对日志进行聚合和分析。
对于现在的应用程序来说,日志的重要性是不言而喻的。很难想象没有任何日志记录功能的应用程序运行在生产环境中。日志所能提供的功能是多种多样的,包括记录程序运行时产生的错误信息、状态信息、调试信息和执行时间信息等。在生产环境中,日志是查找问题来源的重要依据。应用程序运行时的产生的各种信息,都应该通过日志 API 来进行记录。很多开发人员习惯于使用 System.out.println、System.err.println 以及异常对象的 printStrackTrace 方法来输出相关信息。这些使用方式虽然简便,但是所产生的信息在出现问题时并不能提供有效的帮助。这些使用方式都应该改为使用日志
API。使用日志 API 并没有增加很多复杂度,但是所提供的好处是显著的。
尽管记录日志是应用开发中并不可少的功能,在 JDK 的最初版本中并不包含日志记录相关的 API 和实现。相关的 API(java.util.logging 包,JUL)和实现,直到 JDK 1.4 才被加入。因此在日志记录这一个领域,社区贡献了很多开源的实现。其中比较流行的包括 log4j 及其后继者 logback。除了真正的日志记录实现之外,还有一类与日志记录相关的封装 API,如 Apache Commons Logging 和 SLF4J。这类库的作用是在日志记录实现的基础上提供一个封装的 API 层次,对日志记录
API 的使用者提供一个统一的接口,使得可以自由切换不同的日志记录实现。比如从 JDK 的默认日志记录实现 JUL 切换到 log4j。这类封装 API 库在框架的实现中比较常用,因为需要考虑到框架使用者的不同需求。在实际的项目开发中则使用得比较少,因为很少有项目会在开发中切换不同的日志记录实现。本系列博客对于这两类库都会进行具体的介绍。
值得注意和反思的是:记录日志只是有效地利用日志的第一步,更重要的是如何对程序运行时产生的日志进行处理和分析。典型的情景包括当日志中包含满足特定条件的记录时,触发相应的通知机制,比如邮件或短信通知;还可以在程序运行出现错误时,快速地定位潜在的问题源。这样的处理和分析的能力对于实际系统的维护尤其重要。当运行系统中包含的组件过多时,日志对于错误的诊断就显得格外重要。
- 日志的原理
假如我们现在没有日志系统,那么我们只能system.out.println来输出我们的相关代码来监控我们的项目运行情况了。OK,现在我们来写一个例子:
package org.linkinpark.commons.logtest; public class Linkin { public static void main(String[] args) { log(); } public static void log() { for (int i = 0; i < 3; i++) { for (int j = 0; j < 3; j++) { System.out.println("开始输出日志:第" + i + "*" + j + "次!"); } } } }
2次循环后我们在控制台输出了i*j的效果,这种日志方式非常简单,但是缺点也非常明显。这种输出是不可控制的,对于较复杂的程序,所有的信息都将输出到屏幕,日志的可读性非常差。而且输出到屏幕需要消耗资源,大量的io操作会使程序运行变
慢。那么我们现在来改进一下,代码如下:
package org.linkinpark.commons.logtest; public class Linkin { private static boolean flag = true; public static void main(String[] args) { log(); } public static void log() { for (int i = 0; i < 3; i++) { for (int j = 0; j < 3; j++) { if (flag) { System.out.println("开始输出日志:第" + i + "*" + j + "次!"); } } } } }
上面的代码没什么好解释的,我们通过了一个旗标来控制日志的输出。虽然这个时候日志的输出已经可控了,但是也只有2个级别,就是输出与不输出。flag旗标为false时不输出,flag旗标是true时输出。
Log4j等日志工具也都是这个原理,但是增加了很多的输出级别。输出级别,输出样式,输出目的地都可以在配置文件中配置,而不是写4在我们的程序中,增加了灵活性。