T31实战-Day6：Java日志设计

T31实战-Day6：Java日志设计

1.使用日志框架 SLF4J 中的 API，使用门面模式的日志框架。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


private static final Logger logger = LoggerFactory.getLogger(App.class);
复制代码

2.日志文件保存 30 天。

3.应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。例如，t31应用中余票监控时区转换异常：

t31_monitor_timeZoneConvert.log
复制代码

• logType:日志类型，推荐 分类有 stats/monitor/visit 等；
• logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
• 正例：mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log
• 说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。

4.对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。

• 说明：logger.debug("Processing trade with id: " + id + " and symbol: " + symbol); 如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接 *** 作，如果 symbol 是对象，会执行 toString()方法，浪费了系统资源，执行了上述 *** 作，最终日志却没有打印。

• 正例：（条件）

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
}
复制代码

正例：（占位符）

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);
复制代码

5.避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。正例：

复制代码

6.异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。

正例：logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

7.谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

8.可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

• 说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

• 按照日志目的不同，将日志的级别由低到高分成五个级别：

1. DEBUG-表示输出的日志为一个调试信息;
2. INFO-表示输出的日志是一个系统提示;
3. WARN-表示输出的日志是一个警告信息;
4. ERROR-表示输出的日志是一个系统错误;
5. FATAL-表示输出的日志是一个导致系统崩溃严重错误。