SpringBoot应用自定义logback日志_JAVA旭阳

theme: cyanosis

持续创作，加速成长！这是我参与「掘金日新计划 · 10 月更文挑战」的第7天，点击查看活动详情

概述

默认情况下，SpringBoot内部使用logback作为系统日志实现的框架，将日志输出到控制台，不会写到日志文件。如果在application.properties或application.yml配置，这样只能配置简单的场景，保存路径、日志格式等。复杂的场景（区分 info 和 error 的日志、每天产生一个日志文件等）满足不了，只能自定义配置文件logback-spring.xml或者logback.xml。本篇文章主要讲解下如何自定义logabck.xml以及对logback文件中配置做一个详解。

logback配置详解

首先我们先了解下logback。

logback 主要分为三个模块：

logback-core：是其他两个模块的基础模块
logback-classic：是对 core 模块的扩展，相当于 log4j 的改良版。classic 模块实现了 Slf4j 的 API 因此可以便于和其他日志框架直接切换
logback-access：与Servlet容器集成，以提供http访问日志功能。

官网配置文档地址：https://logback.qos.ch/manual/configuration.html

配置内容概念介绍

Logger Context

LoggerContext负责制造logger，也负责以树结构排列各logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger名称为参数。

Logger

Logger作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。

Appender

Appender主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。

Layout

负责把事件转换成字符串，格式化的日志信息的输出。

配置介绍

配置文件的基本结构：以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。

默认配置的步骤

尝试在 classpath下查找文件logback-test.xml；
如果文件不存在，则查找文件logback.xml；
如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

```

${CONTEXT_NAME} ${CUSTOM_LOG_PATTERN} UTF-8 log/testC.%d{yyyy-MM-dd}.%i.log 30 100MB WARN ACCEPT DENY ${CUSTOM_LOG_PATTERN} UTF-8

<appender name="log_file"
    class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。 -->
    <file>${logs.dir}/logback-test.log</file>
    <!-- 按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <!-- 必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 
            或者 没有log%i.log.zip -->
        <FileNamePattern>${logs.dir}/logback-test.%i.log</FileNamePattern>
        <!-- 窗口索引最小值 -->
        <minIndex>1</minIndex>
        <!-- 窗口索引最大值 -->
        <maxIndex>3</maxIndex>
    </rollingPolicy>
    <!-- 日志级别过滤器 -->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <!-- 日志级别过滤器 -->
        <level>INFO</level>
        <!-- 符合要求的日志级别，过滤，ACCEPT:接受 -->
        <onMatch>ACCEPT</onMatch>
        <!-- 不符合要求的日志级别，过滤，DENY:拒绝 -->
        <onMismatch>DENY</onMismatch>
    </filter>
    <!-- 激活滚动的条件。 -->
    <triggeringPolicy
        class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
        <!-- 活动文件的大小，默认值是10MB -->
        <maxFileSize>30MB</maxFileSize>
    </triggeringPolicy>
    <!-- 对记录事件进行格式化。 -->
    <encoder>
        <pattern>${CUSTOM_LOG_PATTERN}</pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>

<!-- 异步输出 -->
<appender name="ASYNC_logback" class="ch.qos.logback.classic.AsyncAppender">
    <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
    <!-- <discardingThreshold>0</discardingThreshold> -->
    <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
    <!-- <queueSize>256</queueSize> -->
    <!-- 添加附加的appender,最多只能添加一个 -->
    <appender-ref ref="log_file" />
</appender>
<!-- 指定包输出路径 -->
<!-- 用来设置某一个 包 或者具体的某一个 类 的日志打印级别、以及指定<appender>, name:用来指定受此logger约束的某一个包或者具体的某一个类。 
    level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。 
    additivity:是否向上级logger传递打印信息。默认是true。(这个logger的上级就是上面的root) <logger>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。 -->
<logger name="org.logback.test" level="DEBUG" additivity="true">
    <appender-ref ref="stdout" />
</logger>
<!-- 特殊的<logger>元素，是根logger。只有一个level属性，应为已经被命名为"root". level:设置打印级别，大小写无关：TRACE, 
    DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。 <root>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。 -->
<root>
    <level value="WARN" />
    <!-- if表达式，需要Janino jar -->
    <!-- Janino 2.6.0版本开始，除了janino.jar之外， commons-compiler.jar也需要在类路径中 -->
    <if condition='property("system_host").contains("dev")'>
        <then>
            <appender-ref ref="stdout" />
        </then>
    </if>
    <appender-ref ref="file" />
</root>

```

