Spring Boot 中如何使用 slf4j 日志

在我们之前用Spring框架或者其他东西时，我们总是习惯在代码中使用System.out.println()来输出一些信息，比如报错信息，或者输出一些提示文字等。但是这样不好，因为大量的使用 System.out 会增加资源的消耗。
所以，今天我们来说一说Spring Boot 中如何使用slf4j 日志。在此之前，我们先来回顾一下之前使用过的System.out方法

控制台打印输出日志
System.out.println(需要输出的内容字符串) 一般在开发阶段需要输出的信息较多，作为产品部署后则输出信息较少，引入了一种常量的定义方式以控制是否输出日志
可以通过 Constants 接口中的常量定义是否需要输出，或者使用 int 型来控制不同的输出等级
外观模式：【应用场景、优缺点、编码】，提醒大家必须记忆设计模式中的 6 大原则
为子系统中的一组接口提供一个一致的界面，外观模式定义了一个高层接口，这个接口使得这一子系统更加容易使用。可以降低访问复杂系统的内部子系统时的复杂度，简化客户端之间的接口。属于 23 种设计模式中的结构型设计模式
优点： 1、减少系统相互依赖。 2、提高灵活性。 3、提高了安全性。
缺点：不符合开闭原则，如果要改东西很麻烦，继承重写都不合适。
编码实现：
1、产品接口

public interface Shape {
public void draw();
}

2、具体实现

3、定义子系统的外观或者门面。该子系统中包括多个产品组件

class ShapeFacade {
private Circle circle;
private Square square;
public ShapeFacade(){
circle=new Circle();
square=new Square();
}
public void drawCircle(){
circle.draw();
}
public void drawSquare(){
square.hashCode();
}
public void drawCircleAndSqure(){
circle.draw();
square.draw();
}
}

其实，或许我们可以换一种思路来理解，
比如电脑，电脑整机是 CPU、内存、硬盘的外观。有了外观以后，启动电脑和关闭电脑都简化了。直接 new 一个电脑。在 new 电脑的同时把 cpu、内存、硬盘都初始化好并且接好线。对外暴露方法（启动电脑，关闭电脑）。
启动电脑（按一下电源键）：启动 CPU、启动内存、启动硬盘
关闭电脑（按一下电源键）：关闭硬盘、关闭内存、关闭 CPU

slf4j 介绍

我们还是老样子，先来认识一下slf4j ，了解一下他的背景用法等再去使用
SLF4J 即简单日志门面，不是具体的日志解决方案，它只服务于各种各样的日志系统。按照官方的说法，SLF4J
是一个用于日志系统的简单 Facade，允许最终用户在部署其应用时使用其所希望的日志系统。
这里的意思是：只需要按统一的方式写记录日志的代码，而无需关心日志是通过哪个日志系统，以什么风格输
出的。因为它们取决于部署项目时绑定的日志系统。例如，在项目中使用了 slf4j 记录日志，并且绑定了 log4j，
即导入相应的依赖，则日志会以 log4j 的风格输出；后期需要改为以 logback 的风格输出日志，只需要将 log4j
替换成 logback 即可，不用修改项目中的代码。这对于第三方组件的引入的不同日志系统来说几乎零学习成本，
况且它的优点不仅仅这一个而已，还有简洁的占位符的使用和日志级别的判断。

当然，他也有漏洞

了解清楚优缺点等我们就可以根据写的步骤来进行学习使用了，比如我们一般写代码的第一步就是添加依赖

1.添加依赖

2.写配置文件

在 resources 根目录下创建一个 log4j 的配置文件 log4j.properties

log4j.rootLogger=DEBUG, stdout 根日志记录器，参数 1 为需要输出的日志等级，
参数 2 为日志输出的目标地名称 stuout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 设置 stdout 是控制台
输出
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 配置日志输出的
格式
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

3、编程中使用日志记录器输出用户自定义日志信息

Log4j 输出的目的地
org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
SpringBoot 输出日志
debug:
true 在 SpringBoot 框架启动时自动输出日志信息，同时显示相互之间的依赖关系。仅仅用于开发阶段，产品阶段一定关闭，或者删除该配置

正因为 sfl4j 有如此多的优点，阿里已经将 slf4j 作为他们的日志框架了。在《阿里 Java 开发手册(正式版)》中，
日志规约一项第一条就强制要求使用 slf4j：

• 1.【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，

使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
强制两个字体现出了 slf4j 的优势，所以建议在实际项目中，使用 slf4j 作为自己的日志框架。使用 slf4j 记录日
志非常简单，直接使用 LoggerFactory 创建即可。
目前 SpringBoot 针对日志系统默认采用 logback
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Test {
private static final Logger logger = LoggerFactory.getLogger(Test.class);
// ……
}

• application.yml 中对日志的配置

