Springboot日志框架logback与log4j2

目录

Springboot日志使用

Logback日志

日志格式

自定义日志格式

日志文件输出

Springboot启用log4j2日志框架

---

Springboot日志使用

Springboot底层是使用slf4j+logback的方式进行日志记录

Logback日志

trace：级别最低

debug：调试级别的，常用于跟踪程序的进展

info：普通的打印信息（默认的日志级别）

warn：警告级别，不影响使用，但应该注意

error：错误级别，错误日志信息打印

fatal：致命级别，因代码异常导致程序退出，级别最高

日志级别

Trace-> debug-> info-> warn-> error-> fatal

logger.trace("trace");跟踪

logger.debug("debug");调试

logger.info("info");信息

logger.warn("warn");告警

logger.error("error");异常

logging:level:root: tracelogging:level:com:example: trace

日志格式

1、时间日期：精确到毫秒

2、日志级别：ERROR，WARN，INFO，DEBUG，TRACE

3、进程ID：

4、分隔符：— 标识实际日志的开始

5、线程名：方括号括起来(可能会截断控制台输出)

6、Logger名：通常使用源代码的类名

7、日志内容：

自定义日志格式

%clr(%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}){yellow}

docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.logging

日志文件输出

默认情况下，springboot仅记录到控制台，不写日志文件。

若要输出日志文件，需设置logging.file.name或logging.file.path属性

logging:level:com:example: trace#logging.pattern.dateformat -> LOG_DATEFORMAT_PATTERN#https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.logging#pattern:#  dateformat: yyyy-MM-dd HH:mm:ss.SSSfile:#log文件默认在项目的相对路下name: D:/test/log/demo.log

file:#默认文件名spring.log
#    name: D:/test/log/demo.log#log文件默认在项目的相对路下path: D:/test/log/

logging:level:com:example: trace#logging.pattern.dateformat -> LOG_DATEFORMAT_PATTERN#https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.logging#pattern:#  dateformat: yyyy-MM-dd HH:mm:ss.SSSfile:#默认文件名spring.logname: D:/test/log/demo.log#log文件默认在项目的相对路下
#    path: D:/test/log/# 最大日志文件大小(默认为10MB，这里为了测试归档，暂时设置为5KB)max-size: 5KB# 要保留的日志备份的总大小(默认为0B)total-size-cap: 1GB# 保存存档日志文件的最大天数(默认为7天)max-history: 7

<?xml version="1.0" encoding="UTF-8"?>
<configuration><!-- 日志存放路径 --><property name="log.path" value="${user.dir}/logs"/><!-- 日志输出格式 --><property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{100} - [%method,%line] - %msg%n"/><!-- 控制台输出 --><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>${log.pattern}</pattern></encoder></appender><!-- 系统日志输出 --><appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}/info.log</file><!-- 循环政策：基于时间创建日志文件 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 日志文件名格式 --><fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern><!-- 日志最大的历史 60天 --><maxHistory>60</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 过滤的级别 --><level>INFO</level><!-- 匹配时的操作：接收（记录） --><onMatch>ACCEPT</onMatch><!-- 不匹配时的操作：拒绝（不记录） --><onMismatch>DENY</onMismatch></filter></appender><!-- 系统日志输出 --><appender name="debug" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}/debug.log</file><!-- 循环政策：基于时间创建日志文件 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 日志文件名格式 --><fileNamePattern>${log.path}/sys-debug.%d{yyyy-MM-dd}.log</fileNamePattern><!-- 日志最大的历史 60天 --><maxHistory>60</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 过滤的级别 --><level>DUBUG</level><!-- 匹配时的操作：接收（记录） --><onMatch>ACCEPT</onMatch><!-- 不匹配时的操作：拒绝（不记录） --><onMismatch>DENY</onMismatch></filter></appender><appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}/error.log</file><!-- 循环政策：基于时间创建日志文件 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 日志文件名格式 --><fileNamePattern>${log.path}/error.%d{yyyy-MM-dd}.log</fileNamePattern><!-- 日志最大的历史 60天 --><maxHistory>60</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 过滤的级别 --><level>ERROR</level><!-- 匹配时的操作：接收（记录） --><onMatch>ACCEPT</onMatch><!-- 不匹配时的操作：拒绝（不记录） --><onMismatch>DENY</onMismatch></filter></appender><!-- 用户访问日志输出  --><appender name="user" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}/user.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 按天回滚 daily --><fileNamePattern>${log.path}/sys-user.%d{yyyy-MM-dd}.log</fileNamePattern><!-- 日志最大的历史 60天 --><maxHistory>60</maxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder></appender>
<!--    日志水平--><root level="info"><appender-ref ref="console"/></root><!--系统操作日志--><root level="info"><appender-ref ref="info"/><appender-ref ref="debug"/><appender-ref ref="error"/></root><!--系统用户操作日志--><logger name="com.example" level="info"><appender-ref ref="user"/></logger>
</configuration>

