一、Springboot日志简介
Spring Boot在所有内部日志中使用Commons Logging,但是默认配置也提供了对常用日志的支持,如:Java Util Logging,Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。
二、SpringBoot默认配置日志的使用
格式化日志
默认格式化日志输入为:
2018-09-28 13:22:50.801 ERROR 7852 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是error日志...
输出内容元素具体如下:
- 时间日期 — 精确到毫秒
- 日志级别 — ERROR, WARN, INFO, DEBUG or TRACE(级别由高到低)
- 进程ID
- 分隔符 —
---
标识实际日志的开始 - 线程名 — 方括号括起来(可能会截断控制台输出)
- Logger名 — 通常使用源代码的类名
- 日志内容
控制台输出
在Spring Boot中默认只配置了ERROR
、WARN
和INFO
级别的日志输出到控制台。
@Test
public void testLog() {
/**
* 日志的级别
* 1.由低到高 trace<debug<info<warn<error
* 2.可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效
*/
logger.trace("这是trace日志...");
logger.debug("这是debug日志...");
//默认是不会输入trace、debug级别的日志、只输出info、warn、error日志
/**
* SpringBoot默认给我们使用的是info级别的,
* 没有指定级别的就用SpringBoot默认规定的级别;root级别
*/
logger.info("这是info日志...");
logger.warn("这是warn日志...");
logger.error("这是error日志...");
}
控制台输出的日志:
2018-09-28 15:35:12.013 INFO 6912 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是info日志...
2018-09-28 15:35:12.014 WARN 6912 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是warn日志...
2018-09-28 15:35:12.014 ERROR 6912 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是error日志...
如何控制台可以打印trace、debug日志?
方法:在application.properties配置
#配置级别为trace,控制台打印所有级别日志
logging.level.com.wang.logging=trace
2018-09-28 15:51:19.553 TRACE 7512 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是trace日志...
2018-09-28 15:51:19.554 DEBUG 7512 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是debug日志...
2018-09-28 15:51:19.554 INFO 7512 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是info日志...
2018-09-28 15:51:19.554 WARN 7512 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是warn日志...
2018-09-28 15:51:19.554 ERROR 7512 --- [ main] c.w.l.SpringbootLoggingApplicationTests : 这是error日志...
文件输出
Spring Boot默认配置只会输出到控制台,并不会记录到文件中,但是我们通常生产环境使用时都需要以文件方式记录。
若要增加文件输出,需要在application.properties
中配置logging.file
或logging.path
属性。
- logging.file,设置文件,可以是绝对路径,也可以是相对路径。如:
logging.file=springboot.log或logging.file=D:/springboot.log
- logging.path,设置目录,会在该目录下默认创建spring.log文件,并写入日志内容,如:
logging.path=/Logging/log
注意--
logging.path=log会在项目下创建log文件夹并生成spring.log文件
自定义输出格式
在Spring Boot中可以通过在application.properties
配置如下参数控制输出格式:
###########日志格式###############
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%‐5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
# 在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
三、自定义日志文件的使用
现在我们不再使用SpringBoot默认日志框架,现在选用Logback日志框架,操作步骤如下:
在Resource文件下放上每个日志框架自己的配置文件即可,SpringBoot就不使用他默认配置的!
Logging System | Customization |
Logback | logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) |
logging.properties |
logback.xml:直接就被日志框架识别!
logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot 的高级Profile功能!
<springProfile name="staging">
<!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
可以指定某段配置只在某个环境下生效
</springProfile>
比如:
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<!-- 开发环境输出的日志格式-->
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>
logback-spring.xml必须放在Resource目录下!
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!-- 定义日志的根目录:比如项目在F盘,日志就在F盘 -->
<property name="LOG_HOME" value="/app/log"/>
<!-- 定义日志文件名称 -->
<property name="appName" value="springboot-logging"></property>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>
<!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_HOME}/${appName}.log</file>
<!--
当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动
%i:当文件大小超过maxFileSize时,按照i进行文件滚动
-->
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是,
那些为了归档而创建的目录也会被删除。
-->
<MaxHistory>365</MaxHistory>
<!--
当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 文件日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
</layout>
</appender>
<!--
logger主要用于存放日志对象,也可以定义日志类型、级别
name:表示匹配的logger类型前缀,也就是包的前半部分
level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出,
false:表示只用当前logger的appender-ref,true:
表示当前logger的appender-ref和rootLogger的appender-ref都有效
-->
<!-- hibernate logger -->
<logger name="com.wang" level="debug"/>
<!-- Spring framework logger -->
<logger name="org.springframework" level="debug" additivity="false"/>
<!--
root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="stdout"/>
<appender-ref ref="appLogAppender"/>
</root>
</configuration>