springboot使用logback自定义日志

前言

1、末尾有完整配置文件

2、日志分为五个等级，按照优先级的高低可以分为：

TRANCE < DEBUG < INFO < WARN < ERROR

springboot默认是INFO，因此低于INFO的TRACE和DEBUG都不会输出。

可以在properties或yaml配置文件中修改日志级别：

logging:
  level:
    root: debug

这里的root可以换成包名，精细控制不同包的日志输出级别，比如：

logging:
  level:
    com.example.controller: debug
    com.example.mapper: error

3、其次，logback的日志分为控制台日志和文件日志。

控制台日志：也就是我们IDE运行项目时，控制台打印的信息。

文件日志：项目运行时，将运行信息写入到指定文件。需要在springboot配置文件或logback配置文件中指定日志文件的位置。

引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

解释：按理来讲需要引入的是spring-boot-starter-logging依赖，但是spring-boot-starter-web间接依赖于spring-boot-starter-logging，所以我们只需要引入spring-boot-starter-web即可。

使用logback

logback会自动寻找classpath根部下面的logback.xml，所以我们只需要在resource目录下创建logback.xml文件，就可以在程序启动时，自动加载自定义日志的配置文件。

如果不想叫logback.xml，想起一个有个性的名字，比如cxkLogback.xml，那么需要在properties或yaml配置文件指定logback文件路径：

logging:
  config: classpath:cxkLogback.xml

如果想验证一下，可以将下方概览中的配置文件复制到自己的项目中运行一下，观察控制台的日志输出格式。

配置文件概览

可以简单先看一个配置文件的案例

<?xml version="1.0" encoding="UTF-8"?>
<!--
    scan:当配置文件修改后，将会重新载入。
    scanPeriod:设置检测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。
    debug:为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 定义一个名为STDOUT的控制台输出Appender -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
        	<!-- 输出格式 -->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 定义一个名为FILE的文件输出Appender -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <!-- 设置日志文件的存放路径和文件名，可根据实际情况修改 -->
        <file>logs/app.log</file>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 配置根日志记录器，设置日志级别为DEBUG，并将日志输出到STDOUT和FILE这两个Appender -->
    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>

</configuration>

这个文件主要定义了两个Appender，分别输出日志到控制台和文件中。

其次定义root目录的日志级别，并将两个Appender配置到root目录下，进行日志输出。

这里的root标签里面定义了level，有没有感觉在哪里见过这个东西？

没错，上文讲到，我们可以在properties或yaml配置文件中修改日志级别，在springboot配置文件中的操作，和这里的操作是等价的。那么按照同样的道理，这里的root也可以细化成不同的包，配置不同的level和Appender。这里只是引出这个概念，具体的内容放在下文。

配置项详解