Java日志规范

日志文件：

Logger.debug()：yyyy-mm-dd-debug.i.log  按天和200M滚动，打印调试信息，保留5天

Logger.info()：  yyyy-mm-dd-info.i.log    按天和200M滚动，打印业务日志，保留15天

Logger.error()： yyyy-mm-dd-error.i.log  按天和200M滚动， 打印错误信息，保留30天

日志格式：

yyyy-MM-dd HH:mm:ss.SSS 级别 IP 进程号 ---线程 类路径 - 消息内容

增加IP和进程号，便于确认具体实例

1.考虑日志对性能的影响:日志的频繁打印会对模块的性能产生极大的影响。当日志产生的速度大于日志文件写磁盘的速度，会导致日志内容积压在内存中，导致内存泄漏。

2.可对系统接口配置切面日志内容，避免打印重复内容，打印级别debug级别

3.在一个对象中通常只使用一个Logger对象，Logger应该是static final的，只有在少数需要在构造函数中传递logger的情况下才使用private final。

4.输出Exceptions的全部Throwable信息，因为logger.error(msg)和logger.error(msg,e.getMessage())这样的日志输出方法会丢失掉最重要的StackTrace信息。

5.不允许出现System print(包括System.out.println和System.error.println)语句。

6.不允许出现printStackTrace。

7.日志性能的考虑，如果代码为核心代码，执行频率非常高，慎用，不得不打印时最好使用

占位符可以减少参数构造的开销

8.只打印有意义的日志

通常情况下在程序日志里记录一些比较有意义的状态数据：程序启动，退出的时间点；程序运行消耗时间；耗时程序的执行进度；重要变量的状态变化。

9.在日志相关数据输出的时要特别注意对敏感信息的保护，比如身份证号、密码、余额等，不能将之输出到日志中，可做脱敏处理。

10.Log的内容一定要确保不会因为Log语句的问题而抛出异常造成中断，注意空指针等情况

反例：

//request对象如果是null，那么就会出现NPE。

log.debug("Processing request with id: {}", request.getId());

11.使用参数化信息的方式：禁止字符串拼接

LOGGER.debug("当前用户是:" + user + ",传入参数是:" + userId);

严禁使用字符串拼接的方式打印日志，可读性、可维护性都比较差。

建议的写法如下：

LOGGER.debug("当前用户是:{},传入参数是:{},返回值是:{},用户信息:{}", a,b new Object[]{token, userId, userInfo, authcInfo});

12.禁止直接在for循环中打印日志，特别是for循环特别大时

13.不打印无用、无意义、不完全的日志，建议使用主语+谓语+宾语+状语的格式

例如：log.warn("Unknown message type");

log.info("调用客户系统开始...");

log.info("调用客户系统结束...");

14.日志打印的时候，假如需要处理列表、数组类的数据，最好是只输出对象的大小，或者某些关键字段，例如：编号，如果将全部内容打印出来可能会占用大量的资源

15..需要明确对象的toString方法是否输出的东西就是你想要的东西，是否需要重写对象的toString方法

建议打印对象信息时，可以采用json格式打印，这样查看起来更清晰。

log.info("用户绑卡，实名校验，用户信息：{}", JSONObject.toJSONString(userInfo));