SpringBoot中自定义logback

SpringBoot启用自定义logback有3种方式：

classpath下存在logback-spring.xml
classpath下有logback.xml
配置文件中通过配置项指定文件：logging.config: ./logback-rule.xml

如果可能，我们建议您为日志记录配置使用-spring变体或者通过配置项的方式(例如，logback-spring.xml而不是logback.xml)。如果使用标准配置，Spring不能完全控制日志初始化。

我们本例使用logback-spring.xml作为配置文件演示。

在 src/main/resources 下创建 logback-spring.xml 文件，分开记录系统输出日志和Error日志。

```

<!--dev文件路径：src同级目录logs,如果上级目录不存在会自动创建-->
<property name="DEV_FILE_PATH" value="./logs" />
<!-- pro文件路径 -->
<property name="PRO_FILE_PATH" value="./logs-prod" />

<!-- 控制台输出 -->
<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>${CONSOLE_LOG_PATTERN}</pattern>
    </encoder>
</appender>

<!-- 按照每天生成输出日志文件 -->
<appender name="fileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <!--格式化输出：%d表示日期，%thread表示线程，%-5level：级别从左显示五个字符宽度，%logger{36}：logger是class的全名,后面的数字代表限制最长的字符，%msg：日志消息，%n换行符-->
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
    <!--滚动策略按照时间滚动-->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!-- rollover daily 文件名称 -->
        <fileNamePattern>${DEV_FILE_PATH}/output-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <!-- each file should be at most 10MB, keep 60 days worth of history, but at most 2GB -->
        <!--单个文件大小-->
        <maxFileSize>10MB</maxFileSize>
        <!--日志文件保留天数-->
        <maxHistory>60</maxHistory>
        <!--用来指定日志文件的上限大小，到了这个值就会删除旧日志-->a
        <totalSizeCap>2GB</totalSizeCap>
    </rollingPolicy>
</appender>

<!-- 按照每天生成错误日志文件 -->
<appender name="errorAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 此日志文件只记录ERROR级别的 -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>ERROR</level>
    </filter>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
    <!--输出日志到src同级目录logs中的error.log文件中-->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!--基于大小和时间的轮转策略，当日志内容超出文件大小限制后，会自动生成一个文件来继续记录和重命名-->
        <fileNamePattern>${DEV_FILE_PATH}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <!-- each file should be at most 10MB, keep 60 days worth of history, but at most 2GB -->
        <maxFileSize>10MB</maxFileSize>
        <maxHistory>60</maxHistory>
        <totalSizeCap>2GB</totalSizeCap>
    </rollingPolicy>
</appender>

<root level="INFO">
    <appender-ref ref="consoleAppender" />
    <appender-ref ref="fileAppender" />
    <appender-ref ref="errorAppender" />
</root>

```

java中打印日志：

``` @SpringBootApplication @Slf4j public class LogbackApp {

public static void main(String[] args) {
    SpringApplication.run(LogbackApp.class, args);

    log.trace("Trace 日志...");
    log.debug("Debug 日志...");
    log.info("Info 日志...");
    log.warn("Warn 日志...");
    log.error("Error 日志...");
}

} ```

输出结果：

SpringBoot官方建议使用logback-spring.xml作为logback框架的自定义日志配置文件，使用logback-spring.xml而不是logback.xml，因为带-spring后缀的配置文件可以使用一些扩展的功能。

多环境输出日志文件

Logback 配置文件中的节点指令允许您根据配置文件激活参数(active) 选择性的包含和排查部分配置信息。根据不同环境来定义不同的日志输出，在 logback-spring.xml中使用节点来定义，方法如下：

```

<springProfile name="dev">
    <root level="DEBUG">
        <appender-ref ref="consoleAppender" />
        <appender-ref ref="fileAppender" />
        <appender-ref ref="errorAppender" />
    </root>
</springProfile>

<!--生产环境:输出到文件-->
<springProfile name="prod">
    <root level="INFO">
        <appender-ref ref="consoleAppender" />
        <appender-ref ref="fileAppender" />
        <appender-ref ref="errorAppender" />
    </root>
</springProfile>

```

配置文件添加配置项：