spring boot（8）默认日志logback配置

1 日志简介

    Spring Boot使用Commons Logging记录全部内部日志，可是它将底层日志实现打开，为Java.Util.Logging，Log4J2和Logback提供默认配置。 在每一个案例中，loggers都预先配置，以使用控制台输出，同时还提供可选的文件输出。

      默认状况下，若是你使用“starters”，Logback将会被用于记录日志。还包括占用Logback路由，以确保使用Java Util Logging、Commons logging、Log4J或SLF4J的依赖库都能正常工做。

2 默认日志logback

2.1 logback日志简介

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

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

      默认状况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。在运行应用程序和其余例子时，能够看到不少INFO级别的日志。

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

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

      用Logback来记录日志，需添加日志依赖

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

     实际开发中咱们不须要直接添加该依赖，你会发现spring-boot-starter其中包含了spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 logback。

2.2 application.properties配置中的日志相关属性

2.2.1 控制台输出  

      日志级别从低到高分为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的时候，核心Loggers（包含嵌入式容器、hibernate、spring）会输出更多内容，启用debug模式并不会使用debug级别配置您的应用程序来记录全部信息。

      或者，您能够经过在应用程序中使用-trace标志(或在application.properties中配置trace=true)启动应用程序来启用“跟踪”模式。

2.2.2 文件输出

      默认状况下，Spring Boot将日志输出到控制台，不会写到日志文件。若是要编写除控制台输出以外的日志文件，则需在application.properties中设置logging.file或logging.path属性。

• logging.file，设置指定的日志文件，能够是绝对路径，也能够是相对路径。如：logging.file=my.log
• logging.path，设置指定的目录，会在该目录下建立spring.log文件，并写入日志内容，如：logging.path=/var/log

    默认状况下，日志文件的大小达到10MB时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

     日志系统在应用程序生命周期的早期被初始化，而且在经过@propertysource注解加载的属性文件中不会找到这样的日志属性。

   日志属性与实际的日志基础结构无关。所以，特定的配置键(例如logback中的 logback.configurationFile )不是由spring boot管理的。

2.2.3 彩色日志输出

      省略...     

2.2.4 日志级别

       全部支持日志记录的系统均可以在Spring环境中设置记录级别（例如在application.properties中）
格式为：’logging.level.* = LEVEL’

• logging.level：日志级别控制前缀，*为包名或Logger名
• LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

       root日志可使用 logging.level.root 配置，application.properties实例：

logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR

       默认状况下，Spring boot对 Thymeleaf INFO 消息进行了从新映射，使它们在调试级别上被记录，这有助于减小标准日志输出中的噪声。有关如何在本身的配置中应用从新映射的详细信息，请参阅LevelRemappingAppender。

2.2.5 自定义日志配置

      能够经过在classpath中包含适当的库来激活各类日志系统，并经过在classpath根目录提供适当的配置进行定制。或者在适当的位置提供spring 环境属性logging.config。

      还能够强制spring boot使用特定的日志系统经过使用 org.springframework.boot.logging.LoggingSystem 系统属性。 该值应该是一个 LoggingSystem 实现的彻底限定类名。 您还可使用none值彻底禁用Spring boot的日志记录配置。

    因为日志是在应用程序applicationContext上下文建立以前初始化的，因此不可能在Spring @configuration注解文件中控制来自@propertySource的日志记录。系统属性和常规的Spring boot外部配置文件已经工做得很好。

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

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

     在可能的状况下，咱们建议您使用-spring变体来进行日志配置( 如使用logback-spring.xml，而不是logback.xml )。若是使用标准配置logback.xml，Spring没法彻底控制日志初始化。 Spring boot包含许多对Logback的扩展，能够帮助高级配置，您能够在您的logback-spring.xml文件中使用这些扩展。在标准配置logback.xml中不能使用这些扩展由于它太早被加载，固然若是必定要使用，需定义一个 logging.config 属性。

注：这些扩展不能与Logback的配置扫描一块儿使用。若是您尝试这样作，对配置文件进行更改将致使相似于如下日志记录之一的错误:

ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]

 

3 logback日志介绍与配置

3.1 logback介绍

    Logback是由log4j创始人设计的又一个开源日志组件。logback当前分红三个模块：logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你能够很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供经过Http来访问日志的功能。 Logback是要与SLF4J结合起来用两个组件的官方网站以下：

      logback的官方网站： http://logback.qos.ch

      SLF4J的官方网站：http://www.slf4j.org

3.2 logback取代log4j的理由

     Logback和log4j是很是类似的，若是你对log4j很熟悉，那对logback很快就会驾轻就熟。下面列了logback相对于log4j的一些优势：

• 更快的实现  Logback的内核重写，在一些关键执行路径上性能提高10倍以上。并且logback不只性能提高，初始化内存加载也更小。
• 很是充分的测试  Logback通过了几年，数不清小时的测试，Logback的测试彻底不一样级别的。在做者的观点，这是简单重要的缘由选择logback而不是log4j。
• Logback-classic很是天然实现了SLF4j    由于logback-classic很是天然地实现了SLF4J，  所 以切换到log4j或者其余，很是容易，只须要提供成另外一个jar包就OK，根本不须要去动那些经过SLF4JAPI实现的代码。
• 很是充分的文档  官方网站有两百多页的文档。
• 自动从新加载配置文件  当配置文件修改，Logback-classic能自动从新加载配置文件。扫描过程快且安全，它并不须要另外建立一个扫描线程。
• Lilith   Lilith是log事件的观察者，和log4j的chainsaw相似。而lilith还能处理大数量的log数据 。
• 谨慎的模式和很是友好的恢复  在谨慎模式下，多个FileAppender实例跑在多个JVM下，能 够安全地写道同一个日志文件，RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender可以很是友好地从I/O异常中恢复。
• 配置文件能够处理不一样的状况   开发人员常常须要判断不一样的Logback配置文件在不一样的环境下（开发，测试，生产）。
• Filters（过滤器）  有些时候，须要诊断一个问题，须要打出日志。在log4j，只有下降日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你能够继续 保持那个日志级别而除掉某种特殊状况，如alice这个用户登陆，她的日志将打在DEBUG级别而其余用户能够继续打在WARN级别。要实现这个功能只需 加4行XML配置。能够参考MDCFIlter 。
• SiftingAppender（一个很是多功能的Appender）  它能够用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender可以区别日志事件跟进用户的Session，而后每一个用户会有一个日志文件。
• 自动压缩已经打出来的log  RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，因此甚至对于大的日志文件，在压缩过程当中应用不会受任何影响。
• 堆栈树带有包版本  Logback在打出堆栈树日志时，会带上包的数据。
• 自动去除旧的日志文件  经过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你能够控制已经产生日志文件的最大数量。

      总之，logback比log4j优秀。

3.3 logback配置

      Logback 配置文件的语法很是灵活。正由于灵活，因此没法用 DTD 或 XML schema 进行定义。尽管如此，能够这样描述配置文件的基本结构：以<configuration>开头，后面有零个或多个<appender>元素，有零个或多个<logger>元素，有最多一个<root>元素。

      logback配置文件实例：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->  
    <property name="LOG_HOME" value="/home" />  
    <!-- 控制台输出 -->   
    <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}/TestWeb.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> 
    
    <!--myibatis log configure--> 
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root> 
</configuration>