C'è un modo per ottenere il nome del metodo attualmente in esecuzione in Java?
C'è un modo per ottenere il nome del metodo attualmente in esecuzione in Java?
Risposte:
Thread.currentThread().getStackTrace()
di solito conterrà il metodo da cui lo chiami ma ci sono insidie (vedi Javadoc ):
Alcune macchine virtuali possono, in alcune circostanze, omettere uno o più frame di stack dalla traccia dello stack. In casi estremi, una macchina virtuale che non ha informazioni di traccia stack relative a questo thread è autorizzata a restituire un array di lunghezza zero da questo metodo.
Tecnicamente questo funzionerà ...
String name = new Object(){}.getClass().getEnclosingMethod().getName();
Tuttavia, durante la compilazione (ad es YourClass$1.class
.) Verrà creata una nuova classe interna anonima . Quindi questo creerà un .class
file per ogni metodo che distribuisce questo trucco. Inoltre, viene creata un'istanza di oggetto altrimenti inutilizzata su ogni invocazione durante il runtime. Quindi questo può essere un trucco di debug accettabile, ma comporta un notevole sovraccarico.
Un vantaggio di questo trucco è che getEncosingMethod()
restituisce java.lang.reflect.Method
che può essere utilizzato per recuperare tutte le altre informazioni del metodo, comprese annotazioni e nomi dei parametri. Ciò consente di distinguere tra metodi specifici con lo stesso nome (metodo overload).
Si noti che, secondo JavaDoc, getEnclosingMethod()
questo trucco non dovrebbe essere lanciato SecurityException
poiché le classi interne dovrebbero essere caricate usando lo stesso caricatore di classi. Quindi non è necessario controllare le condizioni di accesso anche se è presente un gestore della sicurezza.
È necessario utilizzare getEnclosingConstructor()
per i costruttori. Durante i blocchi al di fuori dei metodi (nominati), getEnclosingMethod()
restituisce null
.
getEnclosingMethod
ottiene il nome del metodo in cui è definita la classe. this.getClass()
non ti aiuterà affatto. @wutzebaer perché dovresti averne bisogno? Hai già accesso a loro.
Gennaio 2009:
sarebbe un codice completo (da usare tenendo presente l'avvertenza di @ Bombe ):
/**
* Get the method name for a depth in call stack. <br />
* Utility function
* @param depth depth in the call stack (0 means current method, 1 means call method, ...)
* @return method name
*/
public static String getMethodName(final int depth)
{
final StackTraceElement[] ste = Thread.currentThread().getStackTrace();
//System. out.println(ste[ste.length-depth].getClassName()+"#"+ste[ste.length-depth].getMethodName());
// return ste[ste.length - depth].getMethodName(); //Wrong, fails for depth = 0
return ste[ste.length - 1 - depth].getMethodName(); //Thank you Tom Tresansky
}
Altro in questa domanda .
Aggiornamento dicembre 2011:
commenti bluastri :
Uso JRE 6 e mi dà un nome metodo errato.
Funziona se scrivoste[2 + depth].getMethodName().
0
ègetStackTrace()
,1
ègetMethodName(int depth)
e2
sta invocando il metodo.
virgo47 's risposta (upvoted) in realtà calcola l'indice di diritto di applicare al fine di recuperare il nome del metodo.
StackTraceElement
array a scopo di debug e vedere se 'main' è effettivamente il metodo giusto?
ste[2 + depth].getMethodName()
. 0 è getStackTrace()
, 1 è getMethodName(int depth)
e 2 sta invocando il metodo. Vedi anche la risposta di @ virgo47 .
Abbiamo usato questo codice per mitigare la potenziale variabilità nell'indice di traccia dello stack - ora basta chiamare methodName util:
public class MethodNameTest {
private static final int CLIENT_CODE_STACK_INDEX;
static {
// Finds out the index of "this code" in the returned stack trace - funny but it differs in JDK 1.5 and 1.6
int i = 0;
for (StackTraceElement ste : Thread.currentThread().getStackTrace()) {
i++;
if (ste.getClassName().equals(MethodNameTest.class.getName())) {
break;
}
}
CLIENT_CODE_STACK_INDEX = i;
}
public static void main(String[] args) {
System.out.println("methodName() = " + methodName());
System.out.println("CLIENT_CODE_STACK_INDEX = " + CLIENT_CODE_STACK_INDEX);
}
public static String methodName() {
return Thread.currentThread().getStackTrace()[CLIENT_CODE_STACK_INDEX].getMethodName();
}
}
Sembra troppo ingegnerizzato, ma avevamo un numero fisso per JDK 1.5 e siamo rimasti un po 'sorpresi che sia cambiato quando siamo passati a JDK 1.6. Ora è lo stesso in Java 6/7, ma non lo sai mai. Non è una prova delle modifiche apportate a quell'indice durante il runtime, ma si spera che HotSpot non faccia così male. :-)
public class SomeClass {
public void foo(){
class Local {};
String name = Local.class.getEnclosingMethod().getName();
}
}
il nome avrà valore foo.
null
Entrambe queste opzioni funzionano per me con Java:
new Object(){}.getClass().getEnclosingMethod().getName()
O:
Thread.currentThread().getStackTrace()[1].getMethodName()
Il modo più veloce che ho trovato è che:
import java.lang.reflect.Method;
public class TraceHelper {
// save it static to have it available on every call
private static Method m;
static {
try {
m = Throwable.class.getDeclaredMethod("getStackTraceElement",
int.class);
m.setAccessible(true);
} catch (Exception e) {
e.printStackTrace();
}
}
public static String getMethodName(final int depth) {
try {
StackTraceElement element = (StackTraceElement) m.invoke(
new Throwable(), depth + 1);
return element.getMethodName();
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
}
Accede direttamente al metodo nativo getStackTraceElement (int depth). E memorizza il metodo accessibile in una variabile statica.
new Throwable().getStackTrace()
ha richiesto 5614ms.
Usa il seguente codice:
StackTraceElement[] stacktrace = Thread.currentThread().getStackTrace();
StackTraceElement e = stacktrace[1];//coz 0th will be getStackTrace so 1st
String methodName = e.getMethodName();
System.out.println(methodName);
public static String getCurrentMethodName() {
return Thread.currentThread().getStackTrace()[2].getClassName() + "." + Thread.currentThread().getStackTrace()[2].getMethodName();
}
Questa è un'espansione della risposta di virgo47 (sopra).
Fornisce alcuni metodi statici per ottenere i nomi di classe / metodo correnti e invocanti.
/* Utility class: Getting the name of the current executing method
* /programming/442747/getting-the-name-of-the-current-executing-method
*
* Provides:
*
* getCurrentClassName()
* getCurrentMethodName()
* getCurrentFileName()
*
* getInvokingClassName()
* getInvokingMethodName()
* getInvokingFileName()
*
* Nb. Using StackTrace's to get this info is expensive. There are more optimised ways to obtain
* method names. See other stackoverflow posts eg. /programming/421280/in-java-how-do-i-find-the-caller-of-a-method-using-stacktrace-or-reflection/2924426#2924426
*
* 29/09/2012 (lem) - added methods to return (1) fully qualified names and (2) invoking class/method names
*/
package com.stackoverflow.util;
public class StackTraceInfo
{
/* (Lifted from virgo47's stackoverflow answer) */
private static final int CLIENT_CODE_STACK_INDEX;
static {
// Finds out the index of "this code" in the returned stack trace - funny but it differs in JDK 1.5 and 1.6
int i = 0;
for (StackTraceElement ste: Thread.currentThread().getStackTrace())
{
i++;
if (ste.getClassName().equals(StackTraceInfo.class.getName()))
{
break;
}
}
CLIENT_CODE_STACK_INDEX = i;
}
public static String getCurrentMethodName()
{
return getCurrentMethodName(1); // making additional overloaded method call requires +1 offset
}
private static String getCurrentMethodName(int offset)
{
return Thread.currentThread().getStackTrace()[CLIENT_CODE_STACK_INDEX + offset].getMethodName();
}
public static String getCurrentClassName()
{
return getCurrentClassName(1); // making additional overloaded method call requires +1 offset
}
private static String getCurrentClassName(int offset)
{
return Thread.currentThread().getStackTrace()[CLIENT_CODE_STACK_INDEX + offset].getClassName();
}
public static String getCurrentFileName()
{
return getCurrentFileName(1); // making additional overloaded method call requires +1 offset
}
private static String getCurrentFileName(int offset)
{
String filename = Thread.currentThread().getStackTrace()[CLIENT_CODE_STACK_INDEX + offset].getFileName();
int lineNumber = Thread.currentThread().getStackTrace()[CLIENT_CODE_STACK_INDEX + offset].getLineNumber();
return filename + ":" + lineNumber;
}
public static String getInvokingMethodName()
{
return getInvokingMethodName(2);
}
private static String getInvokingMethodName(int offset)
{
return getCurrentMethodName(offset + 1); // re-uses getCurrentMethodName() with desired index
}
public static String getInvokingClassName()
{
return getInvokingClassName(2);
}
private static String getInvokingClassName(int offset)
{
return getCurrentClassName(offset + 1); // re-uses getCurrentClassName() with desired index
}
public static String getInvokingFileName()
{
return getInvokingFileName(2);
}
private static String getInvokingFileName(int offset)
{
return getCurrentFileName(offset + 1); // re-uses getCurrentFileName() with desired index
}
public static String getCurrentMethodNameFqn()
{
return getCurrentMethodNameFqn(1);
}
private static String getCurrentMethodNameFqn(int offset)
{
String currentClassName = getCurrentClassName(offset + 1);
String currentMethodName = getCurrentMethodName(offset + 1);
return currentClassName + "." + currentMethodName ;
}
public static String getCurrentFileNameFqn()
{
String CurrentMethodNameFqn = getCurrentMethodNameFqn(1);
String currentFileName = getCurrentFileName(1);
return CurrentMethodNameFqn + "(" + currentFileName + ")";
}
public static String getInvokingMethodNameFqn()
{
return getInvokingMethodNameFqn(2);
}
private static String getInvokingMethodNameFqn(int offset)
{
String invokingClassName = getInvokingClassName(offset + 1);
String invokingMethodName = getInvokingMethodName(offset + 1);
return invokingClassName + "." + invokingMethodName;
}
public static String getInvokingFileNameFqn()
{
String invokingMethodNameFqn = getInvokingMethodNameFqn(2);
String invokingFileName = getInvokingFileName(2);
return invokingMethodNameFqn + "(" + invokingFileName + ")";
}
}
Per ottenere il nome del metodo che ha chiamato il metodo corrente è possibile utilizzare:
new Exception("is not thrown").getStackTrace()[1].getMethodName()
Funziona sul mio MacBook e sul mio telefono Android
Ho anche provato:
Thread.currentThread().getStackTrace()[1]
ma Android restituirà "getStackTrace" che potrei risolvere con Android
Thread.currentThread().getStackTrace()[2]
ma poi ricevo la risposta sbagliata sul mio MacBook
getStackTrace()[0]
piuttosto che getStackTrace()[1]
. YMMV.
Thread.currentThread().getStackTrace()[2]
Util.java:
public static String getCurrentClassAndMethodNames() {
final StackTraceElement e = Thread.currentThread().getStackTrace()[2];
final String s = e.getClassName();
return s.substring(s.lastIndexOf('.') + 1, s.length()) + "." + e.getMethodName();
}
SomeClass.java:
public class SomeClass {
public static void main(String[] args) {
System.out.println(Util.getCurrentClassAndMethodNames()); // output: SomeClass.main
}
}
final StackTraceElement e = Thread.currentThread().getStackTrace()[2];
lavori; e.getClassName();
restituisce il nome completo della classe e e.getMethodName()
restituisce il nome del methon.
getStackTrace()[2]
è sbagliato, deve essere getStackTrace()[3]
perché: [0] dalvik.system.VMStack.getThreadStackTrace [1] java.lang.Thread.getStackTrace [2] Utils.getCurrentClassAndMethodNames [3] La funzione a () che chiama questo
Questo può essere fatto usando StackWalker
da Java 9.
public static String getCurrentMethodName() {
return StackWalker.getInstance()
.walk(s -> s.skip(1).findFirst())
.get()
.getMethodName();
}
public static String getCallerMethodName() {
return StackWalker.getInstance()
.walk(s -> s.skip(2).findFirst())
.get()
.getMethodName();
}
StackWalker
è progettato per essere pigro, quindi è probabile che sia più efficiente di, diciamo, Thread.getStackTrace
che crea avidamente un array per l'intero callstack. Vedere anche il JEP per ulteriori informazioni.
Un metodo alternativo è quello di creare, ma non generare, un'eccezione e utilizzare quell'oggetto da cui ottenere i dati di traccia dello stack, poiché il metodo che la racchiude sarà in genere all'indice 0, purché la JVM memorizzi tali informazioni, come altri hanno sopra menzionato. Questo non è il metodo più economico, tuttavia.
Da Throwable.getStackTrace () (questo è stato lo stesso almeno da Java 5):
L'elemento zeroth dell'array (supponendo che la lunghezza dell'array sia diverso da zero) rappresenta la parte superiore dello stack, che è l'ultima chiamata del metodo nella sequenza. In genere , questo è il punto in cui questo lancio è stato creato e lanciato.
Lo snippet di seguito presuppone che la classe sia non statica (a causa di getClass ()), ma questo è un lato.
System.out.printf("Class %s.%s\n", getClass().getName(), new Exception("is not thrown").getStackTrace()[0].getMethodName());
String methodName =Thread.currentThread().getStackTrace()[1].getMethodName();
System.out.println("methodName = " + methodName);
Ho una soluzione usando questo (in Android)
/**
* @param className fully qualified className
* <br/>
* <code>YourClassName.class.getName();</code>
* <br/><br/>
* @param classSimpleName simpleClassName
* <br/>
* <code>YourClassName.class.getSimpleName();</code>
* <br/><br/>
*/
public static void getStackTrace(final String className, final String classSimpleName) {
final StackTraceElement[] steArray = Thread.currentThread().getStackTrace();
int index = 0;
for (StackTraceElement ste : steArray) {
if (ste.getClassName().equals(className)) {
break;
}
index++;
}
if (index >= steArray.length) {
// Little Hacky
Log.w(classSimpleName, Arrays.toString(new String[]{steArray[3].getMethodName(), String.valueOf(steArray[3].getLineNumber())}));
} else {
// Legitimate
Log.w(classSimpleName, Arrays.toString(new String[]{steArray[index].getMethodName(), String.valueOf(steArray[index].getLineNumber())}));
}
}
Non so quale sia l'intenzione dietro a ottenere il nome del metodo attualmente eseguito, ma se è solo a scopo di debug, i framework di registrazione come "logback" possono aiutare qui. Ad esempio, nel logback, è sufficiente utilizzare il modello "% M" nella configurazione della registrazione . Tuttavia, questo dovrebbe essere usato con cautela in quanto ciò potrebbe degradare le prestazioni.
Nel caso in cui il metodo che si desidera conoscere sia un metodo di test junit, è possibile utilizzare la regola junit TestName: https://stackoverflow.com/a/1426730/3076107
La maggior parte delle risposte qui sembra sbagliata.
public static String getCurrentMethod() {
return getCurrentMethod(1);
}
public static String getCurrentMethod(int skip) {
return Thread.currentThread().getStackTrace()[1 + 1 + skip].getMethodName();
}
Esempio:
public static void main(String[] args) {
aaa();
}
public static void aaa() {
System.out.println("aaa -> " + getCurrentMethod( ) );
System.out.println("aaa -> " + getCurrentMethod(0) );
System.out.println("main -> " + getCurrentMethod(1) );
}
Uscite:
aaa -> aaa
aaa -> aaa
main -> main
Ho riscritto un po ' la risposta del maklemenz :
private static Method m;
static {
try {
m = Throwable.class.getDeclaredMethod(
"getStackTraceElement",
int.class
);
}
catch (final NoSuchMethodException e) {
throw new NoSuchMethodUncheckedException(e);
}
catch (final SecurityException e) {
throw new SecurityUncheckedException(e);
}
}
public static String getMethodName(int depth) {
StackTraceElement element;
final boolean accessible = m.isAccessible();
m.setAccessible(true);
try {
element = (StackTraceElement) m.invoke(new Throwable(), 1 + depth);
}
catch (final IllegalAccessException e) {
throw new IllegalAccessUncheckedException(e);
}
catch (final InvocationTargetException e) {
throw new InvocationTargetUncheckedException(e);
}
finally {
m.setAccessible(accessible);
}
return element.getMethodName();
}
public static String getMethodName() {
return getMethodName(1);
}
MethodHandles.lookup().lookupClass().getEnclosingMethod().getName();
getEnclosingMethod()
lancia una NullPointerException
per me in Java 7.
Cosa c'è di sbagliato in questo approccio:
class Example {
FileOutputStream fileOutputStream;
public Example() {
//System.out.println("Example.Example()");
debug("Example.Example()",false); // toggle
try {
fileOutputStream = new FileOutputStream("debug.txt");
} catch (Exception exception) {
debug(exception + Calendar.getInstance().getTime());
}
}
private boolean was911AnInsideJob() {
System.out.println("Example.was911AnInsideJob()");
return true;
}
public boolean shouldGWBushBeImpeached(){
System.out.println("Example.shouldGWBushBeImpeached()");
return true;
}
public void setPunishment(int yearsInJail){
debug("Server.setPunishment(int yearsInJail=" + yearsInJail + ")",true);
}
}
E prima che le persone impazziscano nell'usare System.out.println(...)
te, potresti sempre e dovresti creare un metodo in modo che l'output possa essere reindirizzato, ad esempio:
private void debug (Object object) {
debug(object,true);
}
private void dedub(Object object, boolean debug) {
if (debug) {
System.out.println(object);
// you can also write to a file but make sure the output stream
// ISN'T opened every time debug(Object object) is called
fileOutputStream.write(object.toString().getBytes());
}
}