本文介绍了Spring Boot中日志的配置，包括日志级别、输出格式的设定，以及如何自定义日志配置。Spring Boot默认使用SLF4J+Logback，允许通过application.properties/yml进行简单配置，或使用logback.xml、logback-spring.xml等配置文件实现更复杂的设置。带有'spring'标识的配置文件支持Spring Boot的Profile特性，允许在不同环境中使用不同日志配置。
Spring Boot 默认使用 SLF4J+Logback 记录日志，并提供了默认配置，即使我们不进行任何额外配，也可以使用 SLF4J+Logback 进行日志输出。
常见的日志配置包括日志级别、日志的输入出格式等内容。
日志级别
日志的输出都是分级别的，当一条日志信息的级别大于或等于配置文件的级别时，就对这条日志进行记录。
常见的日志级别如下（优先级依次升高）
|
序号 |
日志级别 |
说明 |
|
1 |
trace |
追踪，指明程序运行轨迹。 |
|
2 |
debug |
调试，实际应用中一般将其作为最低级别，而 trace 则很少使用。 |
|
3 |
info |
输出重要的信息，使用较多。 |
|
4 |
warn |
警告，使用较多。 |
|
5 |
error |
错误信息，使用较多。 |
输出格式
我们可以通过以下常用日志参数对日志的输出格式进行修改，如下表。
|
序号 |
输出格式 |
说明 |
|
1 |
%d{yyyy-MM-dd HH:mm:ss, SSS} |
日志生产时间,输出到毫秒的时间 |
|
2 |
%-5level |
输出日志级别，-5 表示左对齐并且固定输出 5 个字符，如果不足在右边补 0 |
|
3 |
%logger 或 %c |
logger 的名称 |
|
4 |
%thread 或 %t |
输出当前线程名称 |
|
5 |
%p |
日志输出格式 |
|
6 |
%message 或 %msg 或 %m |
日志内容，即 logger.info("message") |
|
7 |
%n |
换行符 |
|
8 |
%class 或 %C |
输出 Java 类名 |
|
9 |
%file 或 %F |
输出文件名 |
|
10 |
%L |
输出错误行号 |
|
11 |
%method 或 %M |
输出方法名 |
|
12 |
%l |
输出语句所在的行数, 包括类名、方法名、文件名、行数 |
|
13 |
hostName |
本地机器名 |
|
14 |
hostAddress |
本地 ip 地址 |
自定义日志配置
在 Spring Boot 的配置文件 application.porperties/yml 中，可以对日志的一些默认配置进行修改，但这种方式只能修改个别的日志配置，想要修改更多的配置或者使用更高级的功能，则需要通过日志实现框架自己的配置文件进行配置。
Spring 官方提供了各个日志实现框架所需的配置文件，用户只要将指定的配置文件放置到项目的类路径下即可。
|
日志框架 |
配置文件 |
|
Logback |
logback-spring.xml、logback-spring.groovy、logback.xml、logback.groovy |
|
Log4j2 |
log4j2-spring.xml、log4j2.xml |
|
JUL (Java Util Logging) |
logging.properties |
- 普通日志配置文件，即不带 srping 标识的配置文件，例如 logback.xml；
- 带有 spring 表示的日志配置文件，例如 logback-spring.xml
这两种日志配置文件在使用时大不相同
普通日志配置文件
我们将 logback.xml、log4j2.xml 等不带 spring 标识的普通日志配置文件，放在项目的类路径下后，这些配置文件会跳过 Spring Boot，直接被日志框架加载。通过这些配置文件，我们就可以达到自定义日志配置的目的。
示例
将 logback.xml 加入到 Spring Boot 项目的类路径下（resources 目录下），该配置文件配置内容如下。
<?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">
<!-- 定义日志的根目录 -->
<property name="LOG_HOME" value="/app/log"/>
<!-- 定义日志文件名称 -->
<property name="appName" value="bianchengbang-spring-boot-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">
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread]**************** %-5level %logger{50} - %msg%n</pattern>
</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} [ %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="net.biancheng.www" level="debug"/>
<!-- Spring framework logger -->
<logger name="org.springframework" level="debug" additivity="false"></logger>
<!--
root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="stdout"/>
<appender-ref ref="appLogAppender"/>
</root>
</configuration>
带有 spring 标识的日志配置文件
Spring Boot 推荐用户使用 logback-spring.xml、log4j2-spring.xml 等这种带有 spring 标识的配置文件。这种配置文件被放在项目类路径后，不会直接被日志框架加载，而是由 Spring Boot 对它们进行解析，这样就可以使用 Spring Boot 的高级功能 Profile，实现在不同的环境中使用不同的日志配置。
示例
1. 将 logback.xml 文件名修改为 logback-spring.xml，并将配置文件中日志输出格式的配置修改为使用 Profile 功能的配置。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE logback>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<springProfile name="local">
<property name="LOG_FILE_PATH" value="./log/trace" />
<property name="LOG_SQLFILE_PATH" value="./log/sql" />
<property name="LOG_ERRFILE_PATH" value="./log/error" />
</springProfile>
<springProfile name="develop">
<property name="LOG_FILE_PATH" value="D:/SHWEB/shsurvey/trace" />
<property name="LOG_SQLFILE_PATH" value="D:/SHWEB/shsurvey/sql" />
<property name="LOG_ERRFILE_PATH" value="D:/SHWEB/shsurvey/error" />
</springProfile>
<springProfile name="test">
<property name="LOG_FILE_PATH" value="D:/SHWEB/shsurvey/trace" />
<property name="LOG_SQLFILE_PATH" value="D:/SHWEB/shsurvey/sql" />
<property name="LOG_ERRFILE_PATH" value="D:/SHWEB/shsurvey/error" />
</springProfile>
<springProfile name="product">
<property name="LOG_FILE_PATH" value="D:/SHWEB/shsurvey/trace" />
<property name="LOG_SQLFILE_PATH" value="D:/SHWEB/shsurvey/sql" />
<property name="LOG_ERRFILE_PATH" value="D:/SHWEB/shsurvey/error" />
</springProfile>
<property name="LOG_NAME" value="shsurvey" />
<property name="LOG_FILE" value="${LOG_FILE_PATH}/${LOG_NAME}_trace.log" />
<property name="SQLLOG_FILE" value="${LOG_SQLFILE_PATH}/${LOG_NAME}_sql.log" />
<property name="ERRLOG_FILE" value="${LOG_ERRFILE_PATH}/${LOG_NAME}_error.log" />
<property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level %marker %logger - %msg%n" />
<property name="FILE_LOG_PATTERN" value="%d %-5level %logger{15} - %msg%n" />
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<Target>System.out</Target>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
</encoder>
</appender>
<springProfile name="local">
<root level="ERROR">
<appender-ref ref="STDOUT" />
</root>
<logger name="jp.co.sekisuihouse.shsurveyweb"
additivity="false"><level value="INFO" />
<appender-ref ref="STDOUT" />
</logger>
</springProfile>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_FILE_PATH}/${LOG_NAME}_trace_%d{yyyy-MM-dd}.log.zip</FileNamePattern>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder>
<Pattern>${FILE_LOG_PATTERN}</Pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>DENY</onMatch>
<onMismatch>ACCEPT</onMismatch>
</filter>
</appender>
<appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${ERRLOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_ERRFILE_PATH}/${LOG_NAME}_error_%d{yyyy-MM-dd}.log.zip</fileNamePattern>
<MaxHistory>365</MaxHistory>
</rollingPolicy>
<encoder>
<Pattern>${FILE_LOG_PATTERN}</Pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="FILE_SQL" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${SQLLOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_SQLFILE_PATH}/${LOG_NAME}_sql_%d{yyyy-MM-dd}.log.zip</FileNamePattern>
<MaxHistory>365</MaxHistory>
</rollingPolicy>
<encoder>
<Pattern>${FILE_LOG_PATTERN}</Pattern>
<charset>UTF-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<logger name="jp.co.sekisuihouse.shsurveyweb" level="debug" additivity="true"/>
<!-- sql -->
<springProfile name="develop,local">
<logger name="jp.co.sekisuihouse.shsurveyweb.domains.repositories" level="debug" additivity="false">
<appender-ref ref="FILE_SQL" />
</logger>
</springProfile>
<springProfile name="local">
<root level="info">
<appender-ref ref="FILE" />
<appender-ref ref="FILE_ERROR" />
</root>
</springProfile>
<springProfile name="develop">
<root level="info,debug">
<appender-ref ref="FILE" />
<appender-ref ref="FILE_ERROR" />
</root>
</springProfile>
<springProfile name="product">
<root level="info">
<appender-ref ref="FILE" />
<appender-ref ref="FILE_ERROR" />
</root>
</springProfile>
<springProfile name="test">
<root level="info">
<appender-ref ref="FILE" />
<appender-ref ref="FILE_ERROR" />
</root>
</springProfile>
</configuration>
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
