SpringBoot 使用 slf4j+logback 进行日志管理
一、基础知识：
1.日志系统
系统日志是记录系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件。用户可以通过它来检查错误发生的原因，或者寻找受到攻击时攻击者留下的痕迹。系统日志包括系统日志、应用程序日志和安全日志。-- 百度百科
日志的管理是系统很重要的一部分，千万不可忽略其重要性。完整的日志将会在系统维护中起着异常重要的作用，就好像磨刀不误砍柴工一样，日志就像对系统进行分析的工具，工具便捷了，对系统分析起来就能达到事半功倍的效果。
现代的应用程序已经离不开日志系统，所以学会正确高效地配置一套日志系统是一位后端开发工程师必备的技能。本篇文章我将逐步讲解使用 slf4j+logback 来对 SpringBoot 项目进行日志管理，仅作为参考，欢迎大家提出意见。
2.主流框架
当今Java程序中常见的日志框架有：Log4j、J.U.L(jdk-logging)、J.C.L(commons-logging)、Slf4j、Logback、Log4j2。一共是2个日志接口标准和4个具体的实现。具体内容可参见大佬文章 -- Java日志框架演化历史
之前最流行的搭配是使用 J.C.L+Log4j 的形式，从目前趋势来看，越来越多的开源项目逐步转向了 slf4j+logback，所以本篇文章主要讲解 slf4j+logback 的实现方式，其它实现形式大家感兴趣可以自行百度。
3.logback
logback 是一个开源的日志组件，同样是由log4j的作者设计完成的，拥有更好的特性，是用来取代log4j的一个日志框架。它拥有更快的实现、更充分的测试、更充分的文档、更细粒度的日志管理，所以让它现在变得越来越受欢迎。
二、在 SpringBoot 项目中使用 logback ：
1.添加依赖
logback 有三个主要模块：
logback-core：是logback-access，logback-classic两个模块的基础。
logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API，使我们可以在其他日志系统，如log4j和JDK14 Logging中进行转换。
logback-access：访问模块和Servlet容器集成，为tomcat等提供通过Http来访问日志的功能。
如果项目使用了 spring-boot-starter，那么依赖已经添加不必再手动引入，否则需要自己手动添加依赖：
否则要手动添加maven依赖：
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.21</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.1.7</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.7</version> </dependency>
2.添加配置文件
在 resources 文件夹下新建 logback-spring.xml 文件：
<?xml version="1.0" encoding="UTF-8"?> <!-- scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 configuration 子节点为 appender、logger、root --> <configuration scan="true" scanPeriod="60 seconds" debug="true"> <!--用于区分不同应用程序的记录--> <contextName>test-logback</contextName> <!--日志文件所在目录，如果是tomcat，如下写法日志文件会在则为${TOMCAT_HOME}/bin/logs/目录下--> <property name="LOG_HOME_WINDOWS" value="F:/logs"/> <property name="LOG_HOME_LINUX" 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" /> <!-- 彩色日志格式 [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n --> <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"> <encoder> <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度，%logger：输出日志的logger名，%msg：日志消息，%n是换行符 --> <pattern>${CONSOLE_LOG_PATTERN}</pattern><!--彩打日志--> <!--解决乱码问题--> <charset>UTF-8</charset> </encoder> </appender> <!--滚动文件，即随指定策略记录日志到指定文件--> <appender name="infoFile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- ThresholdFilter:临界值过滤器，过滤掉 TRACE 和 DEBUG 级别的日志 --> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>INFO</level><!--等级从低到高分别是ALL < TRACE < DEBUG < INFO < WARN < ERROR < OFF--> </filter> <!--滚动策略--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME_WINDOWS}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern><!--文件名--> <maxHistory>30</maxHistory><!--保存最近30天的日志--> <totalSizeCap>20GB</totalSizeCap><!--所有的日志文件最大20G，超过就会删除旧的日志--> <cleanHistoryOnStart>true</cleanHistoryOnStart><!--appender 启动的时候，是否删除归档文件--> </rollingPolicy> <!--日志格式化策略--> <encoder> <charset>UTF-8</charset> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern> </encoder> </appender> <!--另一个滚动文件写法--> <appender name="errorFile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>test.log</file> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>test.%i.log.zip</fileNamePattern> <minIndex>1</minIndex> <maxIndex>3</maxIndex> </rollingPolicy> <!--当文件大小超过5MB时，通知RollingPolicy轮转--> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize> </triggeringPolicy> <encoder> <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern> <charset>UTF-8</charset> </encoder> </appender> <!--配置多环境日志输出 可以在application.properties中配置选择哪个profiles--> <!--开发环境:打印控制台--> <springProfile name="dev"> <root level="debug"> <appender-ref ref="stdout" /> <appender-ref ref="infoFile" /> <appender-ref ref="errorFile" /> </root> </springProfile> <!--生产环境:只输出到文件--> <springProfile name="pro"> <root level="info"> <appender-ref ref="infoFile" /> <appender-ref ref="errorFile" /> </root> </springProfile> </configuration>
配合多环境配置文件：application.yml、application-dev.yml、application-pro.yml
在主配置文件中具体选择使用不同的环境，application.yml：
spring:
profiles:
active: dev
三、配置文件 logback-spring.xml 详解：
基本结构如下：
<?xml version="1.0" encoding="UTF-8"?> <!-- 根节点 --> <configuration scan="true" scanPeriod="60 seconds" debug="true"> <!-- 用于区分不同应用程序的记录 --> <contextName>xxx</contextName> <!-- 定义参数常量 --> <property name="xxx" value="yyy"/> <!-- 用于说明输出介质，此处说明控制台输出 --> <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>xxx</pattern><!-- 打印格式 --> <charset>UTF-8</charset><!-- 解决乱码问题 --> </encoder> </appender> <!-- 用于说明输出介质，此处说明文件输出 --> <appender name="fileout" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 过滤器，用于筛选不同级别的日志 --> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>INFO</level><!-- 等级从低到高分别是ALL < TRACE < DEBUG < INFO < WARN < ERROR < OFF --> </filter> <!--滚动策略--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>xxx</fileNamePattern><!-- 日志文件名 --> <maxHistory>xxx</maxHistory><!-- 最大保存周期，超过删除旧的日志 --> <totalSizeCap>xxx</totalSizeCap><!-- 总日志大小，超过删除旧的日志 --> <cleanHistoryOnStart>false</cleanHistoryOnStart><!-- appender 启动的时候，是否删除归档文件，默认false --> </rollingPolicy> <encoder> <charset>xxx</charset> <pattern>xxx</pattern> </encoder> </appender> <!-- 用于存放日志对象，同时指定关联的package位置 --> <logger name="xxx" level="xxx" additivity="true"> <appender-ref ref="stdout" /> <appender-ref ref="fileout" /> </logger> <!-- 特殊的logger，根logger --> <root lever="info"> <appender-ref ref="stdout" /><!-- 指定默认的日志输出 --> </root> </configuration>
这里推荐一个学习地址 -- Javaschool
关于 logback.xml 和 logback-spring.xml 的区别，参见大佬文章 -- logback.xml 和 logback-spring.xml 的区别
四、效果演示
在项目中使用log有两种方法：1.添加Lombok依赖，通过注解引入；2.通过工厂方式使用。
简单效果如下：
输出日志：
到这里本文章基本就结束了，最后再给大家推荐一个B站up视频 -- 使用 logback 输出日志
参考文章：https://www.cnblogs.com/ergwang/p/14600913.html
