Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。
1.添加日志依赖
加入maven依赖中添加了spring-boot-starter-logging:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
2.自定义日志配置
由于日志服务一般都在ApplicationContext创建前就初始化了,它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。
根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:
- Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
- Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
- Log4j2:log4j2-spring.xml, log4j2.xml
上面是默认的命名规则,并且放在src/main/resources下面即可。
logback.xml的相关配置:
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 second" debug="false">
<include resource="org/springframework/boot/logging/logback/base.xml"/>
<logger name="org.springframework.web" level="DEBUG"/>
<property name="LOG_ROOT" value="/ms-logs"/>
<property name="LOG_PATH" value="ms-dataDictionary"/>
<property name="LOG_HOME" value="${LOG_ROOT}/${LOG_PATH}"/>
<appender name="FILE-INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>
[ %d{yyyy-MM-dd HH:mm:ss.SSS} ] [ %-5level] [ %-4line] --- [ %21thread ] %logger{96}: %msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/INFO.%i.log</fileNamePattern>
<maxHistory>30</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>DENY</onMatch>
<onMismatch>ACCEPT</onMismatch>
</filter>
<prudent>true</prudent>
</appender>
<appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>
[ %d{yyyy-MM-dd HH:mm:ss.SSS} ] [ %-5level] [ %-4line] --- [ %21thread ] %logger{96}: %msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/ERROR.%i.log</fileNamePattern>
<maxHistory>30</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<prudent>true</prudent>
</appender>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>
[%d{yyyy-MM-dd HH:mm:ss.SSS}] [ %-5level] [ %-4line] --- [ %21thread ] %logger{32}: %msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="STDOUT"/>
<appender-ref ref="FILE-INFO"/>
<appender-ref ref="FILE-ERROR"/>
</root>
<!-- 开发、测试环境 -->
<springProfile name="dev,test">
<logger name="com.yss.ms" level="TRACE"/>
<logger name="com.mysql" level="WARN"/>
<logger name="com.alibaba" level="DEBUG"/>
<logger name="tk.mybatis" level="WARN"/>
<logger name="org.apache.commons" level="WARN"/>
<logger name="org.apache.xmlbeans" level="WARN"/>
<logger name="org.springframework.web" level="DEBUG"/>
</springProfile>
<!-- 生产环境 -->
<springProfile name="prod">
<logger name="com.yss.ms" level="INFO"/>
<logger name="com.mysql" level="INFO"/>
<logger name="com.alibaba" level="INFO"/>
<logger name="tk.mybatis" level="WARN"/>
<logger name="org.apache.commons" level="INFO"/>
<logger name="org.apache.xmlbeans" level="INFO"/>
<logger name="org.springframework" level="INFO"/>
</springProfile>
</configuration>
根节点<configuration>
包含的属性:
- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为十秒。
- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
根节点<configuration>
的子节点:
下面一共有2个属性,3个子节点,分别是:
属性一:设置上下文名称<contextName>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用<contextName>
设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
<contextName>logback</contextName>
属性二:设置变量<property>
用来定义变量值的标签,<property>
有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过<property>
定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
<property name="LOG_ROOT" value="/ms-logs"/>
<property name="LOG_PATH" value="ms-dataDictionary"/>
<property name="LOG_HOME" value="${LOG_ROOT}/${LOG_PATH}"/>
子节点一<appender>
appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
控制台输出ConsoleAppender:
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>
[%d{yyyy-MM-dd HH:mm:ss.SSS}] [ %-5level] --- [ %21thread ] %logger{32}: %msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
encoder表示对日志进行编码:
* %d{yyyy-MM-dd HH:mm:ss.SSS}——日志输出时间
* %thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
* %-5level——日志级别,并且使用5个字符靠左对齐
* %logger{32}——日志输出者的名字
* %msg——日志消息
* %n——平台的换行符
输出到文件RollingFileAppender:
<appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>
[ %d{yyyy-MM-dd HH:mm:ss.SSS} ] [ %-5level] [ %-4line] --- [ %21thread ] %logger{96}: %msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/ERROR.%i.log</fileNamePattern>
<maxHistory>30</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<prudent>true</prudent>
</appender>
rollingPolicy:
上例中<fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/ERROR.%i.log</fileNamePattern>
定义了日志的切分方式——把每一天的日志归档到一个文件中,<maxHistory>30</maxHistory>
表示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可以使用%d{yyyy-MM-dd}来定义精确的日志切分方式。<maxFileSize>64 MB</maxFileSize>
用来指定日志文件的上限大小,例如设置为64MB的话,那么到了这个值,就会删除旧的日志。
ThresholdFilter:
系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~
子节点二<root>
:
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
* level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,默认是DEBUG。
可以包含零个或多个<appender-ref>
元素,标识这个appender将会添加到这个loger:
<root level="INFO">
<appender-ref ref="STDOUT"/>
<appender-ref ref="FILE-INFO"/>
<appender-ref ref="FILE-ERROR"/>
</root>
多环境日志输出
据不同环境(prod:生产环境,test:测试环境,dev:开发环境)来定义不同的日志输出
<!-- 开发、测试环境 -->
<springProfile name="dev,test">
<logger name="com.yss.ms" level="TRACE"/>
<logger name="com.mysql" level="WARN"/>
<logger name="com.alibaba" level="DEBUG"/>
<logger name="tk.mybatis" level="WARN"/>
<logger name="org.apache.commons" level="WARN"/>
<logger name="org.apache.xmlbeans" level="WARN"/>
<logger name="org.springframework.web" level="DEBUG"/>
</springProfile>
可以启动服务的时候指定 profile (如不指定使用默认),如指定dev的方式为:
java -jar xxx.jar –spring.profiles.active=dev