日志框架 - 基于spring-boot - 设计

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 日志框架系列讲解文章日志框架 - 基于spring-boot - 使用入门日志框架 - 基于spring-boot - 设计日志框架 - 基于spring-boot - 实现1 - 配置文件日志框架 - 基于spring-boot - 实现2 - 消...

日志框架系列讲解文章
日志框架 - 基于spring-boot - 使用入门
日志框架 - 基于spring-boot - 设计
日志框架 - 基于spring-boot - 实现1 - 配置文件
日志框架 - 基于spring-boot - 实现2 - 消息定义及消息日志打印
日志框架 - 基于spring-boot - 实现3 - 关键字与三种消息解析器
日志框架 - 基于spring-boot - 实现4 - HTTP请求拦截
日志框架 - 基于spring-boot - 实现5 - 线程切换
日志框架 - 基于spring-boot - 实现6 - 自动装配

在前文 日志框架 - 基于spring-boot - 使用入门 中,我介绍了日志框架的使用。

但读者看到了可能云里雾里的,因为没有代码也没有设计说明。所以你猜的没错!这一次就要来向各位观众揭示这小玩意里面的道道。

源起混乱的日志代码

前文已经解释过为什么要新造一个日志框架。
但我想靠文字不能有深切的体会。
下面是我在读别人代码时经常看到的代码:

logger.info("#{}#{}#{}#{}#{}", new String[]{
             orderInfo.getOrderNo() /*订单号*/, 
             orderInfo.getTradeCode() /*交易代码*/, 
             orderInfo.getReqSys() /*请求方系统*/, 
             orderInfo.getLocale() /*区域代码*/, 
             "req done" /*日志内容*/})

没有粗暴的用字符串相加,说明开发人员已经有一点水平了,但是……

这段代码意味着多糟糕的事情呢!?
写上面这段代码的可能是某个加班熬夜到神志模糊的程序员,更糟的是他借差迷糊劲把其中的两行写反了!
不对照着日志规范细扣,基本没有人能发现问题。

为了让WEB层的Controller与业务层的Service都能这样打印,Service层接口硬生生插入一个orderInfo,变成这样。

public void service(SomeThing toServed, OrderInfo orderInfo)

业务代码里面充斥着这样的代码,写的人不知疲倦,看的我心烦意乱了。
于是乎,我下定决心!要有一个日志框架,好好教人打日志

logger.info("req done" /*日志内容*/)

必须像上面这样写日志代码,其它的内容全部实现自动填充!

设计原则

好!现在就来开始动手设计理想中的框架。但是在动手之前,还需要想清楚两件事。

  1. 第一,要走的更远,需要站在巨人的肩膀上。我无意实现一个跟log4j与logback之类雷同的框架。要利用上log4j或logback的特性,最好能兼容它们俩。
  2. 第二,一个好用的框架要做到称手。要对普通开发人员透明,减少使用者的学习成本。

考虑到以上两点,并结合我们应用常见的开发场景,我最终选定这个框架基于spring-boot实现。因为spring-boot提供了众多实用的机制可供选择。享受spring-boot带来便利的同时,也为spring-boot做一些贡献,互利互惠。

基本概念

  1. 在我们系统中,一个应用经常能过HTTP或MQ与外部应用沟通,我把沟通的内容称为消息
  2. 消息中携带了许多关键信息,如前面提到的OrderNo、TradeCode等,需要被记录打印,我将其称为关键字
  3. 我将系统常用日志分为三类,分别是系统运行日志消息日志告警日志,它们各自输出到不同的文件中。它们会被采集分析,分别服务于运维人员、分析系统、监控系统。由于对接系统不同,因此它们有各自的日志格式定义。

总体设计

img_4e92267e5cc0321560e14c529b54128b.png
日志框架示意图

如图展示,里层绿色为应用层,指业务开发人员编写的业务代码;外层蓝色部分为框架层,包含日志框架的各个功能模块。

简单地说,日志框架有以下要点:

  1. 在请求进入业务层之前进行拦截,获得消息(Message)
  2. 根据关键字(Keyword),使用解析器(MessageResolver)提取消息(Message)中的值。关键字(Keyword)及其值保存于MDC之中。
  3. 打印日志时,将MDC中的值按格式自动填充到指定位置。
  4. 提供一个@MessageToLog注解,在函数上使用,将函数的返回值视作消息(Message),打印到消息日志中。
  5. 对系统运行日志,消息日志,告警日志三种不同的日志类型,有各自的追加器(Appender),分别写入到不同的文件中。

实现

具体代码实现,且听下回分解。

日志框架系列讲解文章
日志框架 - 基于spring-boot - 使用入门
日志框架 - 基于spring-boot - 设计
日志框架 - 基于spring-boot - 实现1 - 配置文件
日志框架 - 基于spring-boot - 实现2 - 消息定义及消息日志打印
日志框架 - 基于spring-boot - 实现3 - 关键字与三种消息解析器
日志框架 - 基于spring-boot - 实现4 - HTTP请求拦截
日志框架 - 基于spring-boot - 实现5 - 线程切换
日志框架 - 基于spring-boot - 实现6 - 自动装配

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
10天前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
110 30
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
17天前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
30天前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
40 4
|
1月前
|
JavaScript 安全 Java
如何使用 Spring Boot 和 Ant Design Pro Vue 实现动态路由和菜单功能,快速搭建前后端分离的应用框架
本文介绍了如何使用 Spring Boot 和 Ant Design Pro Vue 实现动态路由和菜单功能,快速搭建前后端分离的应用框架。首先,确保开发环境已安装必要的工具,然后创建并配置 Spring Boot 项目,包括添加依赖和配置 Spring Security。接着,创建后端 API 和前端项目,配置动态路由和菜单。最后,运行项目并分享实践心得,包括版本兼容性、安全性、性能调优等方面。
137 1
|
27天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
34 0
|
21天前
|
前端开发 Java 数据库连接
Spring 框架:Java 开发者的春天
Spring 框架是一个功能强大的开源框架,主要用于简化 Java 企业级应用的开发,由被称为“Spring 之父”的 Rod Johnson 于 2002 年提出并创立,并由Pivotal团队维护。
41 1
Spring 框架:Java 开发者的春天
|
3天前
|
存储 运维 安全
Spring运维之boot项目多环境(yaml 多文件 proerties)及分组管理与开发控制
通过以上措施,可以保证Spring Boot项目的配置管理在专业水准上,并且易于维护和管理,符合搜索引擎收录标准。
11 2
|
1月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
52 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
14天前
|
JavaScript 安全 Java
如何使用 Spring Boot 和 Ant Design Pro Vue 构建一个前后端分离的应用框架,实现动态路由和菜单功能
本文介绍了如何使用 Spring Boot 和 Ant Design Pro Vue 构建一个前后端分离的应用框架,实现动态路由和菜单功能。首先,确保开发环境已安装必要的工具,然后创建并配置 Spring Boot 项目,包括添加依赖和配置 Spring Security。接着,创建后端 API 和前端项目,配置动态路由和菜单。最后,运行项目并分享实践心得,帮助开发者提高开发效率和应用的可维护性。
32 2
|
13天前
|
消息中间件 NoSQL Java
springboot整合常用中间件框架案例
该项目是Spring Boot集成整合案例,涵盖多种中间件的使用示例,每个案例项目使用最小依赖,便于直接应用到自己的项目中。包括MyBatis、Redis、MongoDB、MQ、ES等的整合示例。
61 1