SpringBoot中配置logback

用户5224393

发布于 2019-08-13 14:50:26

3K0

发布于 2019-08-13 14:50:26

文章被收录于专栏：Java研发军团Java研发军团

1.简单日志配置

spring boot内部使用Commons Logging来记录日志，但也保留外部接口可以让一些日志框架来进行实现，例如Java Util Logging,Log4J2还有Logback。

如果你想用某一种日志框架来进行实现的话，就必须先配置，默认情况下，spring boot使用Logback作为日志实现的框架。

1.1 配置控制台日志的debug级别

默认情况下，springboot从控制台打印出来的日志级别只有ERROR, WARN 还有INFO，如果你想要打印debug级别的日志，可以通过application.properites配置debug=true

1.2 在生产环境环境下，你可以通过命令行进行配置日志的debug级别

java -jarC:\Users\Administrator\Desktop\xx\demo.jar --debug

**1.3 配置logging.level.*来具体输出哪些包的日志级别**

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

1.4 将日志输出到文件中

默认情况下springboot是不将日志输出到日志文件中，但你可以通过在application.properites文件中配置logging.file文件名称和logging.path文件路径，将日志输出到文件中

logging.path=F:\\demo
logging.file=demo.log
logging.level.root=info

这里需要注意几点：

这里若不配置具体的包的日志级别，日志文件信息将为空

若只配置logging.path，那么将会在F:\demo文件夹生成一个日志文件为spring.log（ps：该文件名是固定的，不能更改）。

如果path路径不存在，会自动创建该文件夹，若只配置logging.file，那将会在项目的当前路径下生成一个demo.log日志文件。

这里可以使用绝对路径如，会自动在e盘下创建文件夹和相应的日志文件。

logging.file=e:\\demo\\demo.log

logging.path和logging.file同时配置，不会在这个路径有F:\demo\demo.log日志生成，logging.path和logging.file不会进行叠加（要注意）

logging.path和logging.file的value都可以是相对路径或者绝对路径，这就是基础的日志配置，可以直接在application.properties配置。我们还可以在classpath路径下，通过定义具体的日志文件来配置——logback.xml

2.logback的介绍及配置

2.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

本文章用到的组件如下：请自行到官方网站下载！

logback-access-1.0.0.jar

logback-classic-1.0.0.jar

logback-core-1.0.0.jar

slf4j-api-1.6.0.jar

maven配置

<dependency> 
      <groupId>ch.qos.logback</groupId> 
      <artifactId>logback-classic</artifactId> 
    <version>1.0.11</version> 
</dependency>

ps:在spring boot项目中，会默认引入logback相关的jar包。

2.2 logback取代 log4j的理由

Logback和log4j是非常相似的，如果你对log4j很熟悉，那对logback很快就会得心应手。下面列了logback相对于log4j的一些优点：

1、更快的实现 Logback的内核重写了，在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了，初始化内存加载也更小了。

2、非常充分的测试 Logback经过了几年，数不清小时的测试。Logback的测试完全不同级别的。在作者的观点，这是简单重要的原因选择logback而不是log4j。

3、Logback-classic非常自然实现了SLF4j Logback-classic实现了 SLF4j。在使用SLF4j中，你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了SLF4J，所以切换到log4j或者其他，非常容易，只需要提供成另一个jar包就OK，根本不需要去动那些通过SLF4JAPI实现的代码。

4、非常充分的文档官方网站有两百多页的文档。

5、自动重新加载配置文件当配置文件修改了，Logback-classic能自动重新加载配置文件。扫描过程快且安全，它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。

6、Lilith Lilith是log事件的观察者，和log4j的chainsaw类似。而lilith还能处理大数量的log数据。

7、谨慎的模式和非常友好的恢复在谨慎模式下，多个FileAppender实例跑在多个JVM下，能够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender能够非常友好地从I/O异常中恢复。

8、配置文件可以处理不同的情况开发人员经常需要判断不同的Logback配置文件在不同的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不同，可以通过,和来实现，这样一个配置文件就可以适应多个环境。

