Java 面試題之 Logback 列印日誌是如何獲取當前方法名稱的?

来源:https://www.cnblogs.com/waynaqua/archive/2023/11/12/17826957.html
-Advertisement-
Play Games

在 Java 中,有四種方法可以獲取當前正在執行方法體的方法名稱,分別是: 使用 Thread.currentThread().getStackTrace() 方法 使用異常對象的 getStackTrace() 方法 使用匿名內部類的 getClass().getEnclosingMethod() ...


在 Java 中,有四種方法可以獲取當前正在執行方法體的方法名稱,分別是:

  1. 使用 Thread.currentThread().getStackTrace() 方法
  2. 使用異常對象的 getStackTrace() 方法
  3. 使用匿名內部類的 getClass().getEnclosingMethod() 方法
  4. Java 9 的 Stack-Walking API

本文將根據以上四種方法來給大家進行具體講解,不過不知道大家有沒有想過,獲取當前執行方法體的方法名稱有什麼用嘞?

它可以用於日誌記錄、異常處理、測試框架等方面。例如我們可以在方法的開始和結束時列印出當前方法名和參數,以便追蹤程式的執行流程和性能。在介紹完以上四種方法後,就會給大家揭曉面試題答案。

1.使用 Thread.currentThread().getStackTrace()方法

這種方法是通過獲取當前線程的堆棧跟蹤信息,然後從中提取出當前方法名的。具體的代碼如下:

// 獲取當前方法名
String methodName = Thread.currentThread().getStackTrace()[1].getMethodName();
// 列印當前方法名
System.out.println("當前方法名:" + methodName);

這種方法的優點是簡單易用,不需要創建額外的對象。缺點是性能較低,因為 Thread.currentThread().getStackTrace() 方法獲取堆棧跟蹤信息需要遍歷整個調用棧,而且需要保證線程安全性。

2.使用異常對象的 getStackTrace()方法

這種方法是通過創建一個新的異常對象,然後從其堆棧跟蹤信息中提取出當前方法名和參數的。具體的代碼如下:

// 獲取當前方法名
String methodName = new Exception().getStackTrace()[0].getMethodName();
// 列印當前方法名
System.out.println("當前方法名:" + methodName);

這種方法的優點是不需要獲取堆棧跟蹤信息,而且不會創建異常對象,因此性能和可讀性都較好。缺點是需要創建額外的對象,而且代碼較為複雜,不太直觀。

3.匿名內部類的 getClass().getEnclosingMethod()方法

這種方法是通過創建一個匿名內部類的對象,然後從其類對象中獲取當前方法的方法對象,再從方法對象中獲取當前方法名和參數的。具體的代碼如下:

// 獲取當前方法名
String methodName = new Object(){}.getClass().getEnclosingMethod().getName();
// 列印當前方法名
System.out.println("當前方法名:" + methodName);

這種方法的優點是不需要獲取堆棧跟蹤信息,而且不會創建異常對象,因此性能和可讀性都較好。缺點是需要創建額外的對象,而且代碼較為複雜,不太直觀。

4.Java 9 的 Stack-Walking API

Java 9 引入了 Stack-Walking API,以惰性且高效的方式遍歷 JVM 堆棧幀。可以使用這個 API 找到當前正在執行的方法,具體的代碼如下:

StackWalker walker = StackWalker.getInstance();
Optional<String> optional = walker.walk(frames -> frames
        .findFirst()
        .map(StackWalker.StackFrame::getMethodName));
System.out.println("當前方法名:" + optional.get());

首先,我們使用 StackWalker.getInstance() 工廠方法獲取 StackWalker 實例。然後我們使用 walk() 方法從上到下遍歷棧幀:

  • walk() 方法可以將堆棧幀轉化為 Stream
  • findFirst() 方法從 Stream 流中的獲取第一個元素,也就是堆棧的頂部幀,頂部幀就代表當前正在執行的方法
  • map() 方法用於獲取頂部幀 StackFrame 的當前方法名稱

Stack-Walking API 的優點

與以上方法相比,Stack-Walking API 有很多優點:

  • 線程安全
  • 無需創建匿名內部類實例 - new Object().getClass(){}
  • 無需創建異常 - new Throwable()
  • 無需急切地捕獲整個堆棧跟蹤,這可能成本很高 - Thread.currentThread()

StackWalker 是以一種懶惰的方式逐一遍歷堆棧。在需要獲取當前方法名稱時,我們可以只獲取頂部幀,而不需要捕獲整個堆棧跟蹤。