Springboot启用log4j2日志框架

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><!-- 排除logback依赖 --><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions>
</dependency><!--Log4j2场景启动器 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

<?xml version="1.0" encoding="UTF-8"?>
<!--status:Log4j2内部日志的输出级别,设置为TRACE对学习Log4j2非常有用 -->
<!--monitorInterval:定时检测配置文件的修改,有变化则自动重新加载配置,时间单位为秒,最小间隔为5s -->
<Configuration status="WARN" monitorInterval="1800"><!--properties:设置全局变量 --><properties><!--LOG_HOME:指定当前日志存放的目录 --><property name="LOG_HOME">./logs</property><!--FILE_NAME:指定日志文件的名称 --><property name="FILE_NAME">test</property></properties><!--Appenders:定义日志输出目的地，内容和格式等 --><Appenders><!--Console:日志输出到控制台标准输出 --><Console name="Console" target="SYSTEM_OUT"><!--pattern:日期,线程名,日志级别,日志名称,日志信息,换行 --><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [线程名%t] [日志级别%-5level] [日志名称%L] - [日志信息:%msg]%n" /></Console><!--RollingFile:日志输出到文件,下面的文件都使用相对路径 --><!--fileName:当前日志输出的文件名称 --><!--filePattern:备份日志文件名称，备份目录为logs下面以年月命名的目录，备份时使用gz格式压缩 --><RollingFile name="RollingFile" fileName="${LOG_HOME}/${FILE_NAME}.log"filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%L] - %msg%n" /><!--Policies:触发策略决定何时执行备份 --><Policies><!--TimeBasedTriggeringPolicy:日志文件按照时间备份 --><!--interval:每1天生成一个新文件，时间单位需要结合filePattern时间%d{yyyy-MM-dd} --><!--同理，如果要每1小时生成一个新文件，则改成%d{yyyy-MM-ddHH} --><!--modulate:对备份日志的生成时间纠偏，纠偏以0为基准进行，"0+interval"决定启动后第一次备份时间 --><TimeBasedTriggeringPolicy interval="1" modulate="true" /><!--SizeBasedTriggeringPolicy:日志文件按照大小备份 --><!--size:指定日志文件最大为100MB，单位可以为KB、MB或GB --><SizeBasedTriggeringPolicy size="200MB" /></Policies><!--DefaultRolloverStrategy:翻转策略决定如何执行备份 --><!--max:最多保存5个备份文件，结合时间使用后，在每个时间段内最多有5个备份，多出来的会被覆盖 --><!--compressionLevel:配置日志压缩级别，范围0-9，0不压缩，1压缩速度最快，9压缩率最好，目前只对于zip压缩文件类型有效 --><DefaultRolloverStrategy max="5" compressionLevel="1"><!--Delete:删除匹配到的过期备份文件 --><!--maxDepth:由于备份文件保存在${LOG_HOME}/$${date:yyyy-MM},所以目录深度设置为2 --><Delete basePath="${LOG_HOME}" maxDepth="2"><!--IfFileName:匹配文件名称 --><!--glob:匹配2级目录深度下的以.log.gz结尾的备份文件 --><IfFileName glob="*/*.log.gz" /><!--IfLastModified:匹配文件修改时间 --><!--age:匹配超过180天的文件，单位D、H、M、S分别表示天、小时、分钟、秒--><IfLastModified age="180D" /></Delete></DefaultRolloverStrategy></RollingFile></Appenders><!--Loggers:定义日志级别和使用的Appenders --><Loggers><!--name: 打印日志的类的包路径 --><!--additivity: true当前的Logger打印的日志附加到Root，false仅仅打印到RollingFile --><Logger name="com.example" level="info" additivity="true"><AppenderRef ref="RollingFile" /></Logger><!--Root:日志默认打印到控制台 --><!--level日志级别: ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF --><Root level="ERROR"><AppenderRef ref="Console" /></Root></Loggers>
</Configuration>

