系统程序Log日志编码规范.pdf

系统开发 log 日志使用规范 目的 在系统开发过程中，项目经理都非常强调编码中 log 的重要性，并且强迫每个程序员 都要求写 log。但是为啥要写 log，怎么写 log，却很少有人去说去讲，让大家明白写 log 的 目的性，有利于大家理解这样的行为。 现在我们就来讨论一下写 log 是目的是什么? 在代码中嵌入 log 代码信息，主要记录下列信息： 1、 记录系统运行异常信息。 2、 记录系统运行状态信息。 3、 记录系统运行性能指标。 通过对上述信息分析和诊断，我们能采取正确的手段来提高系统质量 和 提升系统性 能。 Java 日志组件选型 针对 spring 容器进行日志选型：选择 slf4j + 自己想用的实现 log 类（ 推荐采用 log4j）。 选择 slf4j 的理由： 1、 可以和多种实现融合，具体实现 log 类，只要替换响应的 jar，对应用程序不要做任何修 改。 2、 编码简化了，不需要判断是否需要输入的 if-else 语句，通过可变参量格式化输出，方便 书写 3、 当系统发布正常运行时，需要关闭 log 时，只要把对应的实现 jar 删除即可。 4、 解决项目中多个 log 组件冲突问题，通过引入一个 slf4j 来实现所有的日志组件自由切换。 在系统开发项目总需要引入以下文件： Slf4j-api.jar Slf4j-log4j.jar Log4j.jar Lperties 日志类型 主要分三大类： 安全类信息：记录系统边界交互行为和信息 业务类信息：记录系统内部业务处理行为和信息 性能类信息：记录系统硬件对业务处理的支撑能力 日志级别 一般分五级： ERROR（错误）：此信息输出后，主体系统核心模块正常工作，需要修复才能正常工作。 WARN（警告）：此信息输出后，系统一般模块存在问题，不影响系统运行。 INFO（通知）：此信息输出后，主要是记录系统运行状态等关联信息 DEBUG（调试）：最细粒度的输出，除却上面各种情况后，你希望输出的相关信息， 都可以在这里输出。 TRACE（跟踪）：最细粒度的输出，除却上面各种情况后，你希望输出的相关信息，都 可以在这里输出。（我们系统中不采用此级别） 日志记录准则 ERROR WARN INFO DEBUG 安全类信息 合法拒绝 正常 其他 业务类信息 重 要 模 块 异 一般模块异常 正常 其他 常 性能类信息 超越指标信息 正常 其他 日志记录代码规范 这里的细则以标准的三层架构来分析，包括表示层/接口层、业务层、存储层。 需要写日志的 java 类请加入以下代码：（实现 log 日志功能） import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class HelloWorld { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(HelloWorld.class); (Hello World);