LOG 日志各级别区分以及选择

文章来源于公司的大牛

1 Log 的用途

不管是使用何种编程语言，日志输出几乎无处不再。总结起来，日志大致有以下几种用途：

l 问题追踪：通过日志不仅仅包括我们程序的一些 bug，也可以在安装配置时，通过日志可以发现问题。

l 状态监控：通过实时分析日志，可以监控系统的运行状态，做到早发现问题、早处理问题。

l 安全审计：审计主要体现在安全上，通过对日志进行分析，可以发现是否存在非授权的操作。

2 记录 Log 的基本原则

2.1 日志的级别划分

Java 日志通常可以分为：error、warn、info、debug、trace 五个级别。在 J2SE 中预定义的级别更多，分别为：SEVERE、WARNING、INFO、CONFIG、FINE、FINER、FINEST。两者的对应大致如下：

（原文的表格我做了截图处理）

2.2 日志对性能影响

不管是多么优秀的日志工具，在日志输出时总会对性能产生或多或少的影响，为了将影响降低到最低，有以下几个准则需要遵守：

l 如何创建 Logger 实例：创建 Logger 实例有是否 static 的区别，在 log4j 的早期版本，一般要求使用 static，而在高版本以及后来的 slf4j 中，该问题已经得到优化，获取（创建）logger 实例的成本已经很低。所以我们要求：对于可以预见的多数情况下单例运行的 class，可以不添加 static 前缀；对于可能是多例居多，尤其是需要频繁创建的 class，我们要求要添加 static 前缀。

l 判断日志级别：

n 对于可以预见的会频繁产生的日志输出，比如 for、while 循环，定期执行的 job 等，建议先使用 if 对日志级别进行判断后再输出。

n 对于日志输出内容需要复杂的序列化，或输出的某些信息获取成本较高时，需要对日志级别进行判断。比如日志中需要输出用户名，而用户名需要在日志输出时从数据库获取，此时就需要先判断一下日志级别，看看是否有必要获取这些信息。

l 优先使用参数，减少字符串拼接：使用参数的方式输出日志信息，有助于在性能和代码简洁之间取得平衡。当日志级别限制输出该日志时，参数内容将不会融合到最终输出中，减少了字符串的拼接，从而提升执行效率。

2.3 什么时候输出日志

日志并不是越多越详细就越好。在分析运行日志，查找问题时，我们经常遇到该出现的日志没有，无用的日志一大堆，或者有效的日志被大量无意义的日志信息淹没，查找起来非常困难。那么什么时候输出日志呢？以下列出了一些常见的需要输出日志的情况，而且日志的级别基本都是 >=INFO，至于 Debug 级别日志的使用场景，本节没有专门列出，需要具体情况具体分析，但也是要追求“恰如其分”，不是越多越好。

2.3.1 系统启动参数、环境变量

系统启动的参数、配置、环境变量、System.Properties 等信息对于软件的正常运行至关重要，这些信息的输出有助于安装配置人员通过日志快速定位问题，所以程序有必要在启动过程中把使用到的关键参数、变量在日志中输出出来。在输出时需要注意，不是一股脑的全部输出，而是将软件运行涉及到的配置信息输出出来。比如，如果软件对 jvm 的内存参数比较敏感，对最低配置有要求，那么就需要在日志中将-Xms -Xmx -XX:PermSize 这几个参数的值输出出来。

2.3.2 异常捕获处

在捕获异常处输出日志，大家在基本都能做到，唯一需要注意的是怎么输出一个简单明了的日志信息。这在后面的问题问题中有进一步说明。

2.3.3 函数获得期望之外的结果时

一个函数，尤其是供外部系统或远程调用的函数，通常都会有一个期望的结果，但如果内部系统或输出参数发生错误时，函数将无法返回期望的正确结果，此时就需要记录日志，日志的基本通常是 warn。需要特别说明的是，这里的期望之外的结果不是说没有返回就不需要记录日志了，也不是说返回 false 就需要记录日志。比如函数：isXXXXX()，无论返回 true、false 记录日志都不是必须的，但是如果系统内部无法判断应该返回 true 还是 false 时，就需要记录日志，并且日志的级别应该至少是 warn。

2.3.4 关键操作

关键操作的日志一般是 INFO 级别，如果数量、频度很高，可以考虑使用 DEBUG 级别。以下是一些关键操作的举例，实际的关键操作肯定不止这么多。

n 删除：删除一个文件、删除一组重要数据库记录……

