基于logback实现springboot超级详细的⽇志配置
前⾔
java web 下有好⼏种⽇志框架,⽐如:logback,log4j,log4j2(slj4f 并不是⼀种⽇志框架,它相当于定义了规范,实现了这个规范的⽇志框架就能够⽤ slj4f 调⽤)。其中性能最⾼的应该使 logback 了,⽽且 springboot 默认使⽤的也是 logback ⽇志,所以本篇将会详细的讲解 logback 的⽇志配置⽅案。
本篇主要内容如下:
•logback 配置⽂件的构成
•如何将⽇志输出到⽂件
•如何按时间,按⼤⼩切分⽇志
•如何将让⼀个⽇志⽂件中只有⼀种⽇志级别
•如何将指定包下的⽇志输出到指定的⽇志⽂件中
简单使⽤
如果⽆需复杂的⽇志配置,执⾏简单设置⽇志打印级别,打印⽅式可直接再l 中配置。
默认情况下 Spring Boot 将 info 级别的⽇志输出到控制台中,不会写到⽇志⽂件,且不能进⾏复杂配置。
打印到⽂件中
想要将⽇志输出到⽂件中,可通过如下两个配置:
logging:
# 配置输出额⽇志⽂件名,可以带路径
# file: out.log
# 配置⽇志存放路径,⽇志⽂件名为:spring.log
path: ./log
file:
# 设置⽇志⽂件⼤⼩
max-size: 10MB
注意:file 和 path 是不能同时配置的,如果同时配置path不会⽣效。
打印级别控制
可通过配置控制⽇志打印级别,格式如下:
logging.level.*=TRACE/DEBUG/INFO/...
*可以为包名或 Logger 名,如下:
logging:
level:
# root⽇志以WARN级别输出
root: info
# 此包下所有class以DEBUG级别输出
logback 详细配置
接下来说明如何通过独⽴的 xml 配置⽂件来配置⽇志打印。虽然 springboot 是要消灭 xml 的,但是有些复杂功能还是得编写xml。使⽤ xml 后要将l 中的配置去掉,避免冲突.
根据不同的⽇志系统,按照指定的规则组织配置⽂件名,并放在 resources ⽬录下,就能⾃动被 spring boot 加载:•Logback:l, vy, l, vy
•Log4j: log4j-spring.properties, l, log4j.properties, l
•Log4j2: l, l
•JDK (Java Util Logging): logging.properties
想要⾃定义⽂件名的可配置:fig指定配置⽂件名:
Spring Boot 官⽅推荐优先使⽤带有 -spring 的⽂件名作为你的⽇志配置(如使⽤ l ,
⽽不是l),命名为 l 的⽇志配置⽂件, spring boot 可以为它添加⼀些 spring boot 特有的配置项(下⾯会提到)。
logback 配置⽂件的组成
根节点<configuration>有 5 个⼦节点,下⾯来进⾏⼀⼀介绍。
<root>节点
root 节点是必选节点,⽤来指定最基础的⽇志输出级别,只有⼀个 level 属性,⽤于设置打印级别,可选如下:TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF。
root 节点可以包含 0 个或多个元素,将appender添加进来。如下:
<root level="debug">
<appender-ref ref="console" />
<appender-ref ref="file" />
</root>
appender 也是⼦节点之⼀,将会在后⾯说明。
<contextName>节点
设置上下⽂名称,默认为default,可通过%contextName来打印上下⽂名称,⼀般不使⽤此属性。
<property>节点
⽤于定义变量,⽅便使⽤。有两个属性:name,value。定义变量后,可以使⽤${}来使⽤变量。如下:
<property name="path" value="./log"/>
<property name="appname" value="app"/>
<appender>节点
appender ⽤来格式化⽇志输出的节点,这个最重要。有两个属性:
•name:该本 appender 命名
•class:指定输出策略,通常有两种:控制台输出,⽂件输出
log4j2 appender下⾯通过例⼦来说明这个怎么⽤:
1.输出到控制台/按时间输出⽇志
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--设置存储路径变量-->
<property name="LOG_HOME" value="./log"/>
<!--控制台输出appender-->
<appender name="console" class="ch.ConsoleAppender">
<!--设置输出格式-->
<encoder class="ch.qos.der.PatternLayoutEncoder">
<!--格式化输出:%d表⽰⽇期,%thread表⽰线程名,%-5level:级别从左显⽰5个字符宽度%msg:⽇志消息,%n是换⾏符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!--设置编码-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--⽂件输出,时间窗⼝滚动-->
<appender name="timeFileOutput" class="ch.olling.RollingFileAppender">
<!--⽇志名,指定最新的⽂件名,其他⽂件名使⽤FileNamePattern -->
<File>${LOG_HOME}/timeFile/out.log</File>
<!--⽂件滚动模式-->
<rollingPolicy class="ch.olling.TimeBasedRollingPolicy">
<!--⽇志⽂件输出的⽂件名,可设置⽂件类型为gz,开启⽂件压缩-->
<FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%</FileNamePattern>
<!--⽇志⽂件保留天数-->
<MaxHistory>30</MaxHistory>
<!--按⼤⼩分割同⼀天的-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.olling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!--输出格式-->
<encoder class="ch.qos.der.PatternLayoutEncoder">
<!--格式化输出:%d表⽰⽇期,%thread表⽰线程名,%-5level:级别从左显⽰5个字符宽度%msg:⽇志消息,%n是换⾏符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!--设置编码-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--指定基础的⽇志输出级别-->
<root level="INFO">
<!--appender将会添加到这个loger-->
<appender-ref ref="console"/>
<appender-ref ref="timeFileOutput"/>
</root>
</configuration>
1.设置只输出单个级别
在 appender 中设置,filter ⼦节点,在默认级别上再此过滤,配置 onMatch,onMismatch 可实现只输出单个级别<appender ...>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<!--接受匹配-->
<onMatch>ACCEPT</onMatch>
<!--拒绝不匹配的-->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<logger>节点
构成
此节点⽤来设置⼀个包或具体的某⼀个类的⽇志打印级别、以及指定<appender>,有以下三个属性:•name: 必须。⽤来指定受此 loger 约束的某个包或者某个具体的类
•level:可选。设置打印级别。默认为 root 的级别。
•addtivity: 可选。是否向上级 loger(也就是 root 节点)传递打印信息。默认为 true。
使⽤⽰例如下:
1.不指定级别,不指定 appender
<!-- 控制ample.service下类的打印,使⽤root的level和appender -->
<logger name="ample.service"/>
2.指定级别,不指定 appender
<!-- 控制ample.service下类的打印,使⽤root的appender打印warn级别⽇志 -->
<logger name="ample.service" level="WARN"/>
3.指定级别,指定 appender
<!-- 控制ample.service下类的打印,使⽤console打印warn级别⽇志 -->
<!-- 设置addtivity是因为这⾥已经指定了appender,如果再向上传递就会被root下的appender再次打印 -->
<logger name="ample.service" level="WARN" addtivity="false">
<appender-ref ref="console">
</logger>
通过指定 appender 就能将指定的包下的⽇志打印到指定的⽂件中。
多环境⽇志输出
通过设置⽂件名为-spring 结尾,可分环境配置 logger,⽰例如下:
<configuration>
<!-- 测试环境+开发环境. 多个使⽤逗号隔开. -->
<springProfile name="test,dev">
<logger name="ller" level="DEBUG" additivity="false">
<appender-ref ref="console"/>
</logger>
</springProfile>
<!-- ⽣产环境. -->
<springProfile name="prod">
<logger name="ample.demo" level="INFO" additivity="false">
<appender-ref ref="timeFileOutput"/>
</logger>
</springProfile>
</configuration>
通过配置spring.profiles.active也能做到切换上⾯的 logger 打印设置
结束
⽇志打印可以很复杂,这⾥只是说明了常⽤的 logback 配置,代码详见:
总结
以上所述是⼩编给⼤家介绍的基于logback 实现springboot超级详细的⽇志配置,希望对⼤家有所帮助,如果⼤家有任何疑问请给我留⾔,⼩编会及时回复⼤家的。在此也⾮常感谢⼤家对⽹站的⽀持!
如果你觉得本⽂对你有帮助,欢迎转载,烦请注明出处,谢谢!
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论