必知的技术知识:Java日志框架:logback详解

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 必知的技术知识:Java日志框架:logback详解

为什么使用logback


记得前几年工作的时候,公司使用的日志框架还是log4j,大约从16年中到现在,不管是我参与的别人已经搭建好的项目还是我自己主导的项目,日志框架基本都换成了logback,总结一下,logback大约有以下的一些优点:


内核重写、测试充分、初始化内存加载更小,这一切让logback性能和log4j相比有诸多倍的提升


logback非常自然地直接实现了slf4j,这个严格来说算不上优点,只是这样,再理解slf4j的前提下会很容易理解logback,也同时很容易用其他日志框架替换logback


logback有比较齐全的200多页的文档


logback当配置文件修改了,支持自动重新加载配置文件,扫描过程快且安全,它并不需要另外创建一个扫描线程


支持自动去除旧的日志文件,可以控制已经产生日志文件的最大数量


总而言之,如果大家的项目里面需要选择一个日志框架,那么我个人非常建议使用logback。


logback加载


我们简单分析一下logback加载过程,当我们使用logback-classic.jar时,应用启动,那么logback会按照如下顺序进行扫描:


在系统配置文件System Properties中寻找是否有logback.configurationFile对应的value


在classpath下寻找是否有logback.groovy(即logback支持groovy与xml两种配置方式)


在classpath下寻找是否有logback-test.xml


在classpath下寻找是否有logback.xml


以上任何一项找到了,就不进行后续扫描,按照对应的配置进行logback的初始化,具体代码实现可见ch.qos.logback.classic.util.ContextInitializer类的findURLOfDefaultConfigurationFile方法。


当所有以上四项都找不到的情况下,logback会调用ch.qos.logback.classic.BasicConfigurator的configure方法,构造一个ConsoleAppender用于向控制台输出日志,默认日志输出格式为"%d{HH:mm:ss.SSS} 【%thread】 %-5level %logger{36} - %msg%n"。


logback的configuration


logback的重点应当是Appender、Logger、Pattern,在这之前先简单了解一下logback的,只有三个属性:


scan:当scan被设置为true时,当配置文件发生改变,将会被重新加载,默认为true


scanPeriod:检测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认为毫秒,当scan=true时这个值生效,默认时间间隔为1分钟


debug:当被设置为true时,将打印出logback内部日志信息,实时查看logback运行信息,默认为false



先从最基本的与开始。


用来设置某一个包或者具体某一个类的日志打印级别、以及指定。可以包含零个或者多个元素,标识这个appender将会添加到这个logger。仅有一个name属性、一个可选的level属性和一个可选的additivity属性:


name:用来指定受此logger约束的某一个包或者具体的某一个类


level:用来设置打印级别,五个常用打印级别从低至高依次为TRACE、DEBUG、INFO、WARN、ERROR,如果未设置此级别,那么当前logger会继承上级的级别


additivity:是否向上级logger传递打印信息,默认为true


1 public LoggerContext() {


2 super();


3 this.loggerCache = new ConcurrentHashMap();


4


5 this.loggerContextRemoteView = new LoggerContextVO(this);


6 this.root = new Logger(Logger.ROOT_LOGGER_NAME, null, this);


7 this.root.setLevel(Level.DEBUG);


8 loggerCache.put(Logger.ROOT_LOGGER_NAME, root);


9 initEvaluatorMap();


10 size = 1;


11 this.frameworkPackages = new ArrayList();


12 }


Logger的构造函数为:


Logger(String name, Logger parent, LoggerContext loggerContext) {


this.name = name;


this.parent = parent;


this.loggerContext = loggerContext;


}


看到第一个参数就是Root的name,而这个Logger.ROOT_LOGGER_NAME的定义为final public String ROOT_LOGGER_NAME = "ROOT",由此可以看出节点的name就是"ROOT"。


接着写一段代码来测试一下:


1 public class Slf4jTest {


2


3 @Test


4 public void testSlf4j() {


5 Logger logger = LoggerFactory.getLogger(Object.class);


6 logger.trace("=====trace=====");


7 logger.debug("=====debug=====");


8 logger.info("=====info=====");


9 logger.warn("=====warn=====");


10 logger.error("=====error=====");


11 }


12


13 }


logback.xml的配置为:


1 <?xml version="1.0" encoding="UTF-8" ?>


