1．为何需要日志


这是一个很基本的争议，人们会争辩说，我们可以使用System.out.println()来打印消息，为何还需要日志呢？每个人刚开始接触JAVA时，都使用System.out.println()在控制台打印消息。但是它的功能远远没有日志记录API如log4j或是java.util.logging强大。如果你正在写一个java服务器应用，那么你只有通过日志文件才能知道你的服务器在做什么。如果你没有记录任何日志，那么没有人知道你的服务器在干啥。而如果你的服务器作为一个中间件连接到应用中时，比如从股票交易系统或是电子交易系统获得输入流，将其转换并标准化后发送到输出流，这时日志就更为重要。没有日志你根本不知道究竟哪里出了问题。因此，日志在JAVA中是必不可少的。

2．JAVA中有哪些不同的日志级别


使用过JAVA日志的童鞋一定知道这些基础的日志级别比如DEBUG, INFO, WARN和ERROR。
DEBUG是最低的限制级别。这个级别只能用于开发和测试环境中，不可以用于生产环境。
INFO略高于DEBUG的限制级别，我们应该用这个级别记录一些信息型消息比如服务器启动成功，输入的数据，输出的数据等等。
WARN的限制级别高于INFO，它用来记录警告信息比如客户端和服务器之间的连接中断，数据库连接丢失，Socket达到上限。这些信息是最为重要的，因为你可以在这些信息出现时发出警告，从而让运维团队管理应用程序的运行，并及时处理这些报错。
ERROR比WARN的限制级别还高，用于记录ERROR和Exception。你可以在该日志级别上设置警报装置，并且提醒运维团队对之做出处理。ERROR非常重要，你必须将其记录下来。
FATAL是指可能导致程序终止的非常严重的时间。在这种事件之后你的应用很可能会崩溃。
OFF具有最高的级别，旨在关闭JAVA中的日志功能。
这些日志级别是根据slf4j整理的，和java.util.loggingAPI中定义的级别不太一样。java.util.logging还提供了其它的基于问题严重性进行划分的日志级别如SEVERE, FINER, FINEST, FATAL 等。

3．使用log4j还是java.util.logging

我会推荐使用log4j，你可能会对此持有异议。我也同意java.util.logging的功能很强大，但是我发现log4j更易于使用。你已经了解了log4j的各个日志级别，这里每个级别都非常恰当的描述了其功能。log4j还提供了额外的灵活性，你无需重新启动应用来改变日志的级别。当然，你也可以在java.util.logging中通过JMX实现这个功能。
log4j还允许我们在配置文件log4j.xml中设置每个类的日志级别。你既可以使用XML文件也可以使用properties文件进行配置。而且log4j是线程安全的。它被设计用于高并发的系统中。在另一方面，我发现java.util.logging中的Formatter和Appender功能非常棒。

4．为何在JAVA中使用日志会影响性能


通常来说，记录日志越频繁，所需的IO操作就越多，从而影响了应用的性能。因此为每一个消息选择一个合适的日志级别是非常重要的。既然我们不能不使用JAVA日志，那么我们只能控制日志的级别以及在那个级别上记录的日志内容。所以，一定要在isDebugEnabled()代码块中记录DEBUG消息，如下所示：

if(logger.isDebugEnabled()){
logger.debug(“java logging level is DEBUG Enabled”)
}
在生产环境中一定要使用WARN或是更高级别的日志记录等级，一定不要使用DEBUG。它很可能成为性能下降的罪魁祸首。

5．JAVA日志的10个小建议

