网站开发解决方案,无锡市梁溪区建设局网站,怎样注册wordpress,正版电子商务网SpringBoot默认日志logback配置解析
前言
今天来介绍下Spring Boot如何配置日志logback,我刚学习的时候#xff0c;是带着下面几个问题来查资料的#xff0c;你呢
如何引入日志#xff1f;日志输出格式以及输出方式如何配置#xff1f;代码中如何使用#xff1f;
正文…SpringBoot默认日志logback配置解析
前言
今天来介绍下Spring Boot如何配置日志logback,我刚学习的时候是带着下面几个问题来查资料的你呢
如何引入日志日志输出格式以及输出方式如何配置代码中如何使用
正文
Spring Boot在所有内部日志中使用Commons Logging但是默认配置也提供了对常用日志的支持如Java Util LoggingLog4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。
默认日志Logback
SLF4J——Simple Logging Facade For Java它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logbackcommons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。
Logback是log4j框架的作者开发的新一代日志框架它效率更高、能够适应诸多的运行环境同时天然支持SLF4J。
默认情况下Spring Boot会用Logback来记录日志并用INFO级别输出到控制台。在运行应用程序和其他例子时你应该已经看到很多INFO级别的日志了。 从上图可以看到日志输出内容元素具体如下
时间日期精确到毫秒日志级别ERROR, WARN, INFO, DEBUG or TRACE进程ID分隔符--- 标识实际日志的开始线程名方括号括起来可能会截断控制台输出Logger名通常使用源代码的类名日志内容
添加日志依赖
假如maven依赖中添加了spring-boot-starter-logging
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-logging/artifactId
/dependency那么我们的Spring Boot应用将自动使用logback作为应用日志框架Spring Boot启动的时候由org.springframework.boot.logging.Logging-Application-Listener根据情况初始化并使用。
但是呢实际开发中我们不需要直接添加该依赖你会发现spring-boot-starter其中包含了 spring-boot-starter-logging该依赖内容就是 Spring Boot 默认的日志框架 logback。而博主这次项目的例子是基于上一篇的工程中有用到了Thymeleaf而Thymeleaf依赖包含了spring-boot-starter最终我只要引入Thymeleaf即可。
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-thymeleaf/artifactId
/dependency默认配置属性支持
Spring Boot为我们提供了很多默认的日志配置所以只要将spring-boot-starter-logging作为依赖加入到当前应用的classpath则“开箱即用”。 下面介绍几种在application.properties就可以配置的日志相关属性。
控制台输出
日志级别从低到高分为TRACE DEBUG INFO WARN ERROR FATAL如果设置为WARN则低于WARN的信息都不会输出。 Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。您还可以通过启动您的应用程序–debug标志来启用“调试”模式开发的时候推荐开启,以下两种方式皆可
在运行命令后加入--debug标志如$ java -jar springTest.jar --debug在application.properties中配置debugtrue该属性置为true的时候核心Logger包含嵌入式容器、hibernate、spring会输出更多内容但是你自己应用的日志并不会输出为DEBUG级别。
文件输出
默认情况下Spring Boot将日志输出到控制台不会写到日志文件。如果要编写除控制台输出之外的日志文件则需在application.properties中设置logging.file或logging.path属性。
logging.file设置文件可以是绝对路径也可以是相对路径。如logging.filemy.loglogging.path设置目录会在该目录下创建spring.log文件并写入日志内容如logging.path/var/log
如果只配置 logging.file会在项目的当前路径下生成一个 xxx.log 日志文件。 如果只配置 logging.path在 /var/log文件夹生成一个日志文件为 spring.log 注二者不能同时使用如若同时使用则只有logging.file生效 默认情况下日志文件的大小达到10MB时会切分一次产生新的日志文件默认级别为ERROR、WARN、INFO
级别控制
所有支持的日志记录系统都可以在Spring环境中设置记录级别例如在application.properties中 格式为’logging.level.* LEVEL’
logging.level日志级别控制前缀*为包名或Logger名LEVEL选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
举例
logging.level.com.duduDEBUGcom.dudu包下所有class以DEBUG级别输出logging.level.rootWARNroot日志以WARN级别输出
自定义日志配置
由于日志服务一般都在ApplicationContext创建前就初始化了它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。
根据不同的日志系统你可以按如下规则组织配置文件名就能被正确加载
Logbacklogback-spring.xml, logback-spring.groovy, logback.xml, logback.groovyLog4jlog4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xmlLog4j2log4j2-spring.xml, log4j2.xmlJDK (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.properties配置文件里面通过logging.config属性指定自定义的名字
logging.configclasspath:logging-config.xml虽然一般并不需要改变配置文件的名字但是如果你想针对不同运行时Profile使用不同的日 志配置这个功能会很有用。
下面我们来看看一个普通的logback-spring.xml例子
?xml version1.0 encodingUTF-8?
configuration scantrue scanPeriod60 seconds debugfalsecontextNamelogback/contextNameproperty namelog.path value/Users/tengjun/Documents/log /!--输出到控制台--appender nameconsole classch.qos.logback.core.ConsoleAppender!-- filter classch.qos.logback.classic.filter.ThresholdFilterlevelERROR/level/filter--encoderpattern%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n/pattern/encoder/appender!--输出到文件--appender namefile classch.qos.logback.core.rolling.RollingFileAppenderrollingPolicy classch.qos.logback.core.rolling.TimeBasedRollingPolicyfileNamePattern${log.path}/logback.%d{yyyy-MM-dd}.log/fileNamePattern/rollingPolicyencoderpattern%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n/pattern/encoder/appenderroot levelinfoappender-ref refconsole /appender-ref reffile //root!-- logback为java中的包 --logger namecom.dudu.controller/!--logback.LogbackDemo类的全路径 --logger namecom.dudu.controller.LearnController levelWARN additivityfalseappender-ref refconsole//logger
/configuration根节点包含的属性
scan:当此属性设置为true时配置文件如果发生改变将会被重新加载默认值为true。scanPeriod:设置监测配置文件是否有修改的时间间隔如果没有给出时间单位默认单位是毫秒。当scan为true时此属性生效。默认的时间间隔为1分钟。debug:当此属性设置为true时将打印出logback内部日志信息实时查看logback运行状态。默认值为false。
根节点的子节点下面一共有2个属性3个子节点分别是
属性一设置上下文名称
每个logger都关联到logger上下文默认上下文名称为“default”。但可以使用设置成其他名字用于区分不同应用程序的记录。一旦设置不能修改,可以通过%contextName来打印日志上下文名称。
contextNamelogback/contextName属性二设置变量
用来定义变量值的标签 有两个属性name和value其中name的值是变量的名称value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后可以使“${}”来使用变量。
property namelog.path value/Users/tengjun/Documents/log /子节点一
appender用来格式化日志输出节点有俩个属性name和classclass用来指定哪种输出策略常用就是控制台输出策略和文件输出策略。
控制台输出ConsoleAppender
!--输出到控制台--
appender nameconsole classch.qos.logback.core.ConsoleAppenderfilter classch.qos.logback.classic.filter.ThresholdFilterlevelERROR/level/filterencoderpattern%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n/pattern/encoder
/appender表示对日志进行编码
%d{HH: mm:ss.SSS}——日志输出时间%thread——输出日志的进程名字这在Web应用以及异步任务处理中很有用%-5level——日志级别并且使用5个字符靠左对齐%logger{36}——日志输出者的名字%msg——日志消息%n——平台的换行符
ThresholdFilter为系统定义的拦截器例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉不然你控制台会发现没日志~
输出到文件RollingFileAppender
另一种常见的日志输出到文件随着应用的运行时间越来越长日志也会增长的越来越多将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志
!--输出到文件--
appender namefile classch.qos.logback.core.rolling.RollingFileAppenderrollingPolicy classch.qos.logback.core.rolling.TimeBasedRollingPolicyfileNamePattern${log.path}/logback.%d{yyyy-MM-dd}.log/fileNamePatternmaxHistory30/maxHistorytotalSizeCap1GB/totalSizeCap/rollingPolicyencoderpattern%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n/pattern/encoder
/appender其中重要的是rollingPolicy的定义上例中${log.path}/logback.%d{yyyy-MM-dd}.log定义了日志的切分方式——把每一天的日志归档到一个文件中30表示只保留最近30天的日志以防止日志填满整个磁盘空间。同理可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。1GB用来指定日志文件的上限大小例如设置为1GB的话那么到了这个值就会删除旧的日志。
补:如果你想把日志直接放到当前项目下把${log.path}/去掉即可。
logback 每天生成和大小生成冲突的问题可以看这个解答传送门
子节点二
root节点是必选节点用来指定最基础的日志输出级别只有一个level属性。 level:用来设置打印级别大小写无关TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF不能设置为INHERITED或者同义词NULL。 默认是DEBUG。 可以包含零个或多个元素标识这个appender将会添加到这个logger。 root leveldebugappender-ref refconsole /appender-ref reffile /
/root子节点三
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性一个可选的level和一个可选的addtivity属性。
name:用来指定受此logger约束的某一个包或者具体的某一个类。level:用来设置打印级别大小写无关TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF还有一个特俗值INHERITED或者同义词NULL代表强制执行上级的级别。如果未设置此属性那么当前logger将会继承上级的级别。addtivity:是否向上级logger传递打印信息。默认是true。
logger在实际使用的时候有两种情况 先来看一看代码中如何使用
package com.chenwei.cwblog.controller;RestController
public class testLogbackController1 {private Logger logger LoggerFactory.getLogger(this.getClass());RequestMapping(value /testLogbackController1,method RequestMethod.GET)public void login(HttpServletRequest request, HttpServletResponse response){//日志级别从低到高分为TRACE DEBUG INFO WARN ERROR FATAL如果设置为WARN则低于WARN的信息都不会输出。logger.trace(日志输出 trace);logger.debug(日志输出 debug);logger.info(日志输出 info);logger.warn(日志输出 warn);logger.error(日志输出 error);}
}这是一个登录的判断的方法我们引入日志并且打印不同级别的日志然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。
第一种带有logger的配置不指定级别不指定appender
logger namecom.chenwei.cwblog.controller/将控制controller包下的所有类的日志的打印但是并没用设置打印级别所以继承他的上级的日志级别“info” 没有设置addtivity默认为true将此logger的打印信息向上级传递 没有设置appender此logger本身不打印任何信息。 将root的打印级别设置为“info”指定了名字为“console”的appender。
当执行com.chenwei.cwblog.controlletestLogbackController1 在包com.chenwei.cwblog.controlle中所以首先执行将级别为“info”及大于“info”的日志信息传递给root本身并不打印 root接到下级传递的信息交给已经配置好的名为“console”的appender处理“console”appender将信息打印到控制台
**打印结果如下**在log文件中
16:40:51.466 logback [http-nio-8080-exec-1] INFO c.c.c.c.testLogbackController1 - 日志输出 info
16:40:51.466 logback [http-nio-8080-exec-1] WARN c.c.c.c.testLogbackController1 - 日志输出 warn
16:40:51.466 logback [http-nio-8080-exec-1] ERROR c.c.c.c.testLogbackController1 - 日志输出 error第二种带有多个logger的配置指定级别指定appender
logger namecom.chenwei.cwblog.controller.testLogbackController1 levelWARN additivityfalseappender-ref refconsole/
/logger将级别为“WARN”及大于“WARN”的日志信息交给此logger指定的名为“console”的appender处理在控制台中打出日志不再向上级root传递打印信息。 **打印结果如下**控制台
16:59:51.559 logback [http-nio-8080-exec-1] WARN c.c.c.c.testLogbackController1 - 日志输出 warn
16:59:51.559 logback [http-nio-8080-exec-1] ERROR c.c.c.c.testLogbackController1 - 日志输出 error当然如果你把additivity”false”改成additivity”true”的话就会打印两次因为打印信息向上级传递logger本身打印一次root接到后又打印一次。
注使用mybatis的时候sql语句是debug下才会打印而这里我们只配置了info所以想要查看sql语句的话有以下两种操作 第一种把改成这样就会打印sql不过这样日志那边会出现很多其他消息。 第二种就是单独给dao下目录配置debug模式代码如下这样配置sql语句会打印其他还是正常info级别 logger namecom.dudu.dao levelDEBUG additivityfalseappender-ref refconsole /
/logger多环境日志输出
据不同环境prod:生产环境test:测试环境dev:开发环境来定义不同的日志输出在 logback-spring.xml中使用 springProfile 节点来定义方法如下 文件名称不是logback.xml想使用spring扩展profile支持要以logback-spring.xml命名 !-- 测试环境开发环境. 多个使用逗号隔开. --
springProfile nametest,devlogger namecom.dudu.controller levelinfo /
/springProfile
!-- 生产环境. --
springProfile nameprodlogger namecom.dudu.controller levelERROR /
/springProfile可以启动服务的时候指定 profile 如不指定使用默认如指定prod 的方式为 java -jar xxx.jar –spring.profiles.activeprod 关于多环境配置可以参考
总结
到此为止终于介绍完日志框架了平时使用的时候推荐用自定义logback-spring.xml来配置代码中使用日志也很简单类里面添加private Logger logger LoggerFactory.getLogger(this.getClass());即可。