2 [/span>configuration scan="false" scanPeriod="60000" debug="false"

3 [/span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"

4 [/span>layout class="ch.qos.logback.classic.PatternLayout"

5 [/span>pattern

6

7

8


9 [/span>root level="info"

10 [/span>appender-ref ref="STDOUT" />


11

12


13

root将打印级别设置为"info"级别,暂时不管,控制台的输出为:


2018-03-26 22:57:48.779 【main】 INFO java.lang.Object - =====info=====


2018-03-26 22:57:48.782 【main】 WARN java.lang.Object - =====warn=====


2018-03-26 22:57:48.782 【main】 ERROR java.lang.Object - =====error=====


logback.xml的意思是,当Test方法运行时,root节点将日志级别大于等于info的交给已经配置好的名为"STDOUT"的进行处理,"STDOUT"将信息打印到控制台上。


接着理解一下节点的作用,logback.xml修改一下,加入一个只有name属性的:


1 <?xml version="1.0" encoding="UTF-8" ?>


2 [/span>configuration scan="false" scanPeriod="60000" debug="false"

3


4 [/span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"

5 [/span>layout class="ch.qos.logback.classic.PatternLayout"

6 [/span>pattern

7

8

9


10 [/span>logger name="java" />


11


12 [/span>root level="debug"

13 [/span>appender-ref ref="STDOUT" />


14

15


16

注意这个name表示的是LoggerFactory.getLogger(XXX.class),XXX的包路径,包路径越少越是父级,我们测试代码里面是Object.class,即name="java"是name="java.lang"的父级,root是所有的父级。看一下输出为:


2018-03-27 23:02:02.963//代码效果参考:http://www.jhylw.com.cn/061022475.html

【main】 DEBUG java.lang.Object - =====debug=====

2018-03-27 23:02:02.965 【main】 INFO java.lang.Object - =====info=====


2018-03-27 23:02:02.966 【main】 WARN java.lang.Object - =====warn=====


2018-03-27 23:02:02.966 【main】 ERROR java.lang.Object - =====error=====


出现这样的结果是因为:


中没有配置level,即继承父级的level,的父级为,那么level=debug


没有配置additivity,那么additivity=true,表示此的打印信息向父级传递


没有配置,表示此不会打印出任何信息


由此可知,的打印信息向传递,使用"STDOUT"这个打印出所有大于等于debug级别的日志。举一反三,我们将的additivity配置为false,那么控制台应该不会打印出任何日志,因为的打印信息不会向父级传递且没有配置任何,大家可以自己试验一下。


接着,我们再配置一个:


1 <?xml version="1.0" encoding="UTF-8" ?>


2 [/span>configuration scan="false" scanPeriod="60000" debug="false"

3


4 [/span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"


5 [/span>layout class="ch.qos.logback.classic.PatternLayout"

6 [/span>pattern

7

8

9


10 [/span>logger name="java" additivity="false" />


11 [/span>logger name="java.lang" level="warn"

12 [/span>appender-ref ref="STDOUT" />


13

14


15 [/span>root level="debug"

16 [/span>appender-ref ref="STDOUT" />


17

18


19

如果读懂了上面的例子,那么这个例子应当很好理解:


LoggerFactory.getLogger(Object.class),首先找到name="java.lang"这个,将日志级别大于等于warn的使用"STDOUT"这个打印出来


name="java.lang"这个没有配置additivity,那么additivity=true,打印信息向上传递,传递给父级name="java"这个


name="java"这个的additivity=false且不关联任何,那么name="java"这个不会打印任何信息


由此分析,得出最终的打印结果为:


2018-03-27 23:12:16.147 【main】 WARN java.lang.Object - =====warn=====


2018-03-27 23:12:16.150 【main】 ERROR java.lang.Object - =====error=====


举一反三,上面的name="java"这个可以把additivity设置为true试试看是什么结果,如果对前面的分析理解的朋友应该很容易想到,有两部分日志输出,一部分是日志级别大于等于warn的、一部分是日志级别大于等于debug的。


接着看一下,是的子节点,是负责写日志的组件。有两个必要属性name和class:


name指定的名称


class指定的全限定名


有好几种,上面我们演示过的是ConsoleAppender,ConsoleAppender的作用是将日志输出到控制台,配置示例为:


1 [/span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"

2 [/span>encoder

3 [/span>pattern

4

5

其中,encoder表示对参数进行格式化。我们和上一部分的例子对比一下,发现这里是有所区别的,上面使用了定义


,这里使用了定义


,简单说一下:


是0.9.19版本之后引进的,以前的版本使用,logback极力推荐的是使用而不是


最常用的FileAppender和它的子类的期望是使用而不再使用


关于中的格式下一部分再说。接着我们看一下FileAppender,FileAppender的作用是将日志写到文件中,配置示例为:


1 [/span>appender name="FILE" class="ch.qos.logback.core.FileAppender"

2 [/span>file

3 [/span>append

4 [/span>encoder

5 [/span>pattern

6

7

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
1月前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
212 30
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
26天前
|
JSON Java Apache
非常实用的Http应用框架,杜绝Java Http 接口对接繁琐编程
UniHttp 是一个声明式的 HTTP 接口对接框架,帮助开发者快速对接第三方 HTTP 接口。通过 @HttpApi 注解定义接口,使用 @GetHttpInterface 和 @PostHttpInterface 等注解配置请求方法和参数。支持自定义代理逻辑、全局请求参数、错误处理和连接池配置,提高代码的内聚性和可读性。
101 3
|
28天前
|
Java 中间件
SpringBoot入门(6)- 添加Logback日志
SpringBoot入门(6)- 添加Logback日志
70 5
|
1月前
|
人工智能 前端开发 Java
基于开源框架Spring AI Alibaba快速构建Java应用
本文旨在帮助开发者快速掌握并应用 Spring AI Alibaba,提升基于 Java 的大模型应用开发效率和安全性。
基于开源框架Spring AI Alibaba快速构建Java应用
|
1月前
|
消息中间件 Java 数据库连接
Java 反射最全详解 ,框架设计必掌握!
本文详细解析Java反射机制,包括反射的概念、用途、实现原理及应用场景。关注【mikechen的互联网架构】,10年+BAT架构经验倾囊相授。
Java 反射最全详解 ,框架设计必掌握!
|
1月前
|
JSON 前端开发 JavaScript
java-ajax技术详解!!!
本文介绍了Ajax技术及其工作原理,包括其核心XMLHttpRequest对象的属性和方法。Ajax通过异步通信技术,实现在不重新加载整个页面的情况下更新部分网页内容。文章还详细描述了使用原生JavaScript实现Ajax的基本步骤,以及利用jQuery简化Ajax操作的方法。最后,介绍了JSON作为轻量级数据交换格式在Ajax应用中的使用,包括Java中JSON与对象的相互转换。
43 1
|
1月前
|
SQL Java 数据库连接
在Java应用中,数据库访问常成为性能瓶颈。连接池技术通过预建立并复用数据库连接,有效减少连接开销,提升访问效率
在Java应用中,数据库访问常成为性能瓶颈。连接池技术通过预建立并复用数据库连接,有效减少连接开销,提升访问效率。本文介绍了连接池的工作原理、优势及实现方法,并提供了HikariCP的示例代码。
47 3
|
1月前
|
SQL 监控 Java
Java连接池技术的最新发展,包括高性能与低延迟、智能化管理与监控、扩展性与兼容性等方面
本文探讨了Java连接池技术的最新发展,包括高性能与低延迟、智能化管理与监控、扩展性与兼容性等方面。同时,结合最佳实践,介绍了如何选择合适的连接池库、合理配置参数、使用监控工具及优化数据库操作,以实现高效稳定的数据库访问。示例代码展示了如何使用HikariCP连接池。
16 2
|
1月前
|
Java 数据库连接 数据库
深入探讨Java连接池技术如何通过复用数据库连接、减少连接建立和断开的开销,从而显著提升系统性能
在Java应用开发中,数据库操作常成为性能瓶颈。本文通过问题解答形式,深入探讨Java连接池技术如何通过复用数据库连接、减少连接建立和断开的开销,从而显著提升系统性能。文章介绍了连接池的优势、选择和使用方法,以及优化配置的技巧。
30 1
|
1月前
|
算法 Java 数据库连接
Java连接池技术,从基础概念出发,解析了连接池的工作原理及其重要性
本文详细介绍了Java连接池技术,从基础概念出发,解析了连接池的工作原理及其重要性。连接池通过复用数据库连接,显著提升了应用的性能和稳定性。文章还展示了使用HikariCP连接池的示例代码,帮助读者更好地理解和应用这一技术。
46 1