在SpringBoot中使用Logback管理日志

2017-02-20 本文已影响1532人 Joepis

摘要: 原创出处 http://peijie2016.gitee.io 欢迎转载，保留摘要，谢谢！

SpringBoot的默认日志配置

SpringBoot开箱即用，默认帮你配置了日志框架，使用 Commons Logging ，但是默认配置也提供了对常用日志的支持，如： Java Util Logging ， Log4J , Log4J2 和 Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。

控制台输出

关于log日志，首先说说的5个日志级别 LEVEL：
从高到低分别是ERROR、WARN、INFO、DEBUG、TRACE
低级别的会输出高级别信息，高级别不会输出低级别信息。例如：等级设为ERROR的话，WARN、INFO、DEBUG的信息是不会输出的。
在SpringBoot中默认配置了ERROR 、WARN和INFO级别的日志输出到控制台。
Logback中没有FATAL级别，它会被当作ERROR级别来处理。

我们可以通过两种方式切换至 DEBUG 级别：

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

多彩输出

SpringBoot从1.4.0版本开始支持彩色日志输出了。
如果你的终端支持ANSI，设置彩色输出会让日志更具可读性。通过在 application.properties 中设置 spring.output.ansi.enabled 参数来支持。

NEVER：禁用ANSI-colored输出（默认项）
DETECT：会检查终端是否支持ANSI，是的话就采用彩色输出（推荐项）
ALWAYS：总是使用ANSI-colored格式输出，若终端不支持的时候，会有很多干扰信息，不推荐使用

文件输出

SpringBoot默认配置只会输出到控制台，并不会记录到文件中，但是我们通常生产环境使用时都需要以文件方式记录。

若要增加文件输出，需要在 application.properties 中配置 logging.file 或 logging.path 属性。

logging.file:设置文件，可以是绝对路径，也可以是相对路径。如： logging.file=my.log
logging.path:设置目录，会在该目录下创建spring.log文件，并写入日志内容，如： logging.path=/var/log

日志文件会在10Mb大小的时候被截断，产生新的日志文件，默认级别为：ERROR、WARN、INFO

级别控制

在SpringBoot中只需要在 application.properties 中进行配置完成日志记录的级别控制。

配置格式： logging.level.*=LEVEL

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

举例：

logging.level.com.controller=DEBUG ： com.controller 包下所有class以DEBUG级别输出
logging.level.root=WARN ：root日志以WARN级别输出

自定义日志配置

如果不想使用默认配置，只要加入自己的日志配置文件就行了。
由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

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

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

SpringBoot官方推荐优先使用带有 -spring 的文件名作为你的日志配置（如使用 logback-spring.xml ，而不是 logback.xml ）

自定义输出格式

在SpringBoot中可以通过在 application.properties 配置如下参数控制输出格式：

logging.pattern.console：定义输出到控制台的样式（不支持JDK Logger）
logging.pattern.file：定义输出到文件的样式（不支持JDK Logger）

也可以直接在日志配置文件中定义这些格式，而不是在应用配置文件中。

常用的Logback配置文件模板

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="d:/logs"/>

    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(--){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    <!-- Console 输出设置 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>-->
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <fileNamePattern>${LOG_HOME}/mixedSys.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 日志logger(包.类)的输出级别 -->
    <logger name="org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver" level="DEBUG" >
        <appender-ref ref="console" />
        <appender-ref ref="file" />
    </logger>

    <logger name="org.springframework.boot" level="DEBUG"/>
    <!-- 为 Hibernate sql 定制 -->
    <!-- <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />  -->

    <!-- 日志输出级别 -->
    <root level="INFO"> <!-- 此时debug级别的信息会被过滤 -->  
        <appender-ref ref="console" />   
        <appender-ref ref="file" />   
    </root> 
    
    <!--日志异步到数据库 -->    
    <!-- <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">  
        日志异步到数据库   
        <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">  
            连接池   
            <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">  
              <driverClass>com.mysql.jdbc.Driver</driverClass>  
              <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>  
              <user>root</user>  
              <password>root</password>  
            </dataSource>  
        </connectionSource>  
    </appender> -->
    
</configuration>