Spring 日志规范

1、日志的作用

     日志是在系统运行过程中关键的节点的数，这个些日志的记录方便当系统出现问题方便问题查找。 打印参数必须是有意义，连贯的。以方便快速定位问题。

2、日志打印规范

常规日志规范写法：

logger.info("验证码: {} ", code);

logger.info("请求参数:{}，验证码: {} ", param,code);

logger.info( String.format("请求参数姓名:%s, 请求参数年龄:%d",name ,age));

这些遵从简洁命了，可读性强。不规范的写法如下

logger.info(”###### code 验证码:+ code):

logger.info("验证码登录 jsonResult :"+ JSONObject.toJsONstring(jsonResult));

异常日志规范写法：

logger. error("登录发送验证码异常，手机号码:{}，异常详情:{}",phone,e);

异常日志不规范写法

logger.error(e.getMessage());

说明e.getMessag(),只能告诉你出现什么异常，并没有告诉的你是哪行报出来的异常。2、是什么业务场景、业务关键字都没有记录。

此外有些人try  catch时候直接e.printStackTrace()，首先这样写不会记录到日志文件。并且会占用内存。消耗系统性能。

debug日志建议生产环境关闭。

日志中打印的注意敏感字段要进行脱敏处理

3、日志文件

以logback 为例，一般以日期创建日志文件，例如配置如下

<!-- 循环政策：基于时间创建日志文件 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <!-- 日志文件名格式 -->
    <fileNamePattern>${log.home}/info/%d{yyyy-MM-dd}-info.log</fileNamePattern>
    <!-- 最大保存时间：30天-->
    <maxHistory>30</maxHistory>
</rollingPolicy>