1. 技术文章
  2. [日志] spring boot + logback 日志输出配置

[日志] spring boot + logback 日志输出配置

由 ￣綄美尐妖づ 提交于 2020-12-05 22:03:06

一、输出日志到控制台

springboot有很多starter（参考starter）方便快速构建项目依赖组件，logback是springboot默认的日志组件，启动即可看到打印在控制台输出的info级别的日志：

2018-01-14 20:17:19.831 INFO 32976 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2018-01-14 20:17:19.832 INFO 32976 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2018-01-14 20:17:19.862 INFO 32976 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-01-14 20:17:19.862 INFO 32976 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-01-14 20:17:19.919 INFO 32976 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-01-14 20:17:20.166 INFO 32976 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
2018-01-14 20:17:20.747 INFO 32976 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8082 (http)
2018-01-14 20:17:20.754 INFO 32976 --- [ main] springboot.log.demo.LogMainApplication : Started LogMainApplication in 4.484 seconds (JVM running for 5.077)

从打印出的日志可以看到，日志输出内容元素具体如下：

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

springboot的log一般会包含在其他starter里，但也有日志starter，本例包含在

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

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

如果设置为 WARN ，则低于 WARN 的信息都不会输出。

Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。 

您还可以通过启动您的应用程序 --debug 标志来启用“调试”模式（开发的时候推荐开启）,以下两种方式皆可：

  • 在运行命令后加入--debug标志，如：$ java -jar springTest.jar --debug
  • 在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

使用lombok简化日志logger：

@Slf4j
@RestController
@RequestMapping("/log")
public class LogController {
    @RequestMapping("/demo1")
    public void demo1() {
        log.info("测试{}，输出{}", "demo1", "info level log");
    }
}

可以用{}占位符来拼接字符串，免去了用"+"拼接字符串。输出结果：

2018-01-14 20:37:57.043  INFO 9020 --- [nio-8082-exec-3] s.log.demo.controller.LogController      : 测试demo1，输出info level log

二、日志节点属性

1、根节点configuration 的属性：

（<configuration scan="true" scanPeriod="60 seconds" debug="false">）

  • scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
  • scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
  • debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

2、根节点的子节点 root：

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

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

<!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
        <appender-ref ref="consoleLog2"/>
    </root>

3、根节点的子节点 contextName：设置上下文名称

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称，一般来说我们不用这个属性，可有可无。

 <contextName>logbackdemo</contextName>

4、根节点的子节点property：设置上下文名称

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

5、根节点的子节点appender

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

控制台配置示例一：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logbackdemo</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d -1 %msg%n</pattern>
        </layout>
    </appender>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d -2 %msg%n</pattern>
        </encoder>
    </appender>

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
        <appender-ref ref="consoleLog2"/>
    </root>

</configuration>
View Code

控制台输出日志：

2018-01-14 21:58:00,800 -1 测试demo1，输出info level log
2018-01-14 21:58:00,800 -2 测试demo1，输出info level log

可以看到layout和encoder，都可以将事件转换为格式化后的日志记录，但是控制台输出使用layout，文件输出使用encoder，具体原因可以看http://blog.csdn.net/cw_hello1/article/details/51969554

控制台输出示例二：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logbackdemo</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </pattern>
        </layout>
        <!-- 过滤掉Error级别的日志，此appender仅筛选Error级别日志并输出到控制台
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>
        </filter>
         -->
    </appender>

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
    </root>
</configuration>

控制台输出日志：

22:04:41.276 logbackdemo [http-nio-8082-exec-4] INFO  s.log.demo.controller.LogController - 测试demo1，输出info level log

<encoder>表示对日志进行编码：

  • %d{HH: mm:ss.SSS}——日志输出时间
  • %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
  • %-5level——日志级别，并且使用5个字符靠左对齐
  • %logger{36}——日志输出者的名字
  • %msg——日志消息
  • %n——平台的换行符 
  • ThresholdFilter为系统定义的拦截器，例如：我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中，可以保证文件里只有Error级别日志。

