欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

在SpringBoot中使用Logback管理记录日志

程序员文章站 2023-12-14 23:34:58
springboot的默认日志配置 springboot 开箱即用,默认帮你配置了日志框架,使用 commons logging ,但是默认配置也提供了对常用日志的支持,...

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 warninfo 级别的日志输出到控制台。 logback中没有 fatal 级别,它会被当作 error 级别来处理。

我们可以通过两种方式切换至 debug 级别:

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

多彩输出

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

  1. never :禁用ansi-colored输出(默认项)
  2. detect :会检查终端是否支持ansi,是的话就采用彩色输出(推荐项)
  3. always :总是使用ansi-colored格式输出,若终端不支持的时候,会有很多干扰信息,不推荐使用

文件输出

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

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

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

日志文件会在10mb大小的时候被截断,产生新的日志文件,默认级别为:error、warn、info

级别控制

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

配置格式: logging.level.*=level

  1. logging.level :日志级别控制前缀, * 为包名或logger名
  2. level :选项trace, debug, info, warn, error, fatal, off

举例:

  1. logging.level.com.controller=debug : com.controller 包下所有class以 debug 级别输出
  2. logging.level.root=warn :root日志以 warn 级别输出

自定义日志配置

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

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

  1. logback: logback-spring.xml , logback-spring.groovy , logback.xml , logback.groovy
  2. log4j: log4j-spring.properties , log4j-spring.xml , log4j.properties , log4j.xml
  3. log4j2: log4j2-spring.xml , log4j2.xml
  4. jdk (java util logging): logging.properties

springboot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置(如使用 logback-spring.xml ,而不是 logback.xml )

自定义输出格式

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

  1. logging.pattern.console :定义输出到控制台的样式(不支持jdk logger)
  2. 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>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。

上一篇:

下一篇: