spring boot项目中使用logback日志详解

1. spring boot中的默认日志

SpringBoot为Java Util Logging，Log4J2和Logback提供了默认配置。SpringBoot默认配置日志输出到控制台，同时还提供可选文件输出。
SpringBoot默认采用SLF4j（日志抽象层）+ Logback（日志实现）的组合。

1.1 日志门面slf4j与日志实现logback

SLF4J——Simple Logging Facade For Java，它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有log4j, logback，java.util.logging,，commons-logging, Spring框架使用的Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口，而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。默认情况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。在运行应用程序和其他例子时，你应该已经看到很多INFO级别的日志了。

我们每次启动项目时，总会看到控制台打印如此内容：

从上图可以看到，日志输出内容元素具体如下：
时间日期：精确到毫秒
日志级别：ERROR, WARN, INFO, DEBUG or TRACE
进程ID
分隔符：— 标识实际日志的开始
线程名：方括号括起来（可能会截断控制台输出）
Logger名：通常使用源代码的类名
日志内容

可以看到，在不做任何配置的情况下，控制台已经有日志输出了。这也印证了我们前面所说的。

1.2 日志输出的形式

日志输出无非就两种方式：控制台输出、文件输出。无论哪一种输出方式，都要在application.properties中配置。文件输出还需要另外书写logback.xml配置文件。

1.2.1 application.properties中的日志通用配置

控制台常用配置详解

配置	解释	实例
logging.config	通过在类路径的根目录中或在Spring Environment属性logging.config指定的位置中提供适当的配置文件来进一步自定义各种日志记录系统	logging.config=classpath:logback-spring.xml 指定logback配置文件的路径
logging.level	作为package（包）的前缀来设置日志级别	logging.level.hpu.edu.xingsi.mapper=dubug 指定hpu.edu.xing.mapper包下的所有类的日志级别为dubug
logging.file.name	指定输出的日志文件的文件名	logging.file.name=xingsi.log
logging.file.path=	指定输出的日志文件的文件路径	logging.file.path=E:/xingsi
logging.exception-conversion-word	定义当日志发生异常时的转换字	logging.exception-conversion-word=%wEx
logging.file.max-size	默认当日志文件最大为10M，可以通过logging.file.max-size属性来调整大小	logging.file.max-size=20MB
logging.file.total-size-cap=	日志档案的总大小可以通过设置logging.file.total-size-cap的值来限定	logging.file.total-size-cap=1MB
logging.file.clean-history-on-start	当日志归档文件的总大小超过该阈值时，将删除备份。要在应用程序启动时强制进行日志归档清理，请使用logging.file.clean-history-on-start属性。	logging.file.clean-history-on-start=ture
logging.pattern.console=	指定日志输出到控制台的格式	logging.pattern.console="%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n"

在使用SpringBoot时收集日志时，如果你对日志的显示格式以及日志文件的输出内容没有特殊的要求时，我们都甚至不需要定义日志实现框架的配置文件，只需在SpringBoot的配置文件中添加基本日志配置即可满足我们的需求，当然这些配置项有些只是针对默认的logback才生效，基础配置项列表如下 ：

debug=false
trace=false
​# LOGGING
logging.config=
logging.exception-conversion-word=%wEx
logging.file=
logging.file.max-history=0
logging.file.max-size=10MB
logging.group.*=
logging.level.*=
logging.path=
logging.pattern.console=
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS
logging.pattern.file=
logging.pattern.level=%5
plogging.register-shutdown-hook=false

1、debug、trace属性

默认false，如果为true，则表示打开调试或跟踪模式，调试或跟踪模式只针对SpringBoot系统内部日志，并不是所有的日志都以debug级别显示，比如我们手动通过api输出的日志就不受影响。

2、logging.config属性

该属性指定日志配置文件的所在位置，默认会从classpath的根路径加载，如果两种方式都没有指定，则根据日志框架实现类型加载默认的日志配置文件（在框架内部）。

3、logging.exception-conversion-word属性

默认值“%wEx”，主要用彩色异常日志的格式化，不常用。

4、logging.file属性

只有在SpringBoot默认的日志配置下此属性才有意义，它指定日志文件生成的完整路径或相对路径。如果是ide运行项目则相对路径以src为基准，如果是可执行jar包，则以jar包为基准。

5、logging.path属性