1.将DEBUG日志访日isDebugEnabled代码块
它能显著的减少因为字符串拼接而带来的性能的影响。
2.谨慎的消息的等级
当你在编写服务器端应用时，这一点显得格外的重要，因为它是你观察服务器运行情况的唯一途径。如果你记录了太多的日志，则会影响服务器的性能，但是如果你不记录重要的信息如输入数据和输出数据，那么就很难识别究竟发生了什么问题。
3.使用slf4j或是java.util.loggin
我推荐slf4j因为它的灵活性非常高。它允许在不重启应用的前提下更改日志级别。你可以通过log4j的看门狗来不停的寻找目录中的log4j.xml配置文件，并且在找到后重置日志配置。
4.log4j可以为不同的类配置不同的日志级别
你可以将一些类设置为INFO级别，再将另一些类设置为WARN级别或是ERROR级别。
5.日志的格式化
不要忘了记录线程的名称和完整的JAVA类名，因为如果有多个线程同时在执行这段代码，你可能根本找不出事件序列。在我看来，这一条建议最为重要
6.从日志中生成报告
在记录日志时要保证一致性和信息性，从而可以分析日志。
7.使用前缀来说明哪一部分代码在打印日志
前缀是指如客户端，数据库或是Session等等。之后你可以使用grep或是find来找到和这些关键字相关的日志。我在进行了这种实践后发现它非常有助于debug或是调查事件，尤其是当日志文件很庞大的时候。你可以将所有数据库级别的日志加上前缀DB_LOG，再将所有SESSION级别的日志加上前缀SESSION_LOG
8.如果某个日志没有分配等级，则将其继承最近级别的等级
这也是为什么我们总是将日志等级分配到根日志上log4j.rootLogger=DEBUG.
9.没有日志和过度日志都是不好的
原因前面已经说明
10.自检日志并调整日志
最好用英文记录日志，而且要有良好的可读性，从而在查阅时能够快速理解日志。
11.使用标准化格式而不要自行拼接
logger.debug(“No of Orders “ + noOfOrder + “ for client: “ + client);//不好
logger.debug(“No of Orders {} for client: {}”, noOfOrder, client);

6．补充：记录哪些信息以及各个信息对应什么级别的日志

1.不要记录敏感信息
不要记录敏感信息如密码，身份证号，信用卡号或账户号。
2.尽量记录决策性信息
比如，一个JAVA应用需要从偏好文件或是环境中加载配置，如果没有找到就使用默认的配置。如果你在使用默认配置，那么你应当记录如下信息：
logger.info(“Not able to load personal settings, default Setting selected for user : {}”, user);
这个日志丢失了一个关键性信息，为什么无法加载到个人配置？因此如果出现异常的话，还应当记录异常。当然，这条日志也提供了有用的信息，比如究竟是哪个用户遇到了这个问题。

3.一致性
一致性在日志和编码中都很重要。无论你采用哪种格式，你都应当坚持一致性。你应当花些时间仔细考虑日志的格式，从而用它来捕获有用的信息。
4.记录一切出现问题时辅助debug的信息
举个例子，我们经常在应用中将String转化为Date，如果String的格式不正确的话，我们通常会抛出ParseException。但是我经常看到有的代码里捕获了这个异常之后，将Date赋值为null并打印如下日志：
logger.info(“failed to convert String to date”)
看到这行日志的时候，你根本不知道那个date传入了不合法的值。它也没有打印出不合法的String的内容究竟是什么。你需要这些信息来解决这个问题。一个更好的日志信息如下：
logger.info(“invalid startDate: {}”, startDate);

其它建议

1. 选择恰当的日志级别

常见的日志级别有 5 种，分别是 error、warn、info、debug、trace。日常开发中，我们需要选择恰当的日志级别，不要反手就是打印 info 哈~

  • error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；
  • warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；
  • info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
  • debug：用于开发 DEBUG 的，关键逻辑里面的运行时数据；
  • trace：最详细的信息，一般这些信息只记录到日志文件中。

    2. 日志要打印出方法的入参、出参

我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志。有效的日志，是甩锅的利器！

哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。入参的话，一般就是userId 或者 bizSeq 这些关键信息。正例如下：

  1. public String testLogMethod(Document doc, Mode mode){
  2.    log.debug(“method enter param：{}”,userId);
  3.    String id = "666";
  4.    log.debug(“method exit param：{}”,id);
  5.    return id;
  6. }

3. 选择合适的日志格式

理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在 logback 日志里可以这么配置：

  1. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  2.     <encoder>
  3.         <pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern>
  4.     </encoder>
  5. </appender>

如果我们的日志格式，连当前时间都沒有记录，那连请求的时间点都不知道了？

4. 遇到 if…else… 等条件时，每个分支首行都尽量打印日志

当你碰到if…else… 或者 switch这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。

正例：

  1. if(user.isVip()){
  2.   log.info("该用户是会员,Id:{},开始处理会员逻辑",user,getUserId());
  3.   //会员逻辑
  4. }else{
  5.   log.info("该用户是非会员,Id:{},开始处理非会员逻辑",user,getUserId())
  6.   //非会员逻辑
  7. }

5. 日志级别比较低时，进行日志开关判断

