SLF4J——Simple Logging Facade For Java,它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback,commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口,而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。
Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。
默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。在运行应用程序和其他例子时,你应该已经看到很多INFO级别的日志了。
从上图可以看到,日志输出内容元素具体如下:
假如maven依赖中添加了spring-boot-starter-logging:
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-loggingartifactId>
dependency>
那么,我们的Spring Boot应用将自动使用logback作为应用日志框架,Spring Boot启动的时候,由org.springframework.boot.logging.Logging-Application-Listener根据情况初始化并使用。
但是呢,实际开发中我们不需要直接添加该依赖,你会发现spring-boot-starter其中包含了 spring-boot-starter-logging,该依赖内容就是 Spring Boot 默认的日志框架 logback。
默认配置属性支持
Spring Boot为我们提供了很多默认的日志配置,所以,只要将spring-boot-starter-logging作为依赖加入到当前应用的classpath,则“开箱即用”。
下面介绍几种在application.yml就可以配置的日志相关属性。
控制台输出
日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。
Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。
在application.yml中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别
# 日志配置
debug: true
文件输出
默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。如果要编写除控制台输出之外的日志文件,则需在application.yml中设置logging.file或logging.path属性。
如果只配置 logging.file,会在项目的当前路径下生成一个 xxx.log 日志文件。
# 日志配置
logging:
file: log/AhutOne.log
如果只配置 logging.path,在 /log/myLog文件夹生成一个日志文件为 spring.log
# 日志配置
logging:
path: log/myLog
注:二者不能同时使用,如若同时使用,则只有logging.file生效
默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件,默认级别为:ERROR、WARN、INFO
所有支持的日志记录系统都可以在Spring环境中设置记录级别(例如在application.yml中)
格式为:’logging.level.* = LEVEL’
举例:
# 日志配置
logging:
level:
# com.ahut包下所有class以DEBUG级别输出
com.ahut: DEBUG
# root日志以WARN级别输出
root: WARN
由于日志服务一般都在ApplicationContext创建前就初始化了,它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。
根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:
Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项(下面会提到)。
上面是默认的命名规则,并且放在src/main/resources下面即可。
如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,可以通过logging.config属性指定自定义的名字:
# 日志配置
logging:
config: classpath:logging-config.xml
虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时Profile使用不同的日志配置,这个功能会很有用。
下面我们来看看一个普通的logback-spring.xml例子
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>logbackcontextName>
<property name="log.path" value=".\\test\\log\\" />
<property name="log.file" value=".\\test\\logback.log" />
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern>
encoder>
appender>
<appender name="file"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.file}file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}logback.%d{yyyy-MM-dd_HH-mm}.log
fileNamePattern>
<maxHistory>30maxHistory>
<totalSizeCap>1GBtotalSizeCap>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern>
encoder>
appender>
<root level="info">
<appender-ref ref="console" />
<appender-ref ref="file" />
root>
<logger name="com.ahut.mapper" level="DEBUG" additivity="false">
<appender-ref ref="console" />
<appender-ref ref="file" />
logger>
<springProfile name="test,dev">
<logger name="com.ahut.action" level="info" />
springProfile>
<springProfile name="prod">
<logger name="com.ahut.action" level="ERROR" />
springProfile>
configuration>
包含的属性根节点
的子节点:
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用
设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
<contextName>logbackcontextName>
用来定义变量值的标签,
有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过
定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
<property name="log.path" value=".\\logback.log" />
appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level
%logger{36} - %msg%npattern>
encoder>
appender>
表示对日志进行编码:
ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~
另一种常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志:
<appender name="file"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logback.%d{yyyy-MM-dd_HH-mm}.log
fileNamePattern>
<maxHistory>30maxHistory>
<totalSizeCap>1GBtotalSizeCap>
rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36}
- %msg%npattern>
encoder>
appender>
其中重要的是rollingPolicy的定义,上例中
定义了日志的切分方式——把每一天的日志归档到一个文件中,
表示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。
用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL,默认是DEBUG。
可以包含零个或多个元素,标识这个appender将会添加到这个loger。
"info">
ref ref="console" />
ref ref="file" />
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定
。
仅有一个name属性,一个可选的level和一个可选的addtivity属性。
<logger name="com.ahut.action"/>
将控制action包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级
的日志级别“info”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
将root的打印级别设置为“info”,指定了名字为“console”的appender。
当执行com.ahur.action.DemoAction类的demo方法时,DemoAction 在包com.ahur.actionr中,所以首先执行
,将级别为“info”及大于“info”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“console”的appender处理,“console”appender将信息打印到控制台;
<logger name="com.ahut.action" level="INFO" additivity="false">
<appender-ref ref="console" />
logger>
控制com.ahut.action.DemoAction类的日志打印,打印级别为“WARN”
additivity属性为false,表示此loger的打印信息不再向上级传递
指定了名字为“console”的appender
这时候执行com.ahut.action.DemoAction类的login方法时,先执行
,将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。
当然如果你把additivity=”false”改成additivity=”true”的话,就会打印两次,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。
据不同环境(prod:生产环境,test:测试环境,dev:开发环境)来定义不同的日志输出,在 logback-spring.xml中使用 springProfile 节点来定义,方法如下:
文件名称不是logback.xml,想使用spring扩展profile支持,要以logback-spring.xml命名
<springProfile name="test,dev">
<logger name="com.ahut.action" level="info" />
springProfile>
<springProfile name="prod">
<logger name="com.ahut.action" level="ERROR" />
springProfile>
可以启动服务的时候指定 profile (如不指定使用默认),如指定prod 的方式为:
java -jar xxx.jar –spring.profiles.active=prod
<logger name="com.ahut.mapper" level="DEBUG" additivity="false">
<appender-ref ref="console" />
<appender-ref ref="file" />
logger>
到此为止终于介绍完日志框架了,平时使用的时候推荐用自定义logback-spring.xml来配置,代码中使用日志也很简单,类里面添加
private Logger logger = LoggerFactory.getLogger(this.getClass());
即可。