背景
java web 下有好几种日志框架,比方:logback,log4j,log4j2(slj4f 并不是一种日志框架,它相当于定义了标准,实现了这个标准的日志框架就可能用 slj4f 调用)。其中性能最高的应该使 logback 了,而且 springboot 默认应用的也是 logback 日志,所以本篇将会具体的解说 logback 的日志配置计划。
本篇次要内容如下:
- logback 配置文件的形成
- 如何将日志输入到文件
- 如何按工夫,按大小切分日志
- 如何将让一个日志文件中只有一种日志级别
- 如何将指定包下的日志输入到指定的日志文件中
简略应用
如果无需简单的日志配置,执行简略设置日志打印级别,打印形式可间接再 application.yml 中配置。
默认状况下 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级别输入com.example.log_demo.log1: warn
logback 具体配置
接下来阐明如何通过独立的 xml 配置文件来配置日志打印。尽管 springboot 是要毁灭 xml 的,然而有些简单性能还是得编写 xml。应用 xml 后要将 application.yml 中的配置去掉,防止抵触.
依据不同的日志零碎,依照指定的规定组织配置文件名,并放在 resources 目录下,就能主动被 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
想要自定义文件名的可配置:logging.config
指定配置文件名:
logging.config=classpath:logging-config.xml
Spring Boot 官网举荐优先应用带有 -spring 的文件名作为你的日志配置(如应用 logback-spring.xml ,而不是 logback.xml ),命名为 logback-spring.xml 的日志配置文件, 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:指定输入策略,通常有两种:控制台输入,文件输入
上面通过例子来阐明这个怎么用:
- 输入到控制台/按工夫输入日志
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--设置存储门路变量--><property name="LOG_HOME" value="./log"/><!--控制台输入appender--><appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--设置输入格局--> <encoder class="ch.qos.logback.classic.encoder.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.qos.logback.core.rolling.RollingFileAppender"> <!--日志名,指定最新的文件名,其余文件名应用FileNamePattern --> <File>${LOG_HOME}/timeFile/out.log</File> <!--文件滚动模式--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!--日志文件输入的文件名,可设置文件类型为gz,开启文件压缩--> <FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern> <!--日志文件保留天数--> <MaxHistory>30</MaxHistory> <!--按大小宰割同一天的--> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!--输入格局--> <encoder class="ch.qos.logback.classic.encoder.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>
- 设置只输入单个级别
在 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。
应用示例如下:
- 不指定级别,不指定 appender
<!-- 管制com.example.service下类的打印,应用root的level和appender -->
<logger name="com.example.service"/>
2.指定级别,不指定 appender
<!-- 管制com.example.service下类的打印,应用root的appender打印warn级别日志 -->
<logger name="com.example.service" level="WARN"/>
3.指定级别,指定 appender
<!-- 管制com.example.service下类的打印,应用console打印warn级别日志 -->
<!-- 设置addtivity是因为这里曾经指定了appender,如果再向上传递就会被root下的appender再次打印 -->
<logger name="com.example.service" level="WARN" addtivity="false">
<appender-ref ref="console">
</logger>
通过指定 appender 就能将指定的包下的日志打印到指定的文件中。
多环境日志输入
通过设置文件名为-spring 结尾,可分环境配置 logger,示例如下:
<configuration>
<!-- 测试环境+开发环境. 多个应用逗号隔开. --><springProfile name="test,dev"> <logger name="com.example.demo.controller" level="DEBUG" additivity="false"> <appender-ref ref="console"/> </logger></springProfile><!-- 生产环境. --><springProfile name="prod"> <logger name="com.example.demo" level="INFO" additivity="false"> <appender-ref ref="timeFileOutput"/> </logger></springProfile>
</configuration>
通过配置spring.profiles.active
也能做到切换下面的 logger 打印设置