Java獲取調用當前方法的類名或方法名(棧堆信息)的四種方式舉例

更新時間：2024年09月01日 09:18:46 作者：星月昭銘

在Java編程中我們經常需要在運行時獲取當前執(zhí)行的方法名稱,這在日志記錄、性能監(jiān)控、調試等方面非常有用,這篇文章主要給大家介紹了關于Java獲取調用當前方法的類名或方法名(棧堆信息)的四種方式,需要的朋友可以參考下

前言

在java代碼中，是可以在運行時通過某種方式獲取到當前方法被誰調用了（調用鏈路）。目前我所知道的有四種方式（通過Thread、Throwable、SecurityManager獲?。旅嬷饌€列出，附有代碼和截圖。

Thread.getAllStackTraces()方式

Thread.getAllStackTraces()可以獲取所有線程的棧堆跟蹤信息，返回值是Map<Thread, StackTraceElement[]>類型，可以通過Thread.currentThread()拿到當前Thread對象，從map集合中獲取棧堆跟蹤信息。StackTraceElement對象可以拿到調用者的類名、Class對象、調用的代碼所在行數等。

代碼如下：

public class A {
    public static void main(String[] args) {
        B.print();
    }
}

class B {
    public static void print() {
        System.out.println("調用B#print");
        C.print();
    }
}

class C {
    public static void print() {
        System.out.println("調用C#print");
        // 獲取所有線程的棧堆跟蹤集合
        Map<Thread, StackTraceElement[]> allStackTraces = Thread.getAllStackTraces();
        // 去map集合里面拿當前線程的棧堆跟蹤信息數組
        StackTraceElement[] stackTraceElements = allStackTraces.get(Thread.currentThread());
        System.out.println(Arrays.toString(stackTraceElements));
    }
}

可以看到，下標為4的StackTraceElement對象就是我們的main方法，之所以出現了下標0、1非自定義類的棧堆信息是因為調用了Thread.getAllStackTraces()方法，方法以及方法內部也執(zhí)行了其他代碼。

Thread.currentThread().getStackTrace()方式

通過Thread.currentThread()拿到當前的線程，再通過Thread對象的getStackTrace()方法獲取線程的棧堆跟蹤信息，getStackTrace()非static方法，所以要先拿到Thread對象。第一種和第二種方式實際上都是調用了private native static StackTraceElement[][] dumpThreads(Thread[] threads)本地方法來獲取。這兩種方式獲取的話，棧堆跟蹤信息數組里面都有非自定義類的調用信息（看下標0）。

代碼如下：

public class A {
    public static void main(String[] args) {
        B.print();
        System.out.println(Arrays.toString(Thread.currentThread().getStackTrace()));
    }
}

class B {
    public static void print() {
        System.out.println("調用B#print");
        C.print();
    }
}

class C {
    public static void print() {
        // 獲取當前線程，再獲取棧堆跟蹤數組
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        System.out.println(Arrays.toString(stackTrace));
    }
}

new RuntimeException().getStackTrace()方式

實際上，只要是Throwable的子類包括他自身都可以，內部也是調用了一個本地方法來獲取的棧堆信息。SpringApplication類中的deduceMainApplicationClass()方法就是通過這種方式來拿主類的Class對象。拿到了之后就可以通過for循環(huán)整個數組通過匹配方法名或者類型來拿想要信息了，或者直接通過整個數組拿到整個調用鏈路。

代碼如下：

public class A {
    public static void main(String[] args) {
        B.print();
    }
}

class B {
    public static void print() {
        System.out.println("調用B#print");
        C.print();
    }
}

class C {
    public static void print() {
        StackTraceElement[] stackTrace = new RuntimeException().getStackTrace();
        System.out.println(Arrays.toString(stackTrace));
    }
}

SecurityManager方式（這種可以拿到類信息，但是拿不到棧堆信息）

SecurityManager中有一個getClassContext()方法，這個方法可以獲取到調用當前方法的Class信息，返回的類型是一個Class數組，和前面幾種不同的是，這種方式沒法獲取代碼行數、調用的方法等（Class對象大家應該很熟悉了，能拿到哪種信息應該都知道）。

由于getClassContext方法是非static的，所以要通過對象的方式調用，但是不能通過new SecurityManager()的對象來獲取，因為這個方法是一個protected方法。protected native Class[] getClassContext()。所以需要自定義一個類，繼承SecurityManager類，然后重寫getClassContext方法，這樣我們就能在這個類中使用這個方法了。

這種方式在slf4j中Util#getCallingClass()用到了

代碼如下：

public class A {
    public static void main(String[] args) {
        B.print();
    }
}

class B {
    public static void print() {
        System.out.println("調用B#print");
        C.print();
    }
}

class C {

    public static void print() {
        // 獲取一個安全管理器對象
        ClassContextSecurityManager securityManager = getSecurityManager();
        if (securityManager != null) {
            System.out.println(Arrays.toString(securityManager.getClassContext()));
        }
    }

    static ClassContextSecurityManager getSecurityManager() {
        try {
            return new ClassContextSecurityManager();
        } catch (Throwable throwable) {
            return null;
        }
    }

    /**
     * 自定義的安全管理器，繼承java.lang.SecurityManager類
     */
    private static final class ClassContextSecurityManager extends SecurityManager {
    	/**
    	 * 重寫getClassContext方法，不然方法在SecurityManager中又被protected修飾，其他類還是調用不了
    	 */
    	@Override
        protected Class<?>[] getClassContext() {
            return super.getClassContext();
        }
    }
}