SpringBoot :日志框架

目录

在SpringBoot中打印日志信息

信息打印

日志级别

配置Logback日志

配置实现

MDC机制

自定义Banner

---

SpringBoot使用的是Slf4j作为日志门面，Logback作为日志实现

为了统一日志框架Spring Boot做了以下操作

• 直接将其他依赖以前的日志框架剔除

• 导入对应日志框架的Slf4j中间包

• 导入自己官方指定的日志实现，并作为Slf4j的日志实现层

在SpringBoot中打印日志信息

信息打印

使用日志工厂获取日志打印器

@RequestMapping("/login")
public String login(){
    Logger logger = LoggerFactory.getLogger(MainController.class);
    logger.info("test");
    return "login";
}

使用注解打印

@Slf4j
@Controller
public class MainController {
@RequestMapping("/login")
    public String login(){
        log.info("test");
        return "login";
    }

日志级别

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL

SpringBoot默认只会打印INFO以上级别的信息

配置Logback日志

配置实现

Logback可以实现定制化，只需编写对应的配置文件。SpringBoot推荐将配置文件名称命名为logback-spring.xml表示这是SpringBoot下Logback专用的配置

官方文档：https://logback.qos.ch/manual/layouts.html

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 配置 -->
</configuration>

一旦编写，就会替换默认的配置，所以如果内部什么都不写的话，那么会导致SpringBoot项目没有配置任何日志输出方式，控制台也不会打印日志

可以直接导入并使用SpringBoot预设好的日志格式，在org/springframework/boot/logging/logback/defaults.xml中已经把日志的输出格式定义好了，只需要设置对应的appender，导入后，利用预设的日志格式创建一个控制台日志打印

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--  导入其他配置文件，作为预设  -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />

    <!--  Appender作为日志打印器配置，这里命名随意  -->
    <!--  ch.qos.logback.core.ConsoleAppender是专用于控制台的Appender  -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>${CONSOLE_LOG_CHARSET}</charset>
        </encoder>
    </appender>

    <!--  指定日志输出级别，以及启用的Appender，这里就使用了我们上面的ConsoleAppender  -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

开启文件打印，只需要配置并加入一个对应的Appender即可

<!--  ch.qos.logback.core.rolling.RollingFileAppender用于文件日志记录，它支持滚动  -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>${FILE_LOG_PATTERN}</pattern>
        <charset>${FILE_LOG_CHARSET}</charset>
    </encoder>
    <!--  自定义滚动策略，防止日志文件无限变大，也就是日志文件写到什么时候为止，重新创建一个新的日志文件开始写  -->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!--  文件保存位置以及文件命名规则，这里用到了%d{yyyy-MM-dd}表示当前日期，%i表示这一天的第N个日志  -->
        <FileNamePattern>log/%d{yyyy-MM-dd}-spring-%i.log</FileNamePattern>
        <!--  到期自动清理日志文件  -->
        <cleanHistoryOnStart>true</cleanHistoryOnStart>
        <!--  最大日志保留时间  -->
        <maxHistory>7</maxHistory>
        <!--  最大单个日志文件大小  -->
        <maxFileSize>10MB</maxFileSize>
    </rollingPolicy>
</appender>

<!--  指定日志输出级别，以及启用的Appender，这里就使用了我们上面的ConsoleAppender  -->
<root level="INFO">
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="FILE"/>
</root>

MDC机制

MDC为“Mapped Diagnostic Context”（映射诊断上下文），将一些运行时的上下文数据通过logback打印出来；此时需要借助org.sl4j.MDC类

@Slf4j
@Controller
public class MainController {

    @RequestMapping("/login")
    public String login(){
          //这里用SessionID
        MDC.put("reqId", request.getSession().getId());
        log.info("test");
        return "login";
    }

向日志中传入自定义参数，在日志中添加这样一个占位符%X{键值}，名字保持一致

 %clr([%X{reqId}]){faint} 

自定义Banner

直接在配置文件所在目录下创建一个名为banner.txt的文本文档，内容随便

使用在线生成网站进行生成自己的个性Banner：Spring Boot banner在线生成工具，制作下载英文banner.txt，修改替换banner.txt文字实现自定义，个性化启动banner-bootschool.net 使用颜色代码来为文本切换颜色

${AnsiColor.BRIGHT_GREEN}  //绿色

也可以获取一些常用的变量信息：

${AnsiColor.YELLOW} 当前 Spring Boot 版本：${spring-boot.version}