对于 trace/debug 这些比较低的日志级别，必须进行日志级别的开关判断。

正例：

  1. User user = new User(666L, "公众号", "捡田螺的小男孩");
  2. if (log.isDebugEnabled()) {
  3.     log.debug("userId is: {}", user.getId());
  4. }

因为当前有如下的日志代码：

  1. logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

如果配置的日志级别是 warn的话，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象， 还会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印，因此建议加日志开关判断。

6. 不能直接使用日志系统（Log4j、Logback）中的 API，而是使用日志框架 SLF4J 中的 API。

SLF4J 是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。

正例：

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory;
  4. private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);

7. 建议使用参数占位 {}，而不是用 + 拼接。

反例：

  1. logger.info("Processing trade with id: " + id + " and symbol: " + symbol);

上面的例子中，使用+操作符进行字符串的拼接，有一定的性能损耗。

正例如下：

  1. logger.info("Processing trade with id: {} and symbol : {} ", id, symbol);

我们使用了大括号{}来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。

8. 建议使用异步的方式来输出日志。

  • 日志最终会输出到文件或者其它输出流中的，IO 性能会有要求的。如果异步，就可以显著提升 IO 性能。
  • 除非有特殊要求，要不然建议使用异步的方式来输出日志。以 logback 为例吧，要配置异步很简单，使用 AsyncAppender 就行
  1. <appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
  2.     <appender-ref ref="ASYNC"/>
  3. </appender>

9. 不要使用 e.printStackTrace()

反例：

  1. try{
  2.   // 业务代码处理
  3. }catch(Exception e){
  4.   e.printStackTrace();
  5. }

正例：

  1. try{
  2.   // 业务代码处理
  3. }catch(Exception e){
  4.   log.error("你的程序有异常啦",e);
  5. }

理由：

  • e.printStackTrace() 打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。
  • e.printStackTrace() 语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了, 即内存满了，那么，用户的请求就卡住啦~

10. 异常日志不要只打一半，要输出全部错误信息

反例 1：

  1. try {
  2.     //业务代码处理
  3. } catch (Exception e) {
  4.     // 错误
  5.     LOG.error('你的程序有异常啦');
  6. }
  • 异常 e 都没有打印出来，所以压根不知道出了什么类型的异常。

反例 2：

  1. try {
  2.     //业务代码处理
  3. } catch (Exception e) {
  4.     // 错误
  5.     LOG.error('你的程序有异常啦', e.getMessage());
  6. }
  • e.getMessage()不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。

正例：

  1. try {
  2.     //业务代码处理
  3. } catch (Exception e) {
  4.     // 错误
  5.     LOG.error('你的程序有异常啦', e);
  6. }

11. 禁止在线上环境开启 debug

禁止在线上环境开启 debug，这一点非常重要。

因为一般系统的 debug 日志会很多，并且各种框架中也大量使用 debug 的日志，线上开启 debug 不久可能会打满磁盘，影响业务系统的正常运行。

12. 不要记录了异常，又抛出异常

反例如下：

  1. log.error("IO exception", e);
  2. throw new MyException(e);
  • 这样实现的话，通常会把栈信息打印两次。这是因为捕获了 MyException 异常的地方，还会再打印一次。
  • 这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑。

13. 避免重复打印日志

避免重复打印日志，酱紫会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印，反例如下：

  1. if(user.isVip()){
  2.   log.info("该用户是会员,Id:{}",user,getUserId());
  3.   //冗余，可以跟前面的日志合并一起
  4.   log.info("开始处理会员逻辑,id:{}",user,getUserId());
  5.   //会员逻辑
  6. }else{
  7.   //非会员逻辑
  8. }

如果你是使用 log4j 日志框架，务必在log4j.xml中设置 additivity=false，因为可以避免重复打印日志

正例：

  1. <logger name="com.taobao.dubbo.config" additivity="false">

14. 日志文件分离

  • 我们可以把不同类型的日志分离出去，比如 access.log，或者 error 级别 error.log，都可以单独打印到一个文件里面。
  • 当然，也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便啦。

15. 核心功能模块，建议打印较完整的日志

  • 我们日常开发中，如果核心或者逻辑复杂的代码，建议添加详细的注释，以及较详细的日志。
  • 日志要多详细呢？脑洞一下，如果你的核心程序哪一步出错了，通过日志可以定位到，那就可以啦。