9、Filters（过滤器）有些时候，需要诊断一个问题，需要打出日志。在log4j，只有降低日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你可以继续保持那个日志级别而除掉某种特殊情况，如alice这个用户登录，她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需加4行XML配置。可以参考MDCFIlter 。

10、SiftingAppender（一个非常多功能的Appender）它可以用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender能够区别日志事件跟进用户的Session，然后每个用户会有一个日志文件。

11、自动压缩已经打出来的log RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，所以甚至对于大的日志文件，在压缩过程中应用不会受任何影响。

12、堆栈树带有包版本 Logback在打出堆栈树日志时，会带上包的数据。

13、自动去除旧的日志文件通过设置TimeBasedRollingPolicy或者

SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。总之，logback比log4j太优秀了，让我们的应用全部建立logback上吧！

2.3 Logback的配置介绍

1、Logger、appender及layout

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

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

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

2、logger context

各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger 名称为参数。用同一名字调用LoggerFactory.getLogger方法所得到的永远都是同一个logger对象的引用。

3、有效级别及级别的继承

Logger 可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于 ch.qos.logback.classic.Level类。如果 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。rootlogger 默认级别是 DEBUG。

4、打印方法与基本的选择规则

打印方法决定记录请求的级别。例如，如果 L 是一个 logger 实例，那么，语句 L.info("..")是一条级别为 INFO 的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，否则，称为被禁用。记录请求级别为 p，其logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。

该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERROR。

3.logback的使用

3.1 Logback的默认配置

如果配置文件logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。

输出用模式为%d{HH:mm:ss.SSS} [%thread]%-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。

1、Logback的配置文件

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

2、Logback默认配置的步骤

(1). 尝试在 classpath 下查找文件 logback-test.xml；

(2). 如果文件不存在，则查找文件logback.xml；

(3). 如果两个文件都不存在，logback用 BasicConfigurator 自动对自己进行配置，这会导致记录输出到控制台。

3、Logback.xml 文件

<?xmlversion="1.0" encoding="UTF-8"?>
<!--
    Copyright 2010-2011 The myBatis Team
    Licensed under the Apache License, Version2.0 (the "License");
    you may not use this file except incompliance with the License.
    You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
    Unless required by applicable law or agreedto in writing, software
    distributed under the License isdistributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANYKIND, either express or implied.
    See the License for the specific languagegoverning permissions and
    limitations under the License.
-->
<configurationdebug="false">
    <!--定义日志文件的存储地址勿在 LogBack 的配置中使用相对路径--> 
    <property name="LOG_HOME"value="/home" /> 
    <!-- 控制台输出 -->  
    <appender name="STDOUT"class="ch.qos.logback.core.ConsoleAppender">
        <encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-ddHH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>  
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->  
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">  
        <rollingPolicyclass="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
           <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
           <MaxHistory>30</MaxHistory>
        </rollingPolicy>  
        <encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-ddHH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>  
        </encoder>
        <!--日志文件最大的大小-->
       <triggeringPolicyclass="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
        <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
    </appender>
   <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" /> 
    <loggername="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" /> 
    <loggername="org.hibernate.SQL" level="DEBUG" /> 
    <loggername="org.hibernate.engine.QueryParameters" level="DEBUG"/>
    <loggername="org.hibernate.engine.query.HQLQueryPlan"level="DEBUG" /> 
   
    <!--myibatis log configure-->
    <loggername="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection"level="DEBUG"/>
    <loggername="java.sql.Statement" level="DEBUG"/>
    <loggername="java.sql.PreparedStatement" level="DEBUG"/>
   
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
     <!--日志异步到数据库 --> 
    <appender name="DB"class="ch.qos.logback.classic.db.DBAppender">
        <!--日志异步到数据库 -->
        <connectionSourceclass="ch.qos.logback.core.db.DriverManagerConnectionSource">
           <!--连接池 -->
           <dataSourceclass="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>

3.2 在程序用引用Logback

public class BlogAction{
    //定义一个全局的记录器，通过LoggerFactory获取
    privatefinal static Logger logger = LoggerFactory.getLogger(BlogAction.class);
   