n 添加：和外系统交互时，收到了一个文件、收到了一个任务……

n 处理：开始、结束一条任务……

n ……

2.4 日志输出的内容

l ERROR：错误的简短描述，和该错误相关的关键参数，如果有异常，要有该异常的 StackTrace。

l WARN：告警的简短描述，和该错误相关的关键参数，如果有异常，要有该异常的 StackTrace。

l INFO：言简意赅地信息描述，如果有相关动态关键数据，要一并输出，比如相关 ID、名称等。

l DEBUG：简单描述，相关数据，如果有异常，要有该异常的 StackTrace。

在日志相关数据输出的时要特别注意对敏感信息的保护，比如修改密码时，不能将密码输出到日志中。

2.5 什么时候使用 J2SE 自带的日志

我们通常使用 slf4j 或 log4j 这两个工具记录日志，那么还需要使用 J2SE 的日志框架吗？当然需要，在我们编写一些通用的工具类时，为了减少对第三方的 jar 包的依赖，首先要考虑使用 java.util.logging。

考虑到 slf4j 等日志框架提供了日志 bridge 工具，为 java.util.logging 提供了 Handler，所以普通应用的开发过程中也可以考虑使用 J2SE 自有日志，这样不但可以减少项目的编译依赖，同时在应用实施时可以更灵活的选择日志的输出工具包。

3 典型问题分析

3.1 该用日志的地方不用

上图对异常的处理直接使用 e.printStackTrace()显然是有问题的，正确的做法是：要么通过日志方式输出错误信息，要么直接抛出异常，要么创建新的自定义异常抛出。

另：对于静态工具类函数中的异常处理，最简单的方式就是不捕获、不记录日志，直接向上抛出，如果认为异常类型太多，或者意义不明确，可以抛出自定义异常类的实例。

3.2 啰嗦重复、没有重点

首先上面不应该有 error 级别的日志。

其次在日志中直接输出 e.toString()，为定位问题提供的信息太少。

另外需要明确一点：日志系统是一个多线程公用的系统，在两行日志输出之间有可能会被插入其他线程的日志记录，不会按照我们的意愿顺序输出，后面有更典型的例子。

最后，上面的日志可以简化为：

logger.debug(“从 properties 中...{}...{}...”,name, value, e);

logger.warn(“从 properties 中获取{}发生错误：{}”,name, e.toString());

或者直接一句：

logger.warn(“从 properties 中...{}...{}...”,name, value, e);

或者更完美的：

if(logger.isDebugEnabled()){

logger.warn(“从 properties 中...{}...”, name, e);

}else{

logger.warn(“从 properties 中获取{}发生错误：{}”, name, e.toString());

}

3.3 日志和异常处理的关系

首先上面的日志信息不够充分，级别定义不够恰当。

另外，既然将异常捕获并记录的日志，就不应该重新将一个一模一样的异常再次抛出去了。如果将异常再次抛出，那在上层肯定还需要对该异常进行处理，并记录日志，这样就重复了。如果没有特别原因，此处不应该捕获异常。

3.4 System.out 方式的日志

上面的日志形式十分随意，只适合临时的代码调试，不允许提交到正式的代码库中。

对于临时调试日志，建议在日志的输出信息中添加一些特殊的连续字符，也可以用自己的名称、代号，这样可以在调试完毕后，提交代码之前，方便地找到所有临时代码，一并删除。

3.5 日志信息不明确

上面的“添加任务出错。。。”既没有记录任务 id，也没有任务名称，软件部署后发现错误后，根据该日志记录不能确认哪一条任务错误，给进一步的分析原因带来困难。

另外第二个红圈中的问题有：要使用参数；一行日志就可以了。

还有一些其他共性的错误，就不多说了。

3.6 忘记日志输出是多线程公用的

如果有另外一个线程正在输出日志，上面的记录就会被打断，最终显示输出和预想的就会不一致。正确的做法应是将这些信息放到一行，如果需要换行可以考虑使用“\r”，如果内容较多，考虑增加 if (logger.isDebugEnabled())进行判断。而第二个例子中的输出有 System.out 的习惯，相关内容应该一行完成。

3.7 多个参数的处理

对于多参的日志输出，可以考虑：

public void debug(String format, Object... arguments);

但是在使用多参时，会创建一个对象数组，也会有一定的消耗，为此，在对性能敏感的场景，可以增加对日志级别的判断。

文章转载自：浅谈 LOG 日志的写法