之前在 日志?聊一聊slf4j吧 这篇文章中聊了下slf4j
。本文也从实际的例子出发,针对logback
的日志配置进行学习。
logack 简介
logback 官网: https:// logback.qos.ch/
目前还没有看过日志类框架的源码,仅限于如何使用。所以就不说那些“空话”了。最直观的认知是:
logback
和log4j
是一个人写的springboot
默认使用的日志框架是logback
。- 三个模块组成
- logback-core
- logback-classic
- logback-access
其他的关于性能,关于内存占用,关于测试,关于文档详见源码及官网说明
logback-core
是其它模块的基础设施,其它模块基于它构建,显然,logback-core
提供了一些关键的通用机制。logback-classic
的地位和作用等同于 Log4J
,它也被认为是 Log4J
的一个改进版,并且它实现了简单日志门面 SLF4J
;而 logback-access
主要作为一个与 Servlet
容器交互的模块,比如说tomcat
或者 jetty
,提供一些与 HTTP
访问相关的功能。
配置文件详解
这部分主要来学习下logback配置文件的一些配置项。
configuration
先来看这张图,这个结构就是整个logback.xml配置文件的结构。
对应来看下配置文件:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="glmapper-name" value="glmapper-demo" />
<contextName>${glmapper-name}</contextName>
<appender>
//xxxx
</appender>
<logger>
//xxxx
</logger>
<root>
//xxxx
</root>
</configuration>
ps:想使用spring扩展profile支持,要以logback-spring.xml命名,其他如property需要改为springProperty
- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
contextName
每个logger
都关联到logger
上下文,默认上下文名称为“default”
。但可以使用contextName
标签设置成其他名字,用于区分不同应用程序的记录
property
用来定义变量值的标签,property
标签有两个属性,name
和value
;其中name
的值是变量的名称,value
的值时变量定义的值。通过property
定义的值会被插入到logger
上下文中。定义变量后,可以使“${name}”来使用变量。如上面的xml
所示。
logger
用来设置某一个包或者具体的某一个类的日志打印级别以及指定appender
。
root
根logger,也是一种logger,且只有一个level属性
appender
负责写日志的组件,下面会细说
filter
filter其实是appender里面的子元素。它作为过滤器存在,执行一个过滤器会有返回DENY,NEUTRAL,ACCEPT三个枚举值中的一个。
- DENY:日志将立即被抛弃不再经过其他过滤器
- NEUTRAL:有序列表里的下个过滤器过接着处理日志
- ACCEPT:日志会被立即处理,不再经过剩余过滤器
案例分析
首先来配置一个非常简单的文件。这里申请下,我使用的是 logback-spring.xml
。和 logback.xml
在properties
上有略微差别。其他都一样。
工程:springboot+web
先来看下项目目录
properties中就是指定了日志的打印级别和日志的输出位置:
#设置应用的日志级别
logging.level.com.glmapper.spring.boot=INFO
#路径
logging.path=./logs
通过控制台输出的log
logback-spring.xml的配置如下:
<configuration>
<!-- 默认的控制台日志输出,一般生产环境都是后台启动,这个没太大作用 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>%d{HH:mm:ss.SSS} %-5level %logger{80} - %msg%n</Pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
打印日志的controller
private static final Logger LOGGER =
LoggerFactory.getLogger(HelloController.class);
@Autowired
private TestLogService testLogService;
@GetMapping("/hello")
public String hello(){
LOGGER.info("GLMAPPER-SERVICE:info");
LOGGER.error("GLMAPPER-SERVICE:error");
testLogService.printLogToSpecialPackage();
return "hello spring boot";
}
验证结果:
01:50:39.633 INFO com.glmapper.spring.boot.controller.HelloController
- GLMAPPER-SERVICE:info
01:50:39.633 ERROR com.glmapper.spring.boot.controller.HelloController
- GLMAPPER-SERVICE:error
上面的就是通过控制台打印出来的,这个时候因为我们没有指定日志文件的输出,因为不会在工程目录下生产logs
文件夹。
控制台不打印,直接输出到日志文件
先来看下配置文件:
<configuration>
<!-- 属性文件:在properties文件中找到对应的配置项 -->
<springProperty scope="context" name="logging.path" source="logging.path"/>
<springProperty scope="context" name="logging.level" source="logging.level.com.glmapper.spring.boot"/>
<!-- 默认的控制台日志输出,一般生产环境都是后台启动,这个没太大作用 -->
<appender name="STDOUT"
class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">