当前位置: 首页 > news >正文

太牛逼了,自己封装一个日志打印工具类

前言

我们都知道一个真相,在开发中,日志记录扮演着极其重要的角色。

无论是在开发调试阶段,还是在生产环境中,日志都能够帮助我们追踪系统状态、定位问题、分析性能。

甚至在出现问题时,日志往往是最有力的线索,基本都用它排查问题以及快速定位问题。

然而,我们在敲代码时,如果随便使用System.out.println()来输出日志,就会导致以下一系列问题,这是完全没必要的损耗,例如:

  • 性能差:System.out.println()直接输出到控制台,性能较差。

  • 不易管理:日志信息没有级别区分,也没有统一的格式。

  • 不方便追踪:没有详细的日志记录,尤其在生产环境,错误时很难追溯问题的根源。

因此,使用专业的日志框架进行日志记录显得尤为重要。

今天,我们将通过一个具体的实战案例,学习如何使用SLF4J + Logback配合 Lombok 提供的@Slf4j注解,封装出一个统一的日志工具类,帮助我们高效、优雅地管理日志输出。

为什么使用日志工具而非 System.out?

理由很简单,使用System.out.println()进行日志输出虽然简单,但它存在许多弊端。 尤其是随着项目的复杂度提高,逐渐暴露出性能、管理和可维护性等问题:

  • 性能问题:System.out.println()直接输出到控制台,每次调用都会消耗一定的系统资源。

    在高并发、频繁调用的情况下,控制台输出会显得非常低效,严重影响系统性能。

  • 日志级别管理:日志记录的级别(如调试信息、错误信息、警告信息等)在System.out.println()中完全无法区分。

    而使用日志框架时,我们可以清晰地定义日志级别,例如DEBUGINFOWARNERROR等。不同级别的日志可以分别输出到控制台或文件中,帮助我们更好地管理日志信息。

  • 格式统一性:在项目中,每个模块、每个开发人员可能都会采用不同的日志格式,导致日志混乱、难以阅读。

    使用日志工具类可以帮助我们统一日志输出格式,方便调试和查看。

因此,选择使用专门的日志框架来替代System.out.println(),不仅能提高性能和可维护性输出格式与级别

使用 SLF4J 和 Logback 组合

SLF4J(Simple Logging Facade for Java),它是 Java 中最常用的日志接口。 它并不直接提供日志实现,而是通过 API 抽象化了日志框架。

Logback 是与 SLF4J 配合使用的日志框架,它提供了强大的日志功能,能够管理日志的输出级别、格式化、存储等,谁用谁爽,不信你试试。

配置 Logback,引入相关依赖

首先,我们需要引入 SLF4J 和 Logback 相关的依赖。

在 Maven 中,我们可以像这样引入:

<dependencies> <!-- SLF4J 核心接口依赖 --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.32</version> </dependency> <!-- Logback 日志实现核心包 --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.6</version> </dependency> <!-- Logback 核心依赖 --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.2.6</version> </dependency> </dependencies>

接下来,我们还需要在src/main/resources目录下创建logback.xml配置文件,配置日志输出格式、输出级别等:

<configuration> <!-- 定义控制台输出器 --> <appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender"> <encoder> <!-- 日志格式:时间 - 级别 [线程名] 类名 - 日志内容 --> <pattern>%d{yyyy-MM-dd HH:mm:ss} - %5p [%t] %logger{36} - %msg%n</pattern> </encoder> </appender> <!-- 根日志配置,级别为debug --> <rootlevel="debug"> <!-- 关联控制台输出器 --> <appender-refref="STDOUT" /> </root> </configuration>

在上面这个配置中,我们可以设置日志输出的格式,包括输出时间、日志级别、线程名、类名、日志内容等。

日志级别被设置为DEBUG,意味着所有DEBUG级别及以上的日志信息都会被输出。

当然这个级别在生产环境可以设置为更高一级的,比如ERROR,这样直接可对标排查报错等异常。

使用 Lombok 的 @Slf4j 注解

在传统日志框架中,开发者需要手动创建 Logger 对象,但使用 Lombok 提供的@Slf4j注解后,我们无需再手动声明 Logger。

Lombok 会自动为我们生成 Logger 实例。

import lombok.extern.slf4j.Slf4j; // 添加@Slf4j注解,自动生成log对象 @Slf4j publicclassLogExample{ publicstaticvoidmain(String[] args){ // 输出INFO级别的日志 log.info("This is an info message"); // 输出DEBUG级别的日志 log.debug("This is a debug message"); // 输出ERROR级别的日志 log.error("This is an error message"); // 输出WARN级别的日志 log.warn("This is a warning message"); } }

