如何获取当前执行方法的名称？

1. 概述

有时我们需要知道当前正在执行的 Java 方法名称。本文将介绍几种简单粗暴的方式，在当前执行堆栈中获取方法名。

2. Java 9 的堆栈遍历 API

Java 9 引入了堆栈遍历 API 以懒加载方式高效遍历 JVM 堆栈帧。使用该 API 获取当前执行方法的示例代码：

public void givenJava9_whenWalkingTheStack_thenFindMethod() {
    StackWalker walker = StackWalker.getInstance();
    Optional<String> methodName = walker.walk(frames -> frames
      .findFirst()
      .map(StackWalker.StackFrame::getMethodName));

    assertTrue(methodName.isPresent());
    assertEquals("givenJava9_whenWalkingTheStack_thenFindMethod", methodName.get());
}

首先通过 getInstance() 获取 StackWalker 实例，然后使用 walk() 方法从堆栈顶部到底部遍历帧：

walk() 将堆栈帧流（Stream<StackFrame>）转换为任意类型
流中第一个元素是堆栈顶帧
顶帧始终代表当前执行方法

因此获取流首元素即可得到当前方法详情，通过 StackFrame.getMethodName() 提取方法名。

2.1. 优势

相比其他方案（下文详述），堆栈遍历 API 的优势明显：

✅ 无需创建匿名内部类（如 new Object().getClass() {}）
✅ 无需创建异常对象（如 new Throwable()）
✅ 避免全量堆栈捕获开销，仅按需获取帧

StackWalker 采用懒加载方式逐帧遍历，本例仅获取顶帧，而异常方案会立即捕获所有帧。⚠️ Java 9+ 环境下应优先使用此方案。

3. 使用 getEnclosingMethod

通过 getEnclosingMethod() 获取方法名的示例：

public void givenObject_whenGetEnclosingMethod_thenFindMethod() {
    String methodName = new Object() {}
      .getClass()
      .getEnclosingMethod()
      .getName();
       
    assertEquals("givenObject_whenGetEnclosingMethod_thenFindMethod",
      methodName);
}

⚠️ 此方法需创建匿名内部类实例，存在额外对象分配开销。

4. 使用 Throwable 堆栈跟踪

通过异常堆栈获取当前方法：

public void givenThrowable_whenGetStacktrace_thenFindMethod() {
    StackTraceElement[] stackTrace = new Throwable().getStackTrace();
 
    assertEquals(
      "givenThrowable_whenGetStacktrace_thenFindMethod",
      stackTrace[0].getMethodName());
}

❌ 需创建异常对象，且立即捕获完整堆栈，性能较差。

5. 使用线程堆栈跟踪

通过当前线程堆栈获取方法名（JDK 1.5+）：

public void givenCurrentThread_whenGetStackTrace_thenFindMethod() {
    StackTraceElement[] stackTrace = Thread.currentThread()
      .getStackTrace();
 
    assertEquals(
      "givenCurrentThread_whenGetStackTrace_thenFindMethod",
      stackTrace[1].getMethodName()); 
}

⚠️ 需注意索引位置：stackTrace[0] 是 getStackTrace() 方法本身，stackTrace[1] 才是目标方法。
⚠️ 部分虚拟机可能跳过堆栈帧（罕见但存在），导致索引不稳定。

6. 总结

获取当前执行方法名的方案对比：

方案	适用版本	性能	稳定性	代码复杂度
StackWalker API	Java 9+	⭐⭐⭐	⭐⭐⭐	中等
getEnclosingMethod	Java 5+	⭐⭐	⭐⭐⭐	简单
Throwable 堆栈	Java 1+	⭐	⭐⭐⭐	简单
Thread 堆栈	Java 5+	⭐	⭐⭐	简单

推荐选择：

✅ Java 9+ 环境：StackWalker API（性能最优）
✅ 兼容旧版本：getEnclosingMethod（稳定且开销可控）

所有示例代码见 GitHub 仓库，Java 9 示例在 Java 9 模块中。

Persistence

REST

Security