SpringBoot项目中使用Logback实现多环境日志配置详解

一、前言

SpringBoot工程自带logback和slf4j的依赖，所以重点放在编写配置文件上，需要引入什么依赖，日志依赖冲突统统都不需要我们管了。logback框架会默认加载classpath下命名为logback-spring或logback的配置文件。

将所有日志都存储在一个文件中，文件大小也随着应用的运行越来越大并且不好排查问题，正确的做法应该是将error日志和其他日志分开，并且不同级别的日志根据时间段进行记录存储。像我们项目中也会把这些日志搜集起来，用kibana记录并图形可视化，这样对于生产问题，我们能快递的定位出问题。所以好的系统我觉得日志管理这一模块一定得做好。

进入正文之前我们来想一想这几个问题。

如何引入日志？ 日志输出格式以及输出方式如何配置？ 代码中如何使用？

二、默认日志Logback

SLF4J——Simple Logging Facade For Java，它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口，而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。

默认情况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。在运行应用程序和其他例子时，你应该已经看到很多INFO级别的日志了。

从上图可以看到，日志输出内容元素具体如下：

时间日期：精确到毫秒 日志级别：ERROR, WARN, INFO, DEBUG or TRACE 进程ID 分隔符：— 标识实际日志的开始 线程名：方括号括起来（可能会截断控制台输出） Logger名：通常使用源代码的类名 日志内容

引入maven依赖

<dependency>
     <groupId>ch.qos.logbackgroupId>
     <artifactId>logback-classicartifactId>
     <version>1.2.3version>
dependency>

但是呢，实际开发中我们不需要直接添加该依赖，你会发现spring-boot-starter其中包含了 spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 logback。而博主工程中有用到了Thymeleaf，而Thymeleaf依赖包含了spring-boot-starter，最终我只要引入Thymeleaf即可，没有引入Thymeleaf的还是要添加logback的依赖。

三、自定义日志配置

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。

上面是默认的命名规则，并且放在src/main/resources下面即可。

如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以在application.properties配置文件里面通过logging.config属性指定自定义的名字：

logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时Profile使用不同的日志配置，这个功能会很有用。

下面我们来看看一个普通的logback-spring.xml例子

logback.xml 配置样例

虽然上面配置上有简单的介绍，但下面我们还是做个详细的解释：

属性一：设置上下文名称

<contextname>logbackcontextname>

属性二：设置变量

用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

<property name="log.path" value="/Users/riemann/Documents/log" />

子节点一

appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

控制台输出ConsoleAppender：

<appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%npattern>
    encoder>
appender>

表示对日志进行编码：

%d{yyyy-MM-dd’ 'HH:mm:ss.sss}——日志输出时间 %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用 %-5level——日志级别，并且使用5个字符靠左对齐 %logger{36}——日志输出者的名字 %msg——日志消息 %n——平台的换行符；
ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志。

输出到文件RollingFileAppender

一种常见的日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志：

<appender name="INFO-LOG"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERRORlevel>
            <onMatch>DENYonMatch>
            <onMismatch>ACCEPTonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <fileNamePattern>${LOG_INFO_HOME}//%d{yyyy-MM-dd}_%i.log
            fileNamePattern>
            <maxHistory>30maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                
                <maxFileSize>64 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} %-5level [%thread] %logger{50}-%L %msg%npattern>
        encoder>
    appender>

其中重要的是rollingPolicy的定义，上例中${LOG_INFO_HOME}//%d{yyyy-MM-dd}_%i.log定义了日志的切分方式——把每一天的日志归档到一个文件中，30表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。1GB用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。1GB

补:如果你想把日志直接放到当前项目下，把${log.path}/去掉即可。

子节点二

root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。
默认是DEBUG。
可以包含零个或多个元素，标识这个appender将会添加到这个logger。

<root level="info">
    <appender-ref ref="CONSOLE-LOG" />
    <appender-ref ref="INFO-LOG" />
    <appender-ref ref="ERROR-LOG" />