通过使用@Slf4j注解,我们不需要显式地创建 Logger 对象,直接使用 log 进行日志记录,简化了代码。

实战:API 日志统一、异常追踪日志输出
API 日志统一

在实际项目中,尤其是 Web 项目中,我们往往需要统一记录 API 请求和响应的日志。 通过日志工具,我们能够记录请求的详细信息,包括请求的 URL、参数、请求方法等,还能记录响应内容和状态。

以下是一个简单的示例,展示如何记录 API 日志:

import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import lombok.extern.slf4j.Slf4j; // 开启日志功能 @Slf4j @RestController publicclassAPIController{ // 定义一个测试接口 @GetMapping("/api/test") public String testAPI(){ // 记录请求到达日志 log.info("API request received for /api/test"); String response = "Hello, world!"; // 记录响应内容日志 log.info("API response: {}", response); return response; } }

在上面这个demo中,log.info()记录了 API 请求的日志和响应的日志。

你可以轻松地根据业务需求修改日志级别,例如在调试时使用 DEBUG,在出错时使用 ERROR 等。

异常追踪日志输出

在系统出现异常时,日志记录尤为重要,它能帮助开发者快速定位问题。

在生产环境中,异常日志通常包含详细的堆栈信息,这有助于我们追踪问题的根本原因。

以下是如何记录异常日志的示例:

import lombok.extern.slf4j.Slf4j; @Slf4j publicclassExceptionHandler{ publicvoidhandleException(){ try { // 模拟出现异常的代码 int result = 10 / 0; } catch (Exception e) { // 记录异常信息,第二个参数传入异常对象会自动打印堆栈 log.error("An error occurred: ", e); } } }

在代码中,我们就通过log.error()来记录发生异常时的堆栈信息。

这样,当问题发生时,我们可以迅速查看到详细的异常信息,帮助我们定位问题。

http://www.cnnetsun.cn/news/834042.html

相关文章:

  • 5个秘诀让Switch自制系统维护从此无忧:AIO-Switch-Updater全场景问题解决方案
  • 如何通过Node.js扩展UEDITOR实现ELECTRON中的WORD图片转存?
  • 军工系统SpringCloud如何实现大文件续传?
  • 使用Jenkins持续集成的一些经验总结
  • 超越Selenium!揭秘自动化测试新王牌:Playwright
  • IPTV检测工具:智能优化播放列表,精准筛选可用频道
  • Baritone与Minecraft自动化:从入门到精通的智能导航与资源采集指南
  • 在Linux中如何查看文件类型?
  • 艾尔登法环存档修改器完全指南:打造专属交界地冒险
  • 告别配置噩梦,OpCore-Simplify让黑苹果搭建零门槛
  • 面试官问你:为什么频繁连接MySQL数据库会消耗很多资源?
  • 4步搞定黑苹果配置:面向硬件爱好者的智能配置工具
  • 软件测试之压力测试详解
  • 最新排名揭示,6个AI论文工具可同步提升写作质量与降低重复率
  • AI技术支持的6款论文工具,兼具高效写作与智能改写功能
  • 如何用OpCore-Simplify轻松配置黑苹果?3个核心优势让复杂EFI制作变简单
  • AI技术革新科研流程,开题报告撰写效率倍增
  • 图片批量加水印神器,多种水印添加方式,文字水印,图片水印,满屏水印,永久免费使用,无需联网离线也可,完美保护隐私
  • 2026年AI大模型人才需求爆发,8大核心岗位能力要求全解析
  • 解锁高效歌词提取:开源工具的5个专业级实用技巧
  • 从噪点到模型:3D扫描数据修复与切片优化实战指南
  • 零基础掌握图像修复技术:AI图像编辑核心技巧与智能修复工具应用指南
  • 流媒体检测工具技术指南:效率提升与资源优化实践
  • 告别黑苹果配置噩梦:OpCore Simplify智能配置工具让技术民主化
  • Open Notebook:隐私优先的本地部署多模型兼容AI笔记工具
  • 还在为APP测试熬秃头?这款AI工具让你效率飞升10倍!
  • 两足行走机器人行走控制部分设计
  • SQLite3学习笔记3:UTC和CST 时区偏差问题
  • 彻底解决Play Integrity验证限制:自定义ROM用户的5个突破技巧
  • 手把手教你学Simulink--电机电磁兼容与可靠性​场景示例:基于Simulink的电机轴电压与轴电流抑制仿真