12 SpringBoot 日志管理

 SpringBoot默认使用Logback组件作为日志管理。Logback是log4j创始人设计的一个开源日志组件。在SpringBoot项目中我们不需要额外的添加Logback的依赖，因为在 spring-boot-parent 中已经包含了Logback的依赖。

使用Logback依赖：

1.在 /resources 下添加Logback配置文件logback.xml

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!--定义日志文件的存储地址-->
    <property name="LOG_HOME" value="${catalina.base}/logs/"/>

    <!-- class的路径是固定的 -->
    <!-- 控制台输出 -->
    <appender name="Stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 日志输出编码 -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <!--格式化输出：%d表示时间（时分秒.毫秒），%thread表示线程名，%-5level：级别从左显示5个字符，%logger{50}：最多显示50个字符 %msg：日志消息，%n是换行符-->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </layout>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="RollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/server.%d{yy99-MM-dd}.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <!--格式化输出：%d表示时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </layout>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 日志输出级别 -->
    <root level="info">
        <appender-ref ref="Stdout"/>
        <appender-ref ref="RollingFile"/>
    </root>
</configuration>

注意：Logback配置文件名为logback-test.xml或logback.xml（约定大于配置，名字固定的），如果classpath下没有这两个文件，LogBack会自动进行最小化配置

2.在代码中打印日志

@Controller
public class LogbackController {
    private final static Logger logger = (Logger) LoggerFactory.getLogger(LogbackController.class);

    @RequestMapping("/printLog")
    @ResponseBody
    public String showInfo(){
        logger.info("记录日志");
        return "Hello Logback";
    }
}

3.如果日志过多，可以屏蔽一些包的日志，在配置文件application.properties中配置

#屏蔽org包中的日志输出
logging.level.org=off

配置了屏蔽功能后，不再有org包出现。

4.项目结构：

5.补充：Log4j2安全漏洞

在 2021 年 12 月， Log4j2 爆出了极其严重的安全漏洞，攻击者可以让记录的日志包含指定字符串，从而执行任意程序。很多大型网站，如百度等都是此次Log4j 漏洞的受害者，很多互联网企业连夜做了应急措施。 Log4j2.0到 2.14.1 全部存在此漏洞，危害范围极其广泛，Log4j2.15.0-rc1中修复了这个 bug 。

因 Log4j2 漏洞的反复无常，导致某些公司已经切换到 Logback来记录日志，但在Log4j2 漏洞爆出后， Logback 也爆出漏洞：在Logback1.2.7 及之前的版本中，具有编辑配置文件权限的攻击者可以制作恶意配置，允许从LDAP 服务器加载、执行任意代码。

解决方案为将 Logback 升级到安全版本： Logback1.2.9+ SpringBoot2.6.2以上的 Logback 版本已经升到了 1.2.9 ， Log4j2的版本也升到了2.17.0 ，所以我们使用 SpringBoot2.6.2 以上版本无需担心Log4j2 和 Logback 安全漏洞。

6.最后：

1.在 SpringBoot 中， Logback默认配置文件是“ /resources/logback.xml  或     /resources/logback - test.xml ”

2.Logback配置文件名固定的为logback.xml 或logback-test.xml，（约定大于配置）