快捷導(dǎo)航

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

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

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

前言

在java代碼中，是可以在運(yùn)行時(shí)通過(guò)某種方式獲取到當(dāng)前方法被誰(shuí)調(diào)用了（調(diào)用鏈路）。目前我所知道的有四種方式（通過(guò)Thread、Throwable、SecurityManager獲?。?，下面逐個(gè)列出，附有代碼和截圖。

Thread.getAllStackTraces()方式

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

代碼如下：

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

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

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

可以看到，下標(biāo)為4的StackTraceElement對(duì)象就是我們的main方法，之所以出現(xiàn)了下標(biāo)0、1非自定義類的棧堆信息是因?yàn)檎{(diào)用了Thread.getAllStackTraces()方法，方法以及方法內(nèi)部也執(zhí)行了其他代碼。

Thread.currentThread().getStackTrace()方式

通過(guò)Thread.currentThread()拿到當(dāng)前的線程，再通過(guò)Thread對(duì)象的getStackTrace()方法獲取線程的棧堆跟蹤信息，getStackTrace()非static方法，所以要先拿到Thread對(duì)象。第一種和第二種方式實(shí)際上都是調(diào)用了private native static StackTraceElement[][] dumpThreads(Thread[] threads)本地方法來(lái)獲取。這兩種方式獲取的話，棧堆跟蹤信息數(shù)組里面都有非自定義類的調(diào)用信息（看下標(biāo)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("調(diào)用B#print");
        C.print();
    }
}

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

new RuntimeException().getStackTrace()方式

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

代碼如下：

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

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

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

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

SecurityManager中有一個(gè)getClassContext()方法，這個(gè)方法可以獲取到調(diào)用當(dāng)前方法的Class信息，返回的類型是一個(gè)Class數(shù)組，和前面幾種不同的是，這種方式?jīng)]法獲取代碼行數(shù)、調(diào)用的方法等（Class對(duì)象大家應(yīng)該很熟悉了，能拿到哪種信息應(yīng)該都知道）。

由于getClassContext方法是非static的，所以要通過(guò)對(duì)象的方式調(diào)用，但是不能通過(guò)new SecurityManager()的對(duì)象來(lái)獲取，因?yàn)檫@個(gè)方法是一個(gè)protected方法。protected native Class[] getClassContext()。所以需要自定義一個(gè)類，繼承SecurityManager類，然后重寫(xiě)getClassContext方法，這樣我們就能在這個(gè)類中使用這個(gè)方法了。

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

代碼如下：

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

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

class C {

    public static void print() {
        // 獲取一個(gè)安全管理器對(duì)象
        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 {
    	/**
    	 * 重寫(xiě)getClassContext方法，不然方法在SecurityManager中又被protected修飾，其他類還是調(diào)用不了
    	 */
    	@Override
        protected Class<?>[] getClassContext() {
            return super.getClassContext();
        }
    }
}

總結(jié)

到此這篇關(guān)于Java獲取調(diào)用當(dāng)前方法的類名或方法名(棧堆信息)的四種方式的文章就介紹到這了,更多相關(guān)Java獲取調(diào)用當(dāng)前方法類名或方法名內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: