在Java中有四種方法可以獲取當(dāng)前正在執(zhí)行方法體的方法名稱

分別是：

• 使用 Thread.currentThread().getStackTrace() 方法
• 使用異常對象的 getStackTrace() 方法
• 使用匿名內(nèi)部類的 getClass().getEnclosingMethod() 方法
• Java 9 的 Stack-Walking API

本文將根據(jù)以上四種方法來給大家進(jìn)行具體講解，不過不知道大家有沒有想過，獲取當(dāng)前執(zhí)行方法體的方法名稱有什么用嘞？

它可以用于日志記錄、異常處理、測試框架等方面。例如我們可以在方法的開始和結(jié)束時打印出當(dāng)前方法名和參數(shù)，以便追蹤程序的執(zhí)行流程和性能。在介紹完以上四種方法后，就會給大家揭曉面試題答案。

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

這種方法是通過獲取當(dāng)前線程的堆棧跟蹤信息，然后從中提取出當(dāng)前方法名的。具體的代碼如下：

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

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

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

這種方法是通過創(chuàng)建一個新的異常對象，然后從其堆棧跟蹤信息中提取出當(dāng)前方法名和參數(shù)的。具體的代碼如下：

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

這種方法的優(yōu)點是不需要獲取堆棧跟蹤信息，而且不會創(chuàng)建異常對象，因此性能和可讀性都較好。缺點是需要創(chuàng)建額外的對象，而且代碼較為復(fù)雜，不太直觀。

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

這種方法是通過創(chuàng)建一個匿名內(nèi)部類的對象，然后從其類對象中獲取當(dāng)前方法的方法對象，再從方法對象中獲取當(dāng)前方法名和參數(shù)的。具體的代碼如下：

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

這種方法的優(yōu)點是不需要獲取堆棧跟蹤信息，而且不會創(chuàng)建異常對象，因此性能和可讀性都較好。缺點是需要創(chuàng)建額外的對象，而且代碼較為復(fù)雜，不太直觀。

4.Java 9 的 Stack-Walking API

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

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

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

• walk() 方法可以將堆棧幀轉(zhuǎn)化為 Stream<StackFrame> 流
• findFirst() 方法從 Stream 流中的獲取第一個元素，也就是堆棧的頂部幀，頂部幀就代表當(dāng)前正在執(zhí)行的方法
• map() 方法用于獲取頂部幀 StackFrame 的當(dāng)前方法名稱

Stack-Walking API 的優(yōu)點

與以上方法相比，Stack-Walking API 有很多優(yōu)點：

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

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

經(jīng)典例子：Logback

Logback 是一個流行的 Java 日志框架，它是 Log4j 的繼承者，由 Log4j 的創(chuàng)始人設(shè)計。Logback 有以下特點：

• 高性能：Logback 比其他日志框架更快，更節(jié)省空間，有時甚至大得多。
• 靈活配置：Logback 支持 XML 和 Groovy 兩種配置方式，可以實現(xiàn)動態(tài)修改配置，無需重啟應(yīng)用。
• 豐富功能：Logback 提供了多種輸出目標(biāo)，如控制臺、文件、數(shù)據(jù)庫、郵件等，還支持滾動策略、過濾器、異步日志等高級功能。
• 與 SLF4J 集成：Logback 是 SLF4J 的原生實現(xiàn)，可以與其他基于 SLF4J 的日志框架無縫切換。

不知道大家有沒有想過，我們在使用 Logback 日志框架中打印日志時，是如何獲取當(dāng)前執(zhí)行方法體的方法名稱的嘞？在 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 默認(rèn)配置為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 占位符替換為當(dāng)前方法名稱。

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

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

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

方法邏輯如下，

• StackTraceElement[] cda = le.getCallerData() 獲取當(dāng)前堆棧頂部幀
• cda[0].getMethodName() 根據(jù)頂部幀獲取當(dāng)前方法名稱。

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

進(jìn)入 LoggingEvent 源碼類中，我們可以發(fā)現(xiàn)堆棧獲取邏輯，源碼如下，

public class LoggingEvent implements ILoggingEvent {
    public StackTraceElement[] getCallerData() {
        if (callerDataArray == null) {
            // 堆棧初始化
            callerDataArray = CallerData.extract(new Throwable(), fqnOfLoggerClass,
                    loggerContext.getMaxCallerDataDepth(), loggerContext.getFrameworkPackages());
        }
        return callerDataArray;
    }
    ...
}

• 如果當(dāng)前堆棧為空，進(jìn)行堆棧信息初始化。這里就可以看到堆棧信息初始化來自 CallerData.extract(new Throwable(), fqnOfLoggerClass,loggerContext.getMaxCallerDataDepth(), loggerContext.getFrameworkPackages()) 方法。
• 如果堆棧信息不為空，直接返回當(dāng)前堆棧。這里是為了避免浪費，針對在一個方法中重復(fù)獲取堆棧信息的情況。

Ok，到這里離勝利就只差一步了。進(jìn)一步查看 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() 方法所體現(xiàn)的。

那么到這里我就可以下一個結(jié)論了， Logback 日志框架中打印日志時，就是使用異常對象的 getStackTrace() 方法來獲取當(dāng)前執(zhí)行方法的方法名稱的。

總結(jié)

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

以上就是Java面試Logback打印日志如何獲取當(dāng)前方法名稱題解的詳細(xì)內(nèi)容，更多關(guān)于Java Logback獲取打印日志方法名的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論