Spring Boot项目使用SLF4J 和LogBack

概述

前文使用Spring Boot创建了SSM的项目（前文链接：https://www.jianshu.com/p/901a258df1b8）现在进行SLF4J和LogBack的使用和配置。

SLF4J

Simple Logging Facade for Java，简单日志门面，不是具体的日志解决方案，它提供日志框架的简单抽象，单独的SLF4J并不能工作，犹如JDBC，它为Java应用提供日志输出的统一接口，必须搭配LogBack或Log4J等使用。

LogBack

LogBack和Log4J是同一个作者，LogBack相当于Log4J的进阶版，相比Log4J有很多优势，诸如：更快的实现、充分的测试等等，所以此处使用LogBack。

配置

日志信息打印控制台

由于Spring Boot的核心依赖已经包含了SLF4J、LogBack和Log4J：

logback01.png

所以使用Spring Boot创建SSM项目完成之后，默认已经配置了日志，并且默认日志级别是info，这一点从启动日志中也能看到，默认的日志框架为LogBack：

logback02.png

默认的日志是只打印到控制台上，日志的级别从低到高：TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为INFO，则低于INFO的信息都不会输出。
日志从左向右依次显示的内容是：

日期时间、日志级别、进程ID、分隔符、线程名、logger名、具体的日志信息。
日志默认不会写到日志文件中：

logback03.png

项目目录中没有任何log文件，可以在application.yml文件中进行级别的配置，将级别设置成debug：

logback04.png

启动项目：

logback05.png

此时日志debug级别已经设置成功。
级别控制：此处配置的是logging.level.root。
其中root也可以替换为项目目录下的某个包，这样就能不同的包配置不同的日志级别了。

生成日志信息文件

将日志信息写入日志文件的设置：

logback06.png

其中${spring.application.name}.log意思是日志文件名字为项目名，启动项目：

logback07.png

此时可以看到在项目目录下生成了sysmanagement.log文件，日志信息已经写入文件中。
可以定义一个logs目录，专门用来存放日志文件，先将这个日志文件删除，为了缩短启动时间，将日志级别设置回info：

logback08.png

启动项目：

logback09.png

此时在项目目录下生成了logs文件夹，并且生成了默认名称为spring.log的日志文件，这里将file行的配置进行了注释，是因为path和file不能同时配置，若二者同时配置，只有file生效，即只在项目目录下生成sysmanagement.log文件，不会生成logs文件夹。

使用logback-spring.xml文件自定义配置日志

可以通过外部配置文件进行项目的日志控制个管理。
由于不同的日志系统，需要不同的配置文件名称来进行正确的加载，其中-spring是Spring Boot官方推荐的优先使用的，所以LogBack框架的配置文件名就是logback-spring.xml ，该文件默认放在项目的resources目录下即可。
将刚才在application.yml文件中关于日志文件的配置信息和项目目录中的logs文件夹一同删除。
下面是项目配置文件的xml：

logback10.png

启动完成后，控制台打印的日志：

logback11.png

项目目录结构中生成的日志文件，在项目目录下的logs目录中：

logback12.png

可以看到生成了debug和info两个不同级别的日志文件。
然后来看一下配置文件中的各项配置说明：
节点：

scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时，将打印出LogBack内部日志信息，实时查看LogBack运行状态。默认值为false。
节点配置了两个属性和三个子节点：
第一个属性：，logger默认上下文的名字是“default”，用这个属性可以自定义该名称，用于区分不同应用，一旦设置，不可修改。
第二个属性： ，用来设置变量，有两个属性，name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。
这里设置的是在项目目录下生成logs目录用来存放生成的日志文件。

第一个子节点：，设置日志输出策略，有两个属性，name用来定义名称，class用来定义输出策略的类别，通常设置的策略是输出到控制台和输出到文件。

• 输出到控制台

  
  
  logback13.png

输出级别是info，是设置了${CONSOLE_LOG_PATTERN}变量的值，用来将在控制台输出的日志信息进行格式化和彩色化，由于在未使用自定义配置文件时，Spring Boot默认集成的logging的依赖包中由default.xml，其中包含了打印信息彩色化的配置，所以由前面的截图中可以看到控制台打印的信息也是彩色的。

logback14.png

具体的变量设置是在这里，由于CONSOLE_LOG_PATTERN的值太长，于是做了换行可以看得更清楚：

logback15.png

• 输出到文件
  输出到文件的中class可以设置为class="ch.qos.logback.core.FileAppender"，这样就可以将日志信息输出到一个指定的日志文件中了，但是随着系统运行时间不断写入日志信息，仅仅写入一个文件，这个日志文件会越来越大，这样会对阅读日志信息和服务硬盘空间资源使用等等造成困扰，所以这里配置选用了class="ch.qos.logback.core.rolling.RollingFileAppender"，滚动输出到文件，当日志信息记录到符合某一条件时，切分记录到新文件。

  
  
  logback16.png

日志信息写入的文件名，${LOG_PATH}/log_debug.log，是组合前面定义的路径变量，将日志文件log_debug.log写入项目目录的logs目录下。
定义了文件输出的格式和字符编码。
设置class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"，基于时间制定滚动策略。定义了日志文件归档的路径和文件名称。
策略可以进行嵌套，
设置 class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"设置对单个文件大小的判断，定义的单个文件最大值，当文件超过50M时，触发归档，归档时的文件名log-debug-%d{yyyy-MM-dd}.%i.log是组合了时间的名称，其中的%i是定义了规避同一天多个归档文件同名的问题。
15定义了文件最多只保留15日的。
设置class="ch.qos.logback.classic.filter.LevelFilter"，定义了日志文件只记录某一个级别，这样在配置文件中可以分开记录不同级别的日志信息到对应的日志文件中（示例中定义了debug和info两个级别）。

第二个子节点：用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。
例如：


仅有一个name属性，一个可选的level和一个可选的addtivity属性。
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别，如果未设置此属性，那么当前logger将会继承上级的级别。
addtivity:是否向上级logger传递打印信息。默认是true。

第三个子节点：root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性，用来设置打印级别，不能设置为INHERITED或者同义词NULL。默认是DEBUG，可以包含零个或多个元素，标识这个appender将会添加到这个logger。

使用mybatis的时候，sql语句是debug下才会打印，而这里只配置了info，所以想要查看sql语句的话，有以下两种操作：
第一种把改成这样就会打印sql，不过这样日志那边会出现很多其他消息。
第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：

至此，Spring Boot创建SSM项目的日志配置和基本使用就完成了。