只有在SpringBoot默认的日志配置下此属性才有意义，它指定生成的日志文件所在的文件夹的完整路径或相对路径，相对路径的基准目录同上。如果使用此属性，则生成的日志文件名称固定，为spring.log，而且如果同时配置了logging.file属性，则以logging.file属性配置位为准。

6、logging.file.max-size属性

此属性只在默认日志实现为logback并且loggin.file属性启用之后才生效，表示日志文件的大小，单位MB。如果日志文件超过此设置的之后，会自动生成一个压缩包，压缩包的命名规则：日志文件名称.log.xxxx-xx-xx.num。

7、logging.file.max-history属性

此属性只在默认日志实现为logback并且loggin.file属性启用之后才生效，表示生成的日志文件压缩包的存档时间，默认是0，表示永远存档，如果大于0表示最多保留x天。该属性只在6属性存在的情况下才有意义。

8、logging.group属性

此属性表示的是一个日志组，它的作用在于方便的控制某个组下的日志级别，例如：

#定义com.icypt.controller包下的日志，统一由controller组管理
logging.group.controller=com.icypt.controller
#控制日志组日志级别
loggin.level.contoller=info

SpringBoot也预定义了一些日志组，如下：

logging.group.web=org.springframework.core.codec, org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
logging.group.sql=org.springframework.jdbc.core, org.hibernate.SQL
所以我们在以后调试SpringBoot项目时可以通过这些预定义组来临时修改日志级别，是很方便的。

9、logging.level属性

此属性用于指定日志级别，其后可以跟root、组名称、包名称、包.类名等，例如：

logging.level.root=warn
logging.level.org.springframework.web=debug
logging.level.org.hibernate=error
这里有个优先级的问题需要注意一下：logging.level后跟的路径越详细优先级越高：

logging.level.包.类 > logging.level.包 > logging.level.组 > logging.level.root
10、格式化属性

logging.pattern.console= #格式化控制台打印的日志
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS #格式化日志日期时间
logging.pattern.file= #格式化输出到文件的日志
logging.pattern.level=%5p #格式化日志级别

11、logging.register-shutdown-hook属性

此属性默认值false，目前还未使用过此属性，不知其使用场景是什么，各位学友有谁知道，在公众号留言告诉我一下。
那么，如果你对日志记录要求不是很高，采用SpringBoot默认的logback日志框架再加上一些自定义的属性配置就可以完成日志的搜集工作了。如果以上这些设置还不能满足你的需求，就得自定义logback的配置文件了，当然也可以集成其他日志框架。

1.2.2 控制台输出配置

1.2.2.1 修改控制台中日志输出格式

application.properties中配置：

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n

控制台输出

1.2.2.2 修改控制台日志输出级别

logging.level.hpu.edu.xingsi.mapper=error

1.2.3 文件输出

1.2.3.1 指定输出格式

application.properties中配置：

logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n

解释一下上面配置的格式：

• %d{yyyy-MM-dd HH:mm:ss.SSS}——日志输出时间
• %thread——输出日志的进程名字
• %-5level——日志级别，并且使用5个字符靠左对齐
• %logger——日志全类名长度限定为50
• %msg——日志消息
• %n——平台的换行符

1.2.3.2 指定日志文件的路径

logging.file.name=e:/log/file.log

1.2.3.3 滚动输出

logging.file.max-size:单个日志文件的最大大小(大于此大小时，保留日志存档，并创建一个新的日志文件)，默认10M
logging.file.max-history:设置最大存档数，如果不设置此项，则会无限存档(SpringBoot 2.1+默认为7)。
logging.file.total-size-cap:配置日志的总大小，超过此大小将删除备份

基本上在spring boot的配置文件application.properties中能够使用的配置也就那么多了，在很大层度上都可以满足日常项目的使用，但是当SpringBoot提供的日志功能满足不了我们的需求时，就需要用到自定义日志配置了（比如高并发环境下，为了尽可能的不让日志拖慢程序运行速度，需要将Logback配置成异步日志记录器）

2. 自定义日志配置

3. 注意事项

记录日志的时候我们可能需要在文件中记录下异常的堆栈信息，经过测试，logger.error(e) 不会打印出堆栈信息，正确的写法是：

logger.error("程序异常, 详细信息:{}", e.getLocalizedMessage() , e);