Java Slf4j日志框架

Java Slf4j日志框架

1. Slf4j日志框架

在开发实践中，不允许使用System.out.println()或类似的输出语句来输出显示关键数据（核心数据、敏感数据等），因为，如果是这样使用，无论是在开发环境，还是测试环境，还是生产环境中，这些输出语句都将输出相关信息，而删除或添加这些输出语句的操作成本比较高，操作可行性低。

推荐的做法是使用日志框架来输出相关信息！

当添加了Lombok依赖后，可以在需要使用日志的类上添加@Slf4j注解，然后，在类的任意中，均可使用名为log的变量，且调用其方法来输出日志（名为log的变量也是Lombok框架在编译期自动补充的声明并创建对象）！

在Slf4j日志框架中，将日志的可显示级别根据其重要程度（严重程度）由低到高分为：

• trace：跟踪信息
• debug：调试信息
• info：一般信息，通常不涉及关键流程和敏感数据
• warn：警告信息，通常代码可以运行，但不够完美，或不规范
• error：错误信息

在配置文件中，可以通过logging.level.包名.类名来设置当前类的日志显示级别，例如：

logging.level.cn.tedu.boot.demo.service.impl.AdminServiceImpl: info

当设置了显示的日志级别后，仅显示设置级别和更重要的级别的日志，例如，设置为info时，只显示info、warn、error，不会显示debug、trace级别的日志！

当输出日志时，通过log变量调用trace()方法输出的日志就是trace级别的，调用debug()方法输出的日志就是debug()级别的，以此类推，可调用的方法还有info()、warn()、error()。

在开发实践中，关键数据和敏感数据都应该通过trace()或debug()进行输出，在开发环境中，可以将日志的显示级别设置为trace，则会显示所有日志，当需要交付到生产环境中时，只需要将日志的显示级别调整为info即可！

默认情况下，日志的显示级别是info，所以，即使没有在配置文件中进行正确的配置，所有info、warn、error级别的日志都会输出显示。

在配置时，属性名称中的logging.level部分是必须的，在其后，必须写至少1级包名，例如：

logging.level.cn: trace

以上配置表示cn包及其子孙包下的所有类中的日志都按照trace级别进行显示！

在开发实践中，属性名称通常配置为logging.level.项目根包，例如：

logging.level.cn.tedu.boot.demo: trace

在使用Slf4j时，通过log调用的每种级别的方法都被重载了多次（各级别对应除了方法名称不同，重载的次数和参数列表均相同），推荐使用的方法是参数列表为(String format, Object... arguments)的，例如：

public void trace(String format, Object... arguments);
public void debug(String format, Object... arguments);
public void info(String format, Object... arguments);
public void warn(String format, Object... arguments);
public void error(String format, Object... arguments);

以上方法中，第1个参数是将要输出的字符串的模式（模版），在此字符串中，如果需要包含某个变量值，则使用{}表示，如果有多个变量值，均是如此，然后，再通过第2个参数（是可变参数）依次表示各{}对应的值，例如：

log.debug("加密前的密码：{}，加密后的密码：{}", password, encodedPassword);

使用这种做法，可以避免多变量时频繁的拼接字符串，另外，日志框架会将第1个参数进行缓存，以此提高后续每一次的执行效率。

在开发实践中，应该对程序执行关键位置添加日志的输出，通常包括：

• 每个方法的第1行有效语句，表示代码已经执行到此方法内，或此方法已经被成功调用
  • 如果方法是有参数的，还应该输出参数的值
• 关键数据或核心数据在改变之前和之后
  • 例如对密码加密时，应该通过日志输出加密前和加密后的密码
• 重要的操作执行之前
  • 例如尝试插入数据之前、修改数据之前，应该通过日志输出相关值
• 程序走到某些重要的分支时
  • 例如经过判断，走向抛出异常之前

其实，Slf4j日志框架只是日志的一种标准，并不是具体的实现（感觉上与Java中的接口有点相似），常见有具体实现了日志功能的框架有log4j、logback等，为了统一标准，所以才出现了Slf4j，同时，由于log4j、logback等框架实现功能并不统一，所以，Slf4j提供了对主流日志框架的兼容，在Spring Boot工程中，spring-boot-starter就已经依赖了spring-boot-starter-logging，而在此依赖下，通常包括Slf4j、具体的日志框架、Slf4j对具体日志框架的兼容。

我是将军；我一直都在，。！