root>

总配置

<configuration>

    

    
    

    
    <appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%npattern>
        encoder>
    appender>

    
    <appender name="INFO-LOG"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERRORlevel>
            <onMatch>DENYonMatch>
            <onMismatch>ACCEPTonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <fileNamePattern>${LOG_INFO_HOME}//%d{yyyy-MM-dd}_%i.log
            fileNamePattern>
            <maxHistory>30maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                
                <maxFileSize>64 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} %-5level [%thread] %logger{50}-%L %msg%npattern>
        encoder>
    appender>

    <appender name="ERROR-LOG"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERRORlevel>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <fileNamePattern>${LOG_ERROR_HOME}//%d{yyyy-MM-dd}_%i.log
            fileNamePattern>
            <maxHistory>30maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                
                <maxFileSize>64 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} %-5level [%thread] %logger{50}-%L %msg%npattern>
        encoder>
    appender>

    
    <logger name="org.springframework.web" level="INFO" />
    <logger name="org.springframework" level="INFO" />
    <logger name="com.riemann.springbootdemo" level="DEBUG" />

    
    <root level="INFO">
        <appender-ref ref="CONSOLE-LOG" />
        <appender-ref ref="INFO-LOG" />
        <appender-ref ref="ERROR-LOG" />
    root>
configuration>

四、代码中如何使用

package com.riemann.springbootdemo.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author riemann
 * @date 2019/08/23 23:50
 */
@Controller
public class LogbackController {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "/check/{flag}",method = RequestMethod.GET)
    @ResponseBody
    public String check(@PathVariable("flag") String flag){
        //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。
        logger.trace("日志输出 trace");
        logger.debug("日志输出 debug");
        logger.info("日志输出 info");
        logger.warn("日志输出 warn");
        logger.error("日志输出 error");
        if ("true".equalsIgnoreCase(flag)) {
            return "success";
        }
        return "false";
    }
}

打印结果：

2019-08-24 01:43:02.099 [http-nio-8080-exec-1] DEBUG c.r.springbootdemo.controller.LogbackController-日志输出 debug
2019-08-24 01:43:02.099 [http-nio-8080-exec-1] INFO  c.r.springbootdemo.controller.LogbackController-日志输出 info
2019-08-24 01:43:02.100 [http-nio-8080-exec-1] WARN  c.r.springbootdemo.controller.LogbackController-日志输出 warn
2019-08-24 01:43:02.100 [http-nio-8080-exec-1] ERROR c.r.springbootdemo.controller.LogbackController-日志输出 error

之所以会出现四个级别的日志信息，那是因为：

<logger name="com.riemann.springbootdemo" level="DEBUG" />

日志信息根据不同的配置到不同的目录文件中去

INFO级别的日志信息，没有ERROR级别的日志信息。

ERROR级别的日志信息都在这里

这样就起到了不同的日志级别被记录到不同的文件目录中去。

五、多环境日志输出

据不同环境（prod:生产环境，test:测试环境，dev:开发环境）来定义不同的日志输出，在 logback-spring.xml中使用 springProfile 节点来定义，方法如下：

文件名称不是logback.xml，想使用spring扩展profile支持，要以logback-spring.xml命名

<springprofile name="test,dev">
    <logger level="info" name="com.riemann.springbootdemo.controller">
logger>springprofile>

<springprofile name="prod">
    <logger level="ERROR" name="com.riemann.springbootdemo.controller">
logger>springprofile>

可以启动服务的时候指定 profile （如不指定使用默认），如指定prod 的方式为：
java -jar xxx.jar –spring.profiles.active=prod

或者直接在配置中配置指定的profile ：

六、最后

最后想必小伙伴们带着开头的那三个问题看，这三个问题也迎刃而解了。好了，都凌晨两点多了，写得博主都饿了，但写得对你有帮助的话，我也是很欣慰的。小伙伴们方便的话可以关注下博主以及点下赞，谢谢大家观看及支持。