   public static void main(String[] args) {
       logger.info("logback 成功了");
       logger.error("logback 成功了");
    }
}

4.在Spring-boot+MyBatis框架中集成logback

在Spring Boot中你可以在logback.xml或者在logback-spring.xml中对Logback进行配置，相对于logback.xml,logback-spring.xml更加被偏爱。下面我们以logback-spring.xml为例。

<?xmlversion="1.0"encoding="UTF-8"?>
<configuration><!--debug="true" scan="true" scanPeriod="30 seconds"-->
   <springPropertyscope="context"name="logLevel"source="log.level"/>
   <springPropertyscope="context"name="logPath"source="log.path"/>
   <contextName>rc-api</contextName>
 
   <appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender">
      <encoder>
         <pattern>%d{yyyy-MM-ddHH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
         <charset>utf-8</charset>
      </encoder>
      <filterclass="ch.qos.logback.classic.filter.ThresholdFilter">
         <level>DEBUG</level>
      </filter>
   </appender>
 
   <appendername="INFO"class="ch.qos.logback.core.rolling.RollingFileAppender">
      <file>${logPath}/log_info.log</file>
      <rollingPolicyclass="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
         <fileNamePattern>${logPath}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
         <timeBasedFileNamingAndTriggeringPolicyclass="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>100MB</maxFileSize>
         </timeBasedFileNamingAndTriggeringPolicy>
      </rollingPolicy>
      <append>true</append>
      <encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
         <pattern>%d{yyyy-MM-ddHH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
         <charset>utf-8</charset>
      </encoder>
      <filterclass="ch.qos.logback.classic.filter.LevelFilter">
         <level>INFO</level>
         <onMatch>ACCEPT</onMatch>
         <onMismatch>DENY</onMismatch>
      </filter>
   </appender>
  
   <appendername="ERROR"class="ch.qos.logback.core.rolling.RollingFileAppender">
      <file>${logPath}/log_error.log</file>
      <rollingPolicyclass="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
         <fileNamePattern>${logPath}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
         <timeBasedFileNamingAndTriggeringPolicyclass="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>100MB</maxFileSize>
         </timeBasedFileNamingAndTriggeringPolicy>
      </rollingPolicy>
      <append>true</append>
      <encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
         <pattern>%d{yyyy-MM-ddHH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
         <charset>utf-8</charset>
      </encoder>
      <filterclass="ch.qos.logback.classic.filter.LevelFilter">
         <level>ERROR</level>
         <onMatch>ACCEPT</onMatch>
         <onMismatch>DENY</onMismatch>
      </filter>
   </appender>
  
   <appendername="SQL"class="ch.qos.logback.core.rolling.RollingFileAppender">
      <file>${logPath}/log_sql.log</file>
      <rollingPolicyclass="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
         <fileNamePattern>${logPath}/sql/log-sql-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
         <timeBasedFileNamingAndTriggeringPolicyclass="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>100MB</maxFileSize>
         </timeBasedFileNamingAndTriggeringPolicy>
      </rollingPolicy>
      <append>true</append>
      <encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
         <pattern>%d{yyyy-MM-ddHH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
         <charset>utf-8</charset>
      </encoder>
   </appender>
  
   <loggername="dao"level="DEBUG"> 
       <appender-refref="SQL"/> 
   </logger>
    
   <rootlevel="${logLevel}">
      <appender-refref="STDOUT"/>
      <appender-refref="INFO"/>
      <appender-refref="ERROR"/>
   </root>
</configuration>

需要注意的问题：如果想让sql输出到对应的文件中，必须在mybatis-config.xml的配置文件中配置如下内容：

<setting name="logPrefix" value="dao."/>

声明：资源收集至小流年CSDN，如有侵权，请联系小编删除。

原文地址：https://blog.csdn.net/u014029255/article/details/56841265

本文参与?腾讯云自媒体分享计划，分享自微信公众号。

原始发表：2018-06-23，如有侵权请联系?cloudcommunity@tencent.com 删除

xml

本文分享自 Java研发军团微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与?腾讯云自媒体分享计划? ，欢迎热爱写作的你一起参与！

登录后参与评论

0 条评论

热度