本次来更新下springboot底层的日志框架方面的吧
日志分为日志门面(日志抽象层)与日志实现
日志门面 (日志的抽象层) | 日志实现 |
---|---|
Log4j JUL(java.util.logging) Log4j2 Logback |
左边选一个门面(抽象层)、右边来选一个实现;
这几个日志框架的关系有兴趣可以去详细了解,jcl是apache Jakarta小组开发的,上次更新在很多年以前了,jboss用的场景太少,所以都不考虑。SLF4j log4j logback 都是出自同一人之手,而log4j2是apache借着log4j之名做的升级版,设计的很好,但是目前框架的适配性不够,log4j有性能问题。jul在当时log4j出现后,紧接着出现了,我感觉是抢市场的。为了考虑适配性与兼容行,一般选择slf4j+logback。
说回spring,spring默认使用的是jcl,而springboot基于spring之上做了包装适配,默认使用的也是slf4j+logback。
- 关于slf4j
先把官方文档放这,有需要的可以查阅。
我们先来看张图,也是文档上的。图上表述的是slf4j框架与各种日志实现框架是怎么绑定的。绿色表示应用访问,浅蓝色表示日志门面,深蓝表示日志实现,湖蓝表示日志转换,也就是适配器模式,适配器的jar对上实现了slf4j的方法,对下实际上实现的是其它的api,可以说偷梁换柱吧。通过这张图我们可以知道,用什么实现就导哪个jar。
总结上来说就是每一个日志的实现框架都有自己的配置文件。使用slf4j以后,配置文件还是要写日志实现框架自己本身的配置文件,如要用logback实现,就写logback的配置文件,要用log4j实现,就写log4j的配置文件。
现假设一个问题,如果开发一个系统,开发用的slf4j+logback,但是需要依赖 Spring(5以下commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx这些框架,但是每一个框架底层用的日志都不一样,怎么统一日志,怎么把其它的日志实现都改成slf4j进行输出,且只写一个logback配置?再看下图
当应用程序调用其它不使用slf4j的框架的时候,使用图上的jar替换掉原框架的jar就好了,图上英文也有说明。例如jul-to-slf4j.jar替换掉commons-logging.jar,为了避免报错,commons-logging.jar里有那些包与类,相应的jul-to-slf4j.jar也会有这些包与类,jul-to-slf4j.jar会在实现方法里调用slf4j相关api,所以达成了目的。这里也是用到了适配器模式。 - SpringBoot日志关系
分析一个springboot的mavn依赖,可以得到下图
各种启动器都会依赖到spring-boot-starter,而这个starter依赖了spring-boot-starter-logging,这个logging会将jul,log4j都转换为slf4j,且将logback作为实现。
所以如果我们依赖了其它框架,要把框架默认的日志包移除掉,以避免jar冲突报错。 - springboot 日志使用
SpringBoot默认帮我们配置好了日志,我们要自定义其实就是各种配置文件和配置项了,看看就好
//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//System.out.println();
//日志的级别;
//由低到高 trace<debug<info<warn<error
//可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效
logger.trace("这是trace日志...");
logger.debug("这是debug日志...");
//SpringBoot默认给我们使用的是info级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别
logger.info("这是info日志...");
logger.warn("这是warn日志...");
logger.error("这是error日志...");
# 在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了
Logging System | Customization |
---|---|
Logback | logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) | logging.properties |
logback.xml:直接就被日志框架识别了;
logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!-- 日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符 -->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>
如果使用logback.xml作为日志配置文件,还要使用profile功能,会有这个错误 no applicable action for [springProfile]
- 切换日志框架
可以按照slf4j的日志适配图,进行相关的切换;原理就是去除掉适配器那一层,把适配器的jar去除掉换成真正的其它实现的jar。
日志就说到这里吧,虽然说日志会用就行,但我认为很多道理是融会贯通的,多了解一点总是没有坏处