推薦作者開源的 H5 商城項目 waynboot-mall,這是一套全部開源的微商城項目,包含三個項目:運營後臺、H5 商城前臺和服務端介面。實現了商城所需的首頁展示、商品分類、商品詳情、商品 sku、分詞搜索、購物車、結算下單、支付寶/微信支付、收單評論以及完善的後臺管理等一系列功能。 技術上基於最新得 Springboot3.0、jdk17,整合了 MySql、Redis、RabbitMQ、ElasticSearch 等常用中間件。分模塊設計、簡潔易維護,歡迎大家點個 star、關註我。

github 地址:https://github.com/wayn111/waynboot-mall

經典例子:Logback

Logback 是一個流行的 Java 日誌框架,它是 Log4j 的繼承者,由 Log4j 的創始人設計。Logback 有以下特點:

  • 高性能:Logback 比其他日誌框架更快,更節省空間,有時甚至大得多。
  • 靈活配置:Logback 支持 XML 和 Groovy 兩種配置方式,可以實現動態修改配置,無需重啟應用。
  • 豐富功能:Logback 提供了多種輸出目標,如控制台、文件、資料庫、郵件等,還支持滾動策略、過濾器、非同步日誌等高級功能。
  • 與 SLF4J 集成:Logback 是 SLF4J 的原生實現,可以與其他基於 SLF4J 的日誌框架無縫切換。

不知道大家有沒有想過,我們在使用 Logback 日誌框架中列印日誌時,是如何獲取當前執行方法體的方法名稱的嘞?在 Spring 項目中,我們一般是通過 Logback 的 xml 文件 parttern 屬性來配置日誌格式的。xml 配置如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <springProperty scope="context" name="appName" source="spring.application.name" defaultValue="dev"/>
    <property name="logPath" value="/home/logs/${appName}"/>
    <property name="pattern"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{request_id}] [%thread] [%-5level] %logger{36}:%L %M - %msg%n"/>

    <!-- 控制台輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 預設配置為PatternLayoutEncoder -->
        <encoder>
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>
    <!-- 記錄日誌到文件 -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logPath}/info.log</file>
        <encoder>
            <pattern>${pattern}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logPath}/run.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
    </appender>
    ...
</configuration>

可以看到我們配置的日誌輸出格式是 %d{yyyy-MM-dd HH:mm:ss.SSS} [%X{request_id}] [%thread] [%-5level] %logger{36}:%L %M - %msg%n,Logback 在列印日誌時,會解析這個日誌輸出格式,最後將 %M 占位符替換為當前方法名稱。

解析日誌格式的源碼就在 FormattingConverter 類的 write() 方法中,write() 方法中會執行 convert() 方法,這個方法就是執行占位符替換的。源碼截圖如下,

image

如上圖根據類名我們可以看到紅線框起來的 MethodOfCallerConverter 類就是用來執行 %M 占位符替換邏輯的,代碼如下,

public class MethodOfCallerConverter extends ClassicConverter {
    public String convert(ILoggingEvent le) {
        StackTraceElement[] cda = le.getCallerData();
        if (cda != null && cda.length > 0) {
            // 返回當前方法名稱
            return cda[0].getMethodName();
        } else {
            return CoreConstants.NA;
        }
    }
}

方法邏輯如下,

  1. StackTraceElement[] cda = le.getCallerData() 獲取當前堆棧頂部幀
  2. cda[0].getMethodName() 根據頂部幀獲取當前方法名稱。

如上,我們只需要看下 le.getCallerData() 方法的堆棧是從哪裡獲取來的,就能知道本題的答案了。

進入 LoggingEvent 源碼類中,我們可以發現堆棧獲取邏輯,源碼如下,

public class LoggingEvent implements ILoggingEvent {
    public StackTraceElement[] getCallerData() {
        if (callerDataArray == null) {
            // 堆棧初始化
            callerDataArray = CallerData.extract(new Throwable(), fqnOfLoggerClass,
                    loggerContext.getMaxCallerDataDepth(), loggerContext.getFrameworkPackages());
        }
        return callerDataArray;
    }
    ...
}
  1. 如果當前堆棧為空,進行堆棧信息初始化。這裡就可以看到堆棧信息初始化來自 CallerData.extract(new Throwable(), fqnOfLoggerClass,loggerContext.getMaxCallerDataDepth(), loggerContext.getFrameworkPackages()) 方法。
  2. 如果堆棧信息不為空,直接返回當前堆棧。這裡是為了避免浪費,針對在一個方法中重覆獲取堆棧信息的情況。

