springboot（十）使用LogBack作为日志组件

简介：

　　企业级项目在搭建的时候，最不可或缺的一部分就是日志，日志可以用来调试程序，打印运行日志以及错误信息方便于我们后期对系统的维护，在SpringBoot兴起之前记录日志最出色的莫过于log4j了，对于目前来说项目还有很多在用log4j来记录日志。那么我们的SpringBoot是怎么记录日志的？

　　SpringBoot内部集成了LogBack日志依赖，SpringBoot默认使用LogBack记录日志信息，默认根据base.xml配置内容来输出到控制台和文件之中，那么接下来讲解LogBack是如何记录日志到控制和文件之中？

本文目标：

　　学习SpringBoot项目中使用LogBack记录日志到控制台和文件之中，根据不同的级别输出不同形式日志信息。

一、构建项目

　　SpringBoot内部集成了LogBack所以我们不需要添加任何依赖，我们只需要创建一个新的springboot空项目即可。（创建项目是选择的WAR类型，所以自动添加了WEB、Tomcat）

二、SpringBoot有默认的配置

　　我们并不需要添加任何操作，现在日志就可以在控制台打印了，为了证实这一点，我们先来创建一个IndexController然后添加一个访问方法/index，在该方法内添加日志的info级别的打印（默认配置只有Info及以上级别才可以输出）。

　　我们访问地址后，控制台就对应的输出了info级别的测试日志内容了，上面我们说了这是logback的默认配置base.xml搞的鬼。

三、修改LogBack配置

　　LogBack读取配置文件的步骤
　　（1）尝试classpath下查找文件logback-test.xml
　　（2）如果文件不存在，尝试查找logback.xml
　　（3）如果两个文件都不存在，LogBack用BasicConfiguration自动对自己进行最小化配置，这样既实现了上面我们不需要添加任何配置就可以输出到控制台日志信息。

我们在logback.xml配置文件中，添加了控制台输出、文件每天输出、日志文件最大上限、日志的最低级别等。

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="./logs" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <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>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/runtime.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </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>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
 
    <!-- 日志输出级别 -->
    <root level="debug">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

四、测试代码（打印debug级别）

@RestController
public class IndexController {
    private final static Logger logger = LoggerFactory.getLogger(IndexController.class);
 
    @RequestMapping(value = "/index",method = RequestMethod.GET)
    public String index(){
        logger.debug("访问debug日志");
        logger.info("访问了index方法");
        logger.error("记录error错误日志");
        return "index";
    }
}

五、屏蔽记录日志

　　如果我们在项目中需要屏蔽某个或者多个包下不输出日志也不记录日志到文件内，那么我们需要修改application.yml添加对应配置（在application.yml配置文件内，off必须添加双引号，否则不会生效）。

logging:
  level:
    com.dyh.controller: 'off'

以上内容就是有关LogBack配置相关讲解，本文主要讲解了SpringBoot如何使用内置的日志组件完成日志的输出、日志保存到文件、控制日志输出等。