Spring Boot 对 slf4j 支持的很好，内部已经集成了 slf4j，一般在使用的时候，会对 slf4j 做一下配置。
application.yml 文件是 Spring Boot 中唯一需要配置的文件，一开始创建工程的时候是 application.properties
文件，一般推荐使用 yml 文件，因为 yml 文件的层次感特别好，看起来更直观，但是 yml 文件对格式要求比
较高，比如英文冒号后面必须要有个空格，否则项目估计无法启动，而且也不报错。用 properties 还是 yml
视个人习惯而定，实际上都是可以的。
application.yml 文件中对日志的配置：
logging:
config: logback.xml
level: 针对不同的包可以设置不同的日志输出等级，基本格式为【包名称: 等级】
com.yan.dao: trace
logging.config 是用来指定项目启动的时候，读取哪个配置文件，这里指定的是日志配置文件是根路径下的
logback.xml 文件，关于日志的相关配置信息，都放在 logback.xml 文件中了。logging.level 是用来指定具体的
mapper 中日志的输出级别，例如配置表示 com.yan.dao 包下的所有 mapper 日志输出级别为 trace，会将操作
数据库的 sql 打印出来，开发时设置成 trace 方便定位问题，在生产环境上，将这个日志级别再设置成 error
级别即可。
常用的日志级别按照从高到低依次为：ERROR、WARN、INFO、DEBUG 和 TRACE。可以通过日志输出等级来控制日志输出的详细程度

• logback.xml 配置文件解析

在 application.yml 文件中，指定了日志配置文件 logback.xml，logback.xml 文件中主要用来做日志的相关配置。
在 logback.xml 中可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长等。

3.1 定义日志输出格式和存储路径

<configuration> 可以理解为定义常量，name 就是常量名称，value 就是对应的值
<property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level
%logger{36} - %msg%n" />
<property name="FILE_PATH" value="D:/logs/demo.%d{yyyy-MM-dd}.%i.log" />
</configuration>

配置文件的含义：首先定义一个格式，命名为 LOG_PATTERN，该格式中%date 表示日期，%thread 表示线程
名，%-5level 表示级别从左显示 5 个字符宽度，%logger{36}表示 logger 名字最长 36 个字符，%msg 表示日
志消息，%n 是换行符。
然后再定义一下名为 FILE_PATH 文件路径，日志都会存储在该路径下。%i 表示第 i 个文件，当日志文件达到
指定大小时，会将日志生成到新的文件里，这里的 i 就是文件索引，日志文件允许的大小可以设置。这里需要
注意的是，不管是 windows 系统还是 Linux 系统，日志存储的路径必须要是绝对路径。

• 3.2 定义控制台输出

<configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder><!-- 按照上面配置的 LOG_PATTERN 来打印日志 -->
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
</configuration>
使用<appender>节点设置个控制台输出 class="ch.qos.logback.core.ConsoleAppender"的配置，定义为
CONSOLE。使用上面定义好的输出格式 LOG_PATTERN 来输出，使用${}引用进来即可。

• 3.3 定义日志文件的相关参数

<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 按照上面配置的 FILE_PATH 路径来保存日志 -->
<fileNamePattern>${FILE_PATH}</fileNamePattern>
<maxHistory>15</maxHistory> 日志保存 15 天
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize> 单个日志文件的最大，超过则新建日志文件存储
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>

<!-- 按照上面配置的 LOG_PATTERN 来打印日志 -->
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
</configuration>
使用<appender>定义一个名为 FILE 的文件配置，主要是配置日志文件保存的时间、单个日志文件存储的大小、
以及文件保存的路径和日志的输出格式

3.4 定义日志输出级别

<configuration>
<logger name="com.yan" level="INFO" />
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</configuration>

有了上面那些定义后，最后使用来定义一下项目中默认的日志输出级别，这里定义级别为 INFO，然后针对 INFO 级别的日志，使用引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml文件中的配置就设置完了。

4. 使用 Logger 在项目中打印日志

在代码中一般使用 Logger 对象来打印出一些 log 信息，可以指定打印出的日志级别，也支持占位符，很方便。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/test")
public class TestController {
private final static Logger logger = LoggerFactory.getLogger(TestController.class);
@RequestMapping("/log")
public String testLog() {
logger.debug("=====测试日志 debug 级别打印====");
logger.info("======测试日志 info 级别打印=====");
logger.error("=====测试日志 error 级别打印====");
logger.warn("======测试日志 warn 级别打印=====");
// 可以使用占位符打印出一些参数信息
String str1 = "blog.yan.com";
String str2 = "blog.csdn.net/yanjun";

// 输出日志内容时，允许使用{}表示一个占位符，后续参数按照位置对应进行赋值
logger.info(“======张三的个人博客：{}；张三的 CSDN 博客：{}”, str1, str2);
return “success”;
}
}
启动该项目，在浏览器中输入 localhost:8080/test/log 后可以看到控制台的日志记录：

> ======测试日志 info 级别打印=====
> =====测试日志 error 级别打印====
> ======测试日志 warn 级别打印=====
> ======张三的个人博客：blog.yan.com；闫峻的 CSDN 博客：blog.csdn.net/张三

因为 INFO 级别比 DEBUG 级别高，所以 debug 这条没有打印出来，如果将 logback.xml 中的日志级别设置成DEBUG，那么四条语句都会打印出来可以测试。同时可以打开 D:\logs\demo\目录，里面有刚刚项目启动，以后后面生成的所有日志记录。在项目部署后，大部分都是通过查看日志文件来定位问题。

总结

本篇主要介绍 slf4j 的使用，并且对 Spring Boot 中使用 slf4j 输出日志有详细的说明，重点是分析 logback.xml 文件中对日志相关信息的配置，包括日志的不同级别。最后针对这些配置，在代码中使用 Logger 打印出一些进行测试。在实际项目中，这些日志都是排查问题的过程中非常重要的资料。