必知的技术知识: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日志并进行多维度分析。
相关文章
Java 集合框架中的老炮与新秀:HashTable 和 HashMap 谁更胜一筹?
嗨,大家好,我是技术伙伴小米。今天通过讲故事的方式,详细介绍 Java 中 HashMap 和 HashTable 的区别。从版本、线程安全、null 值支持、性能及迭代器行为等方面对比,帮助你轻松应对面试中的经典问题。HashMap 更高效灵活,适合单线程或需手动处理线程安全的场景;HashTable 较古老,线程安全但性能不佳。现代项目推荐使用 ConcurrentHashMap。关注我的公众号“软件求生”,获取更多技术干货!
66 3
Java机器学习实战:基于DJL框架的手写数字识别全解析
在人工智能蓬勃发展的今天,Python凭借丰富的生态库(如TensorFlow、PyTorch)成为AI开发的首选语言。但Java作为企业级应用的基石,其在生产环境部署、性能优化和工程化方面的优势不容忽视。DJL(Deep Java Library)的出现完美填补了Java在深度学习领域的空白,它提供了一套统一的API,允许开发者无缝对接主流深度学习框架,将AI模型高效部署到Java生态中。本文将通过手写数字识别的完整流程,深入解析DJL框架的核心机制与应用实践。
27 2
|
1月前
|
java语言后台管理ruoyi后台管理框架-登录提示“无效的会话,或者会话已过期,请重新登录。”-扩展知识数据库中密码加密的方法-问题如何解决-以及如何重置若依后台管理框架admin密码-优雅草卓伊凡
java语言后台管理ruoyi后台管理框架-登录提示“无效的会话,或者会话已过期,请重新登录。”-扩展知识数据库中密码加密的方法-问题如何解决-以及如何重置若依后台管理框架admin密码-优雅草卓伊凡
187 3
java语言后台管理ruoyi后台管理框架-登录提示“无效的会话,或者会话已过期,请重新登录。”-扩展知识数据库中密码加密的方法-问题如何解决-以及如何重置若依后台管理框架admin密码-优雅草卓伊凡
java 中的fork join框架
Java中的Fork Join框架于Java 7引入,旨在提升并行计算能力。它通过“分而治之”的思想,将大任务拆分为多个小任务(fork),再将结果合并(join)。核心组件包括:ForkJoinPool(管理线程池和工作窃取机制)、ForkJoinWorkerThread(执行具体任务的工作线程)和ForkJoinTask(定义任务逻辑,常用子类为RecursiveAction和RecursiveTask)。框架支持通过invoke、fork/join等方式提交任务,广泛应用于高性能并发场景。
SaaS云计算技术的智慧工地源码,基于Java+Spring Cloud框架开发
智慧工地源码基于微服务+Java+Spring Cloud +UniApp +MySql架构,利用传感器、监控摄像头、AI、大数据等技术,实现施工现场的实时监测、数据分析与智能决策。平台涵盖人员、车辆、视频监控、施工质量、设备、环境和能耗管理七大维度,提供可视化管理、智能化报警、移动智能办公及分布计算存储等功能,全面提升工地的安全性、效率和质量。
Java中的Fork/Join框架详解
Fork/Join框架是Java并行计算的强大工具,尤其适用于需要将任务分解为子任务的场景。通过正确使用Fork/Join框架,可以显著提升应用程序的性能和响应速度。在实际应用中,应结合具体需求选择合适的任务拆分策略,以最大化并行计算的效率。
70 23
Spring Boot中的日志框架选择
在Spring Boot开发中,日志管理至关重要。常见的日志框架有Logback、Log4j2、Java Util Logging和Slf4j。选择合适的日志框架需考虑性能、灵活性、社区支持及集成配置。本文以Logback为例,演示了如何记录不同级别的日志消息,并强调合理配置日志框架对提升系统可靠性和开发效率的重要性。
Java从入门到精通:3.1.2深入学习Java EE技术——Hibernate与MyBatis等ORM框架的掌握
Java从入门到精通:3.1.2深入学习Java EE技术——Hibernate与MyBatis等ORM框架的掌握
106 1
Java从入门到精通:2.1.1深入学习Java核心技术——掌握Java集合框架
Java从入门到精通:2.1.1深入学习Java核心技术——掌握Java集合框架
论文翻译 | 【深入挖掘Java技术】「底层原理专题」深入分析一下并发编程之父Doug Lea的纽约州立大学的ForkJoin框架的本质和原理
本文深入探讨了一个Java框架的设计、实现及其性能。该框架遵循并行编程的理念,通过递归方式将问题分解为多个子任务,并利用工作窃取技术进行并行处理。所有子任务完成后,其结果被整合以形成完整的并行程序。 在总体设计上,该框架借鉴了Cilk工作窃取框架的核心理念。其核心技术主要聚焦于高效的任务队列构建和管理,以及工作线程的管理。经过实际性能测试,我们发现大多数程序的并行加速效果显著,但仍有优化空间,未来可能需要进一步研究改进方案。
113 3
论文翻译 | 【深入挖掘Java技术】「底层原理专题」深入分析一下并发编程之父Doug Lea的纽约州立大学的ForkJoin框架的本质和原理
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等