Ok,到這裡離勝利就只差一步了。進一步查看 CallerData.extract(new Throwable(), fqnOfLoggerClass,loggerContext.getMaxCallerDataDepth(), loggerContext.getFrameworkPackages()) 方法,源碼如下,

public class CallerData {
    public static StackTraceElement[] extract(Throwable t, String fqnOfInvokingClass, final int maxDepth,
            List<String> frameworkPackageList) {
        if (t == null) {
            return null;
        }

        StackTraceElement[] steArray = t.getStackTrace();
        StackTraceElement[] callerDataArray;
        ...
        callerDataArray = new StackTraceElement[desiredDepth];
        for (int i = 0; i < desiredDepth; i++) {
            callerDataArray[i] = steArray[found + i];
        }
        return callerDataArray;
    }
    ...
}

為了突出源碼邏輯的重點,這裡我刪去了一部分代碼,是為了讓大家更好的看清楚 Logback 中堆棧信息的初始化,其實用的就是異常對象的 getStackTrace() 方法。也就是上面源碼中 StackTraceElement[] steArray = t.getStackTrace() 方法所體現的。

那麼到這裡我就可以下一個結論了, Logback 日誌框架中列印日誌時,就是使用異常對象的 getStackTrace() 方法來獲取當前執行方法的方法名稱的。

總結

本文有介紹四種方法獲取當前執行方法名稱,一般情況下大家使用異常對象的 getStackTrace() 方法以及匿名內部類的 getClass().getEnclosingMethod() 方法都是可以的,它們的性能都 OK,代碼書寫複雜程度都大差不差。在 Java 9 以後推薦使用 Stack-Walking API,它的功能更為強大,與程式里的堆棧語意也跟為契合,性能 OK,並且還是線程安全的。

關註公眾號【waynblog】每周分享技術乾貨、開源項目、實戰經驗、國外優質文章翻譯等,您的關註將是我的更新動力!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 清晰架構原則對於任何希望創建健壯、可維護和可擴展軟體的軟體開發者來說都至關重要。理解並實施這些概念可以顯著提升你的編程技能。以下是對20個基本架構洞見的深入探討:依賴規則: 清晰架構的核心是依賴規則。它規定源代碼的依賴關係應始終指向內部。這種內向的方向確保了一個具有彈性的基礎,強調了關註點的分離,並 ...
  • 六、判斷(一) 1、關係運算符 1)每一個關係運算符得出的結果都是一個布爾類型值(true、flase或真、假或1、0) 關係運算符 說明 關係運算符 說明 > 大於 >= 大於等於 < 小於 <= 小於等於 == 等於 != 不等於 #include <iostream> int main() { ...
  • 常見鎖介紹 synchronized鎖的八中情況 package com.shaonian.juc.more_thread_lock; import java.util.concurrent.TimeUnit; class Phone { public static synchronized voi ...
  • Python MySQL 限制結果 限制結果數量 示例 1: 獲取您自己的 Python 伺服器 選擇 "customers" 表中的前 5 條記錄: import mysql.connector mydb = mysql.connector.connect( host="localhost", u ...
  • 操作系統 :Windows 10_x64 python版本 :3.9.2 pymysql版本: 1.0.2 MySQL版本: 5.7.38 之前寫過一篇關於python操作mysql資料庫的文章: https://www.cnblogs.com/MikeZhang/p/pythonOptMysql2 ...
  • 寫在前面 目前已經上班快兩個月了,對現在的工作很滿意,甚至更喜歡這的氛圍吧。 如題所示,從今年5月開始,發生的所有事,都完全超出了我自己可以承受的範圍,好在這一切都過去了,真的感謝上天安排,讓我能更加確信自己要的是什麼,以後該怎麼生活。 爸爸被診斷為肺癌 我每年都會帶父母去做體檢,因為去年疫情全面放 ...
  • 本文適用範圍 主要適用於debug python 程式,尤其是深度學習剛入門需要使用remote 連接到linux進行程式運行,想調試一下的同學。 當然非深度學習也可以參考食用本文哈哈哈。 極速入門版 提前準備:代碼倉庫已經拉取到linux上面,且已經知道運行的方式。 比如: 項目的啟動命令為:py ...
  • 五、位運算 ​ 位運算主要計算記憶體中每個小格的數據 1、輸出二進位內容 頭文件調用 語法 示例 include <bitser> std::bitset<要顯示的二進位位數>(要顯示的變數) std::cout << std::bitset<16>(a); //二進位內容輸出 #include <i ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...