输出到文件的示例（RollingFileAppender）：

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

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logbackdemo</contextName>

    <property name="logback.logdir" value="I:\\xxx\\xxx\\logs"/>
    <property name="logback.appname" value="logDemo"/>

    <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--如果只是想要 Info 级别的日志，只是过滤 info 还是会输出 Error 日志，因为 Error 的级别高，
            所以我们使用下面的策略，可以避免输出 Error 的日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!--过滤 Error-->
            <level>ERROR</level>
            <!--匹配到就禁止-->
            <onMatch>DENY</onMatch>
            <!--没有匹配到就允许-->
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <!--日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则
            如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天
            的日志改名为今天的日期。即，<File> 的日志都是当天的。
        -->
        <File>${logback.logdir}/info.${logback.appname}.log</File>
        <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间-->
            <FileNamePattern>${logback.logdir}/info.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--只保留最近90天的日志-->
            <maxHistory>90</maxHistory>
            <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
            <!--<totalSizeCap>1GB</totalSizeCap>-->
        </rollingPolicy>
        <!--日志输出编码格式化-->
        <encoder>
            <charset>UTF-8</charset>
            <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--如果只是想要 Error 级别的日志，那么需要过滤一下，默认是 info 级别的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>Error</level>
        </filter>
        <!--日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则
            如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天
            的日志改名为今天的日期。即，<File> 的日志都是当天的。
        -->
        <File>${logback.logdir}/error.${logback.appname}.log</File>
        <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间-->
            <FileNamePattern>${logback.logdir}/error.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--只保留最近90天的日志-->
            <maxHistory>90</maxHistory>
            <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
            <!--<totalSizeCap>1GB</totalSizeCap>-->
        </rollingPolicy>
        <!--日志输出编码格式化-->
        <encoder>
            <charset>UTF-8</charset>
            <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern>
        </encoder>
    </appender>

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="fileInfoLog"/>
        <appender-ref ref="fileErrorLog"/>
    </root>
</configuration>
View Code

测试log：

@Slf4j
@RestController
@RequestMapping("/log")
public class LogController {
    @RequestMapping("/demo1")
    public void demo1() { log.info("测试{}，日志级别{}，输出{}", "demo1", "info", "info level log"); log.error("测试{}，日志级别{}，输出{}", "error", "error", "error level log"); } }

可以看到控制台不输出任何log，并且在指定的路径 logback.logdir 下生成了两个文件：

error.logDemo.log

info.logDemo.log

error级别的日志：

2018-01-14 22:25:40,921 [http-nio-8082-exec-1] ERROR s.log.demo.controller.LogController 18 - 测试error，日志级别error，输出error level log

info级别日志：

2018-01-14 22:25:29,041 [main] INFO o.a.coyote.http11.Http11NioProtocol 179 - Initializing ProtocolHandler ["http-nio-8082"]
2018-01-14 22:25:29,057 [main] INFO o.a.coyote.http11.Http11NioProtocol 179 - Starting ProtocolHandler ["http-nio-8082"]
2018-01-14 22:25:29,282 [main] INFO o.a.tomcat.util.net.NioSelectorPool 179 - Using a shared selector for servlet write/read
2018-01-14 22:25:29,653 [main] INFO o.s.b.c.e.t.TomcatEmbeddedServletContainer 198 - Tomcat started on port(s): 8082 (http)
2018-01-14 22:25:29,661 [main] INFO s.log.demo.LogMainApplication 57 - Started LogMainApplication in 4.743 seconds (JVM running for 5.28)
2018-01-14 22:25:40,870 [http-nio-8082-exec-1] INFO o.a.c.c.C.[Tomcat].[localhost].[/] 179 - Initializing Spring FrameworkServlet 'dispatcherServlet'
2018-01-14 22:25:40,871 [http-nio-8082-exec-1] INFO o.s.web.servlet.DispatcherServlet 489 - FrameworkServlet 'dispatcherServlet': initialization started
2018-01-14 22:25:40,892 [http-nio-8082-exec-1] INFO o.s.web.servlet.DispatcherServlet 508 - FrameworkServlet 'dispatcherServlet': initialization completed in 21 ms
2018-01-14 22:25:40,921 [http-nio-8082-exec-1] INFO s.log.demo.controller.LogController 16 - 测试demo1，日志级别info，输出info level log

通过配置 fileInfoLog 与 fileErrorLog 可以实现info级别日志与error级别日志分开记录。

将本机时间调到明天，再次执行程序：

info已经归档了（日志配置的info级别的归档），info.logDemo.log的永远是当天的日志文件。

6、根节点的子节点logger

<logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。

  • name:用来指定受此loger约束的某一个包或者具体的某一个类。
  • level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
  • addtivity:是否向上级logger传递打印信息。默认是true(当为true时，还会被匹配到的root再次输出一次log)。

示例记录了trace、debug、info、warn、error级别日志：

@Slf4j
@RestController
@RequestMapping("/log")
public class LogController {
    @RequestMapping("/demo1")
    public void demo1() {
        //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。
        log.trace("测试{}，日志级别{}，输出{}", "demo1", "trace", "trace level log");

        log.debug("测试{}，日志级别{}，输出{}", "demo1", "debug", "debug level log");

        log.info("测试{}，日志级别{}，输出{}", "demo1", "info", "info level log");

        log.warn("测试{}，日志级别{}，输出{}", "demo1", "warn", "warn level log");

        log.error("测试{}，日志级别{}，输出{}", "demo1", "error", "error level log");
    }
}

