通常，一般在程序上线之后，程序一旦发生异常，第一件事就是要弄清楚当时发生了什么、用户当时做了什么操作、环境有什么影响、数据有什么变化、是不是反复发生等，然后再进一步的确定大致是哪个方面的问题。确定是程序的问题之后再交由开发人员去重现、研究、提出解决方案。这时，日志就给我们提供了第一手的资料。因此，写好程序的日志可以帮助我们大大减轻后期维护压力。
1. 选择恰当的日志级别
常见的日志级别有 5 种，分别是： error、warn、info、debug、trace。日常开发中，我们需要选择恰当的日志级别，不要随手就是打印 info。
error： 错误日志，指比较严重的错误，对正常业务有影响，需要 运维配置监控的；
warn： 警告日志，一般的错误，对业务影响不大，但是需要 开发关注；
info： 信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
debug： 用于开发 DEBUG 的，关键逻辑里面的运行时数据；
trace： 最详细的信息，一般这些信息只记录到日志文件中。
2. 日志要打印出方法的入参、出参
我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志。哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。
3. 选择合适的日志格式
理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。
4.遇到if…else…等条件时，每个分支首行都尽量打印日志
当你碰到 if…else…或者switch 这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。
5.不能直接使用日志系统（Log4j、Logback）中的API，而是使用日志框架SLF4J中的API
SLF4J是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。
6.建议使用参数占位{}，而不是用+拼接
反例：
logger.info("Processing trade with id:" + id + " and symbol: " + symbol);
上面的例子中，使用 + 操作符进行字符串的拼接，有一定的性能损耗。
正例如下：
logger.info("Processing trade with id: {} and symbol : {} ", id, symbol);
我们使用了大括号 {} 来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。
7.建议使用异步的方式来输出日志
日志最终会输出到文件或者其它输出流中的，IO性能会有要求的。如果异步，就可以显著提升IO性能。
除非有特殊要求，要不然建议使用异步的方式来输出日志，可在配置文件中进行设置。
8.不要使用e.printStackTrace()
原因：
e.printStackTrace()： 打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。
e.printStackTrace()： 语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了，即内存满了，那么，用户的请求就会卡住。
9.异常信息不要只打一半，要输出全部错误信息
反例1：
try{
//业务代码处理
}catch (Exception e) {
//错误
LOG.error("你的程序异常啦")
}
异常e都没有打印出来，所以压根不知道出了什么类型的异常。
反例2：
try{
//业务代码处理
}catch (Exception e) {
//错误
LOG.error("你的程序异常啦", e.getMessage());
}
e.getMessage()不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。
正例：
try{
//业务代码处理
}catch (Exception e) {
//错误
LOG.error("你的程序异常啦", e);
}
10.不要记录了异常，又抛出异常
反例如下：
log.error("IO exception", e);
throw new MyException(e);
这样实现的话，通常会把栈信息打印两次。这是因为捕获了MyException异常的地方，还会再打印一次。
这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑。
11.避免重复打印日志
避免重复打印日志，这样会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印。
如果你是使用log4j日志框架，务必在log4j.xml中设置additivity=false，因为可以避免重复打印日志。
12.日志文件分离
我们可以把不同类型的日志分离出去，比如 access.log，或者 error 级别 error.log，都可以单独打印到一个文件里面。
当然，也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便。
13. 核心功能模块，建议打印较完整的日志
我们日常开发中，如果核心或者逻辑复杂的代码，建议添加详细的注释，以及较详细的日志。
日志要多详细呢？如果你的核心程序哪一步出错了，通过日志可以定位到，那就可以了。
