开发者学堂课程【SpringBoot 实战教程:自定义日志配置文件】学习笔记,与课程紧密联系,让用户快速学习知识。
课程地址:https://developer.aliyun.com/learning/course/651/detail/10782
自定义日志配置文件
1、因为 springboot 默认使用的是 logback 日志框架,所以 springboot 已经自动配置相关的配置,如果要修改相关配置可以在全局配置文件中写入自己所用的配置即可。除此以外,还可以自定义配置文件,可以使用外部的配置文件对日志进行管理。
2、通过系统属性和传统的 SpringBoot 外部配置文件依然可以很好的支持日志控制和管理。根据不同的日志系统,可以按如下规则组织配置文件名,就能被正确加载:
Logback: logback-spring. xm
l
,logback-spring. groovy,
logback. x
l
,
l
ogback. groovy
Log4j:
l
og4j-spring.properties,
l
og4j-spring.xml,
l
og4j. properties,
l
og4j. x
ml
Log4j2:
l
og4j2- spring.
xm
,
l
og4j2.
xml
JDK (Java Util Logging):
l
ogging. Properties
Spring Boot 官方推荐优先使用带有-spring 的文件名作为你的日志配置(如使用 logback-spring. xml,而不是 logback. xml),命名为 logback-spring. xml 的日志配置文件,spring boot 可以为它添加一些 spring boot 特有的配置项。
如果你即想完全掌控日志配置,但又不想用 logback. xml 作为 Logback 配置的名字,可以通过 logging. config 属性指定自定义的名字:
l
ogging. config=classpath: logging-config. xm
l
可以区分不同的环境,生产环境下可以用某一个日志文件,开发环境下用某一个日志文件,虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时Profile使用不同的日志配置,这个功能会很有用。
<?Xm
l
versior
=
"
l
.
0
" encoding= "UTF-8 "?>
<configuration
scan=" true
”
scanPeriod=
”
60 secands
“
debug=”false“
>
<çontextName>
l
ogback /çontextName
>
<property name= '
l
og. path" va
l
ue= "
E
:
\\
springboot
\\
info.
l
og"
/
>
<!--输出到控制台-->
<appender name= console" class=' "ch. gos.
l
ogback. core. Conso
l
eAppender"
<!-- <fi
l
ter class=
”
ch. gos.
l
ogback. classic. filter. ThresholdFilter" >
<
l
eve
l
>ERR0R</
l
eve
l
>
</fiIter>-->
<encoder>
<pattern> %d (HH: nm:ss. SSS] %contextName [%thread]
%
-5
l
eve
1
%
l
ogger (36]
-%msg%n
<
. /pattern>
</encoder>
</appender>
<!--输出到文件-->
<
a
ppender, name=“f
il
e" class=' "ch gos. Iogback. core. ro
ll
ing. Ro
ll
ingFi
l
eAppendler“
>
<
fi
l
e>$
{l
og. Path
}
</fi
l
e>
<
ro
ll
ingPolicy c
l
ass=
”
ch.gos.
l
ogback.core.ro
ll
ing. TimeBasedRoI IingPoIicy"
>
<fi
l
eNamePattern>
l
ogback. %d
{
yyyy -MM-dd
}
.
l
og</fileNamePattern>
</ro
ll
ingPolicy>
<encoder>
<
root level=
”
info
”
>
<
appender ref ref=' conso1e" />
<
appender-ref ref= "fi1e
”/
>
< /root>
<!--
l
ogback
为
java
中的包
-->
<l
ogger name=
“
com. gianfeng: controller
“/
>
<!--additivity是否向上级loger传递打印信息-->
<l
ogger name=
“
com.
q
ianfeng. control
l
er. SpringController"
l
evel=
”W
ARN
”
additivity= "false
”
>
<appender-ref ref=
“
console' "
/
>
</1ogger>
</configuration>
3、把之前的删掉,重新创建配置文件,命名为 logback.spring.xml。
4、分标签叫 configuration,scan 设置为 true 时,当发现配置文件发生变化时它会进行重新加载,所以设置为 true,scanperiod 是每间隔多久就扫描一次,当前配置文件是否发生改变,默认是一分钟,单位是秒。
5、根节点<configuration>
包含的属性:
(1)scan:当此属性设置为true时, 配置文件如果发生改变,将会被重新加载,默认值为true。
(2)scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当 scan 为 true 时,此属性生效。默认的时间间隔为1分钟。
(3)debug:当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态。默认值为 false。
(4)<contextname>:每个 logger 都关联到 logger 上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName
来打印日志上下文名称。
(5)<property>:用来定义变量值的标签,有两个属性,name 和 value,其中name 的值是变量的名称,value 的值是变量定义的值。通过定义的值会被插入到logger 上下文中。定义变量后,可以使“${}”来使用变量。名字自己任意起,从值上可以看出要把日志写入文件的日志路径名称。
(6)<appender>:用来格式化日志输出节点,有两个属性 name 和 class,class 用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。日志输出策略,指的是要把日志输出到控制台,对应的时间类叫 consoleappender,encoder 指定格式,日志时间,上下文名称,当前线程名称,日志级别,日志的名字以及日志信息,%是换行符。
(7)ThresholdFilter 为系统定义的拦截器,例如我们用 ThresholdFilter 来过滤掉 error 级别以下的日志不输出到文件中,如果不用记得注释掉。
(8)输出到文件,名字是 file,实现实现类叫 rollingfileappender,把日志写入文件,用$引用 log.path,log.path是前面定义的一个变量,对应的值是日志文件的路径和名称,这个文件就写入到这个文件 springboot\\info.log 下的日志文件中,指定把日志写入哪个位置,也可以指定写入到文件中日志的格式,跟控制台一样,日志时间,上下文名称,当前线程名称,日志级别,日志的名字以及日志信息。
(9)rollingpolicy 指切割策略,日志文件的切割策略,一个日志文件让它不要太大,
(10)<fileNamePattern
>
logback. %d
{
ywy-MM-dd
}
.
l
og</fileNamePattern>:
定义了日志的切分方式,把每一天的日志归档到一个文件中,第二天再生成新的日志文件,
(11)<maxHistory>30</maxHistory>
:表示只保留最近30天的日志,以防止日志填满整个磁盘空间。这是精确到天,同理,可以使用%d
{y
yyy-MM-dd_ HH-mm
}
来定义精确到分的日志切分方式。
(12)<totalSizeCap> 1GB</totalSizeCap>
用来指定日志文件的上限大小,例如设置为1GB,那么到这个值,就会删除旧的日志。在文件中输出的策略中有文件切割策略。
(13)<root>
节点是必选节点,用来指定最基础的日志输出级别,只有一个 level 属性。输出日志的最低级别,是 info 级别。以及日志向哪输出,一个是控制台,一个是file。
(14)<loger>
用来配置具体的包或者包中具体的类,设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>
。<loger>
仅有一个 name 属性,一个可选的 leve1 和一个可选的 addtivity 属性。比如有一个类叫 springcontroller,希望和它相关的日志打印是 error 级别,但是这里配置的是 info 级别,那么这时就需要单独配置,
(15)name:用来指定受此 loger 约束的某一个包或者具体的某一个类 。 Com.qianfeng.controller 指定的是包名,下面具体到类,要把这个类的权限域名写上,包名加类名都要写上,设置这个类相关的日志文件信息的级别,不使用 info,使用的是 warn,属性
(16)level:用来设置打印级别,大小写无关: TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特殊值 INHERITED 或者同义词 NULL,代表强制执行上级的级别。如果未设置此属性,那么当前 loger 将会继承上级的级别。
(17)addtivities:是否向上级 logger 传递打印信息。默认是 false。
(18)和这个类相关的日志信息,是输出到控制台还是输出到文件,还是控制台和文件都输出。
<
Logger
name= "com.
Qianfeng
. controller. Sprin
g
cont
roller
这个只向控制台打印信息。文件中没有。这是自己写日志配置文件的相关的内容。
6、运行启动工程,打开控制台可以看到很多都是info级别的,找到 springboot-info.log 日志文件,打开可以看到在控制台的日志信息同样也写入到日志文件,这就是如何自定义配置文件。