SpringBoot系列 logback-spring日志配置使用记录以及解决依赖包冲突问题
SpringBoot推荐使用logback-spring.xml
SpringBoot官方推荐使用logback-spring.xml作为logback框架的自定义日志配置文件(例如:使用logback-spring.xml而不是logback.xml),因为带-spring后缀的配置文件可以使用SpringBoot提供的一些高级功能,如profile多环境日志输出。
使用记录避坑
正常是引用pom添加依赖,添加logback-spring.xml配置即可
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId>
</dependency>
logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false"><contextName>logback</contextName><!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径--><property name="LOG_HOME" value="logs" /><!-- 彩色日志 --><!-- 彩色日志依赖的渲染类 --><conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" /><conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" /><conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" /><!-- 彩色日志格式 --><property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/><!-- 控制台输出 --><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><!--日志级别过滤INFO以下--><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><!--<level>info</level>--><!-- 过滤的级别 --><level>debug</level></filter><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><pattern>${CONSOLE_LOG_PATTERN}</pattern></encoder></appender><!-- 按照每天生成日志文件 --><appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><File>${LOG_HOME}/data-sync.log</File><rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"><!--日志文件输出的文件名-->
<!-- <FileNamePattern>${LOG_HOME}/data-sync.%d{yyyy-MM-dd_HH-mm}.%i.log</FileNamePattern>--><FileNamePattern>${LOG_HOME}/data-sync.%d{yyyy-MM-dd}.%i.log</FileNamePattern><!-- 日志文件最大尺寸 --><maxFileSize>100MB</maxFileSize><!--日志文件保留天数--><MaxHistory>30</MaxHistory><totalSizeCap>1GB</totalSizeCap></rollingPolicy><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern></encoder></appender><!-- 日志输出级别 --><root level="debug"><appender-ref ref="STDOUT" /><appender-ref ref="FILE" /></root><root level="info"><appender-ref ref="STDOUT" /><appender-ref ref="FILE" /></root></configuration>
踩坑记录1:
由于项目中引用了hive的依赖包,导致日志文件冲突,项目启动失败,解决冲突方式是排除了spring-boot-starter-logging依赖包,导致添加logback-spring.xml不生效,
为了使日志配置生效,所以引入了spring-boot-starter-logging的子包logback-classic,如下
<dependency><groupId>ch.qos.logback</groupId><artifactId>logback-classic</artifactId>
<!-- <version>1.2.3</version>--></dependency>
或者引入spring-boot-starter-logging依赖包,排除其他非logback-classic包
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId><exclusions><exclusion><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-to-slf4j</artifactId></exclusion><exclusion><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-api</artifactId></exclusion><exclusion><groupId>org.slf4j</groupId><artifactId>jul-to-slf4j</artifactId></exclusion></exclusions></dependency>
本地测试生效;
踩坑记录2
放测试环境,又报日志冲突
解决依赖包冲突,从报错日志得知,hive的依赖包log4j-slf4j-impl和spring依赖包冲突,在pom文件里右键
找到依赖关系图,ctrl+f;搜对应的冲突包,并选中
右键,选中exclude排除即可
启动方式避坑3:
启动文件加 -Dlogging.config=logback-spring.xml
start.sh配置分离
yml配置避坑4
实测按以下配置不生效,要生效就得配置在xml里