Java日志正确使用姿式

时间 2020-08-02 标签 java 日志正确使用姿式

前言

关于日志，在你们的印象中都是比较简单的，只须引入了相关依赖包，剩下的事情就是在项目中“尽情”的打印咱们须要的信息了。可是每每越简单的东西越容易让咱们忽视，从而致使一些不应有的bug发生，做为一名严谨的程序员，怎么能让这种事情发生呢？因此下面咱们就来了解一下关于日志的那些正确使用姿式。java

正文

日志规范

命名

首先是日志文件的命名，尽可能要作到见名知意，团队里面也必须使用统一的命名规范，否则“脏乱差”的日志文件会影响你们排查问题的效率。这里推荐以“projectName_logName_logType.log”来命名，这样经过名字就能够清晰的知道该日志文件是属于哪一个项目，什么类型，有什么做用。例如在咱们MessageServer项目中监控Rabbitmq 消费者相关的日志文件名能够定义成“messageserver_rabbitmqconsumer_monitor.log”。程序员

保存时间

关于日志保存的时间，普通的日志文件建议保留15天，若比较重要的可根据实际状况延长，具体请参考各自服务器磁盘空间以及日志文件大小做出最优选择。web

日志级别

常见的日志级别有如下：安全

DEBUG级别:记录调试程序相关的信息。
INFO级别:记录程序正常运行有意义的信息。
WARN级别:记录可能会出现潜在错误的信息。
ERROR级别:记录当前程序出错的信息，须要被关注处理。
Fatal级别：表示出现了严重错误，程序将会中断执行。

建议在项目中使用这四种级别， ERROR、WARN、INFO 、DEBUG。服务器

正确姿式

一、提早判断日志级别异步

//条件判断
if(logger.isDebugEnabled){
    logger.debug("server info , id : " + id + ", user : " + user);
}

//使用占位符
logger.debug("server info , id : {}, user : {}",id,user);

对于DEBUG,INFO级别的日志，在咱们的程序中是比较高频的存在，当咱们的项目大了，日志变多了，这时候为了程序运行的效率，咱们必须以条件判断或者占位符的方式来打印日志。为何呢？假如咱们项目中配置的日志级别为WARN,那么对于咱们下面的日志输出语句‘ logger.debug("server info , id : " + id + ", user : " + user);’，虽然该日志不会被打印，可是却会执行字符串拼接的操做，这里咱们的user是一个实例对象，因此还会执行toString方法，这样就白白浪费了很多系统的资源。socket

二、避免多余日志输出elasticsearch

在咱们的生产环境中，通常禁止DEBUG日志的输出，其打印的频率是很是高的，容易对正常运行的程序形成严重的影响，在咱们最近的项目中就有遇到过相似的状况。分布式

那么这时候该学会使用additivity属性svg

<logger name="xx" additivity="true">

在这边配置成true的话，也就是默认的状况，这时候当前Logger会继承父Logger的Appender，说白了就是当前日志的输出除了输出在当前日志文件之外，还会输出至父文件里。因此通常状况下，咱们为了不重复打印，会将这个参数设置成false，以减小没必要要的输出。

三、保证日志记录信息完整

在咱们的代码中，日志记录的内容要包含异常的堆栈，请勿随意输出“XX出错”等简单的日志，这对于错误的调试毫无帮助。因此咱们在记录异常的时候必定要带上堆栈信息，例如

logger.error("rabbitmq consumer error,cause : "+e.getMessage(),e);

切记在输出对象实例的时候，须确保对象重写了toString方法，不然只会输出其hashCode值。

四、定义logger变量为static

private static final Logger logger = LoggerFactory.getLogger(XX.class);

确保一个对象只使用一个Logger对象，避免每次都从新建立，不然可能会致使OOM。

五、正确使用日志级别

try{
    //..
}catch(xx){
    logger.info(..);
}

这样一来，原本是ERROR的信息，全都打印在INFO日志文件里了，不知情的同事还会在死盯着错误日志，并且还找不出问题，多影响工做效率是吧?

六、推荐使用slf4j+logback组合

logback库里自身就已经实现了slf4j的接口，就无需引入多余的适配器了，并且logback也具备更多的优势，建议新项目可使用这个组合。
还有一点须要注意，当引入slf4j后，要注意其实际使用的日志库是不是由咱们引入的，也有可能会使用了咱们第三方依赖包所带入的日志库，这样就可能会致使咱们的日志失效。

七、日志的聚合分析

日志的聚合能够把位于不一样服务器之间的日志统一块儿来分析处理，现在ELK技术栈亦或者的EFG（fluentd+elasticsearch+grafana）等都是一些比较成熟的开源解决方案。

拿ELK来讲，能够在咱们的服务器上直接经过logstash来读取应用打印的日志文件，或者也能够在咱们项目中的日志配置文件里配置好相关的socket信息，打印的时候直接把日志信息输出至logstash。再交由elasticsearch存储，kibana展现。

结语

好了，关于日志先聊这么多~ 你们有须要补充或者交流的能够在下方留言哦。

Java日志正确使用姿式

前言

正文

日志规范

命名

保存时间

日志级别

正确姿式

结语

推荐阅读