Apache Log4j2 （Log4j – Apache Log4j 2）是对Log4j的升级，它比其前身Log4j 1.x提供了重大改进，并参考了Logback中优秀的设计，同时修复了Logback架构中的一些问题。被誉为是目前最优秀的Java日志框架；企业中通常使用SLF4j门面+Log4j2来记录日志。

SLF4J: Found provider [ch.qos.logback.classic.spi.LogbackServiceProvider@11c20519]

SLF4J: Found provider [org.apache.logging.slf4j.SLF4JServiceProvider@70beb599]

存在依赖冲突，解决办法

<exclusions><!-- 排除logback依赖 -->

<exclusion>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-logging</artifactId>

</exclusion>

</exclusions>

排查发现

spring-boot-starter-actuator

springfox-swagger2

springfox-swagger-ui

spring-boot-starter-web

需排除logback依赖否则会与log4j2产生依赖冲突

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <exclusions><!-- 排除logback依赖 -->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <exclusions><!-- 排除logback依赖 -->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
            <exclusions><!-- 排除logback依赖 -->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>

log4j2+Mybatis

Mybatis日志交给log4j2管理

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><settings><setting name="logImpl" value="LOG4J2"/></settings>
</configuration>

log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--status:Log4j2内部日志的输出级别,设置为TRACE对学习Log4j2非常有用 -->
<!--monitorInterval:定时检测配置文件的修改,有变化则自动重新加载配置,时间单位为秒,最小间隔为5s -->
<Configuration status="WARN" monitorInterval="1800"><!--properties:设置全局变量 --><properties><!--LOG_HOME:指定当前日志存放的目录 --><property name="LOG_HOME">./logs</property><!--FILE_NAME:指定日志文件的名称 --><property name="FILE_NAME">wms</property></properties><!--Appenders:定义日志输出目的地，内容和格式等 --><Appenders><!--Console:日志输出到控制台标准输出 --><Console name="Console" target="SYSTEM_OUT"><!--pattern:日期,线程名,日志级别,日志名称,日志信息,换行 --><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [线程名%t] [日志级别%-5level] [日志名称%L] - [日志信息:%msg]%n" /></Console><RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/${FILE_NAME}.log"filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz"><!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）--><!--此处的level一定要设置为debug，否者mybatis的日志会被拒绝--><ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [线程名%t] [日志级别%-5level] [日志名称%L] - [日志信息:%msg]%n"/><Policies><!--TimeBasedTriggeringPolicy:日志文件按照时间备份 --><!--interval:每1天生成一个新文件，时间单位需要结合filePattern时间%d{yyyy-MM-dd} --><!--同理，如果要每1小时生成一个新文件，则改成%d{yyyy-MM-ddHH} --><!--modulate:对备份日志的生成时间纠偏，纠偏以0为基准进行，"0+interval"决定启动后第一次备份时间 --><TimeBasedTriggeringPolicy interval="1" modulate="true" /><!--SizeBasedTriggeringPolicy:日志文件按照大小备份 --><!--size:指定日志文件最大为100MB，单位可以为KB、MB或GB --><SizeBasedTriggeringPolicy size="200MB" /></Policies><!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了100  例如文件中会生成如下   info-1.log  info-2.log .... info-100.log --><DefaultRolloverStrategy max="10"><Delete basePath="${LOG_HOME}" maxDepth="2"><!--IfFileName:匹配文件名称 --><!--glob:匹配2级目录深度下的以.log.gz结尾的备份文件 --><IfFileName glob="*/*.log.gz" /><!--IfLastModified:匹配文件修改时间 --><!--age:匹配超过180天的文件，单位D、H、M、S分别表示天、小时、分钟、秒--><IfLastModified age="30D" /></Delete></DefaultRolloverStrategy></RollingFile></Appenders><!--Loggers:定义日志级别和使用的Appenders --><Loggers><!--name: 打印日志的类的包路径 --><!--additivity: true当前的Logger打印的日志附加到Root，false仅仅打印到RollingFile --><Logger name="com.example" level="debug">
<!--            <AppenderRef ref="RollingFile" />--><AppenderRef ref="RollingFileInfo" /></Logger><!--Root:日志默认打印到控制台 --><!--level日志级别: ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF --><Root level="debug"><AppenderRef ref="Console" /><AppenderRef ref="RollingFileInfo" /></Root></Loggers>
</Configuration>