Log日志的写法

1. Log的用途

通常来讲,日志分为两种:业务日志和异常日志,使用日子好咱们但愿能达到如下目标:html

  1. 问题追踪:经过日志能够对程序运行状况进行记录和监控,便于出现Bug时分析问题
  2. 状态监控:经过实时分析日志,能够详细了解程序内部的运行状况
  3. 日志对性能的影响尽可能小。

2. Java日志框架

  1. Log4j或Log4j2 - Apache的开源项目,经过使用Log4j,咱们能够控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;用户也能够控制每一条日志的输出格式;经过定义每一条日志信息的级别,用户可以更加细致地控制日志的生成过程。这些能够经过一个配置文件(XML或Properties文件)来灵活地进行配置,而不须要修改程序代码。Log4j则是前任的一个升级,参考了Logback的许多特性;
  2. Logback - Logback是由log4j创始人设计的又一个开源日志组件。logback当前分红三个模块:logback-core,logback-classic和logback-access。log-core是其余两个模块的基础模块。logback-classic是log4j的一个改良版本。此外logback-classic完整实现SLF4J API,使你能够很方便地更换成其余日志系统如log4j或JDK14 Logging;
  3. java.util.logging - JDK内置的日志接口和实现,功能比较简单。
  4. SLF4J - SLF4J为各类Logging API提供一个简单统一的接口,从而使用户可以在部署的时候配置本身但愿的Logging API实现。
  5. Apache Commons Logging - Apache Commons Logging (JCL)但愿解决的问题和SLF4J相似。

3. Java日志最佳实践

定义日志变量java

日志变量每每不变,最好定义成final static,变量名用大写服务器

日志分级框架

Java的日志框架通常会提供如下日志级别,缺省打开info级别,也就是debug,trace级别的日志在生产环境不会输出。在开发和测试环境能够经过不一样的日志配置文件打开debug级别。函数

  1. fatal - 严重的,形成服务中断的错误;
  2. error - 其余错误运行期错误;
  3. warn - 警告信息,如系统调用了一个即将做废的接口,接口的不当使用,运行状态不是指望的但仍可继续处理等;
  4. info - 有意义的事件信息,如程序启动,关闭事件,收到请求事件等
  5. debug - 调试信息,可记录详细的业务处理到哪一步了,以及当前的变量状态; 
  6. trace - 更详细的跟踪信息;

在程序里要合理使用日志分级:性能

4. 基本的Logger编码规范

1. 在一个对象中一般只使用一个Logger对象,Logger应该是static final的,只有在少数须要在构造函数中传递logger的状况下才使用private final。测试

2. 输出Exception的所有Throwable信息,由于logger.error(msg)和logger.error(msg,e.getMessage())这样的日志输出方法会丢失掉最重要的StackTrace信息。编码

3. 不容许记录日志后又抛出异常,由于这样会屡次记录日志,只容许记录一第二天志。spa

4. 不容许出现System println(包括System.out.println和System..println)语句debug

5. 不容许出现printStackTrace。

6. 日志性能的考虑,若是代码为核心代码,执行频率很是高,则输出日志建议增长判断,尤为是低级别的输出<debug info warn>。debug日志太多之后可能会影响性能,有一种改进方法是:

但更好的方法是Slf4j提供的最佳实践:

一方面能够减小参数构造的开销,另外一方面也不用多写两行代码。

7. 有意义的日志

一般状况下在程序日志里记录一些比较有意义的状态数据:程序启动,退出的时间点;程序运行消耗时间;耗时程序的执行进度;重要变量的状态变化。除此以外,在公共的日志里规避打印程序的调试或者提示信息。

相关文章
相关标签/搜索