a、只指定name

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logbackdemo</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </pattern>
        </layout>
    </appender>

    <logger name="springboot.log.demo.controller.LogController" />

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
    </root>
</configuration>
<logger name="springboot.log.demo.controller.LogController" /> 将控制 LogController 包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“info”； 

没有设置addtivity，默认为true，将此loger的打印信息向上级传递； 
没有设置appender，此logger本身不打印任何信息。
运行程序时，LogController 的log会将默认级别为log或大于log级别的日志信息传递给root，root接收到log后传递给配置好的 consoleLog1 处理 consoleLog1 的appender将日志格式化输出到控制台。输出日志：

22:58:05.047 logbackdemo [http-nio-8082-exec-1] INFO s.log.demo.controller.LogController - 测试demo1，日志级别info，输出info level log
22:58:05.047 logbackdemo [http-nio-8082-exec-1] WARN s.log.demo.controller.LogController - 测试demo1，日志级别warn，输出warn level log
22:58:05.047 logbackdemo [http-nio-8082-exec-1] ERROR s.log.demo.controller.LogController - 测试demo1，日志级别error，输出error level log

b、指定级别，指定appender

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logbackdemo</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </pattern>
        </layout>
    </appender>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
            </pattern>
        </layout>
    </appender>

    <!--<logger name="springboot.log.demo.controller.LogController" />-->

    <!-- 类的全路径 -->
    <logger name="springboot.log.demo.controller.LogController" level="WARN" additivity="false">
        <appender-ref ref="consoleLog2"/>
    </logger>

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
    </root>
</configuration>

运行程序时，LogController 将log级别大于等于WARN的日志交给logger指定的名为consoleLog2的appender来处理。并且配置了additivity=false，日志不再向上级传递，打印结果：

23:11:20.576 WARN s.log.demo.controller.LogController - 测试demo1，日志级别warn，输出warn level log
23:11:20.577 ERROR s.log.demo.controller.LogController - 测试demo1，日志级别error，输出error level log

当然如果你把additivity="false"改成additivity="true"的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。

不要配置多个相同的logger。如果配置多个logger，范围小的有效：

<logger name="springboot.log.demo.controller.LogController" />

    <!-- 类的全路径 -->
    <logger name="springboot.log.demo.controller.LogController" level="DEBUG" additivity="false">
        <appender-ref ref="consoleLog2"/>
    </logger>

控制台输出：

23:17:00.100 DEBUG s.log.demo.controller.LogController - 测试demo1，日志级别debug，输出debug level log
23:17:00.100 INFO  s.log.demo.controller.LogController - 测试demo1，日志级别info，输出info level log
23:17:00.100 WARN  s.log.demo.controller.LogController - 测试demo1，日志级别warn，输出warn level log
23:17:00.100 ERROR s.log.demo.controller.LogController - 测试demo1，日志级别error，输出error level log

三、多环境日志输出

<configuration>
    ...

    <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    <springProfile name="test,dev">
        <logger name="springboot.log.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>

    <!-- 生产环境. -->
    <springProfile name="prod">
        <logger name="springboot.log.demo.controller" level="INFO" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>
</configuration>

当application.yml设置环境为test时，激活log为test配置；设置为prod时，激活log配置为prod配置：

spring:
  profiles:
    active: test

四、自定义日志配置

开发调试中输出到控制台可以利于排错和调试，但是测试环境和生产环境要查看日志就需要保留日志到指定存储的地方，这时候就需要使用自定义日志输出格式和保存路径了。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2：log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)：logging.properties

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

默认的命名规则，并且放在 src/main/resources 下面即可。如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，application.yml可以通过logging.config属性指定自定义的名字：

logging.config=classpath:logging-config.xml

五：输出mybatis执行sql的log

开发中常常需要将mybatis执行的sql输出到控制台，但mybatis的sql输出级别是debug，可以利用logger的属性针对mapper包设置输出log级别，如下所示：

<springProfile name="dev">
        <root>
            <level value="info"/>
            <appender-ref ref="STDOUT"/>
        </root>
        <logger name="com.demo.mapper" level="DEBUG" additivity="false">
            <appender-ref ref="STDOUT" />
        </logger>
    </springProfile>

六：参考

http://blog.csdn.net/inke88/article/details/75007649

http://blog.csdn.net/vitech/article/details/53812137

https://juejin.im/post/58f86981b123db0062363203

标签
Java EE
java
Tomcat
Spring
slf4j
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!