Ich muss den Aufrufer einer Methode finden. Ist es möglich, Stacktrace oder Reflection zu verwenden?
DontNameYourMethodFooException
wenn die aufrufende Methode foo heißt.
Ich muss den Aufrufer einer Methode finden. Ist es möglich, Stacktrace oder Reflection zu verwenden?
DontNameYourMethodFooException
wenn die aufrufende Methode foo heißt.
Antworten:
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace()
Nach Angaben der Javadocs:
Das letzte Element des Arrays stellt den unteren Rand des Stapels dar. Dies ist der am wenigsten aktuelle Methodenaufruf in der Sequenz.
A StackTraceElement
hat getClassName()
, getFileName()
, getLineNumber()
und getMethodName()
.
Sie müssen experimentieren, um festzustellen, welchen Index Sie möchten (wahrscheinlich stackTraceElements[1]
oder [2]
).
Eine alternative Lösung finden Sie in einem Kommentar zu dieser Verbesserungsanforderung . Es verwendet die getClassContext()
Methode eines benutzerdefinierten SecurityManager
und scheint schneller als die Stack-Trace-Methode zu sein.
Das folgende Programm testet die Geschwindigkeit der verschiedenen vorgeschlagenen Methoden (das interessanteste Bit ist in der inneren Klasse SecurityManagerMethod
):
/**
* Test the speed of various methods for getting the caller class name
*/
public class TestGetCallerClassName {
/**
* Abstract class for testing different methods of getting the caller class name
*/
private static abstract class GetCallerClassNameMethod {
public abstract String getCallerClassName(int callStackDepth);
public abstract String getMethodName();
}
/**
* Uses the internal Reflection class
*/
private static class ReflectionMethod extends GetCallerClassNameMethod {
public String getCallerClassName(int callStackDepth) {
return sun.reflect.Reflection.getCallerClass(callStackDepth).getName();
}
public String getMethodName() {
return "Reflection";
}
}
/**
* Get a stack trace from the current thread
*/
private static class ThreadStackTraceMethod extends GetCallerClassNameMethod {
public String getCallerClassName(int callStackDepth) {
return Thread.currentThread().getStackTrace()[callStackDepth].getClassName();
}
public String getMethodName() {
return "Current Thread StackTrace";
}
}
/**
* Get a stack trace from a new Throwable
*/
private static class ThrowableStackTraceMethod extends GetCallerClassNameMethod {
public String getCallerClassName(int callStackDepth) {
return new Throwable().getStackTrace()[callStackDepth].getClassName();
}
public String getMethodName() {
return "Throwable StackTrace";
}
}
/**
* Use the SecurityManager.getClassContext()
*/
private static class SecurityManagerMethod extends GetCallerClassNameMethod {
public String getCallerClassName(int callStackDepth) {
return mySecurityManager.getCallerClassName(callStackDepth);
}
public String getMethodName() {
return "SecurityManager";
}
/**
* A custom security manager that exposes the getClassContext() information
*/
static class MySecurityManager extends SecurityManager {
public String getCallerClassName(int callStackDepth) {
return getClassContext()[callStackDepth].getName();
}
}
private final static MySecurityManager mySecurityManager =
new MySecurityManager();
}
/**
* Test all four methods
*/
public static void main(String[] args) {
testMethod(new ReflectionMethod());
testMethod(new ThreadStackTraceMethod());
testMethod(new ThrowableStackTraceMethod());
testMethod(new SecurityManagerMethod());
}
private static void testMethod(GetCallerClassNameMethod method) {
long startTime = System.nanoTime();
String className = null;
for (int i = 0; i < 1000000; i++) {
className = method.getCallerClassName(2);
}
printElapsedTime(method.getMethodName(), startTime);
}
private static void printElapsedTime(String title, long startTime) {
System.out.println(title + ": " + ((double)(System.nanoTime() - startTime))/1000000 + " ms.");
}
}
Ein Beispiel für die Ausgabe meines Intel Core 2 Duo MacBook mit 2,4 GHz und Java 1.6.0_17:
Reflection: 10.195 ms.
Current Thread StackTrace: 5886.964 ms.
Throwable StackTrace: 4700.073 ms.
SecurityManager: 1046.804 ms.
Die interne Reflexionsmethode ist viel schneller als die anderen. Das Abrufen eines Stack-Trace von einem neu erstellten Throwable
ist schneller als das Abrufen vom aktuellen Thread
. Und unter den nicht internen Methoden zum Auffinden der Anruferklasse SecurityManager
scheint der Brauch der schnellste zu sein.
Wie lyomi in diesem Kommentar hervorhebt , wurde die sun.reflect.Reflection.getCallerClass()
Methode in Java 7 Update 40 standardmäßig deaktiviert und in Java 8 vollständig entfernt. Weitere Informationen hierzu finden Sie in dieser Ausgabe in der Java-Fehlerdatenbank .
Wie zammbi herausgefunden hat, war Oracle gezwungen, sich von der Änderung zurückzuziehen, durch die das entfernt wurde sun.reflect.Reflection.getCallerClass()
. Es ist weiterhin in Java 8 verfügbar (aber veraltet).
3 Jahre danach: Update zum Timing mit der aktuellen JVM.
> java -version
java version "1.8.0"
Java(TM) SE Runtime Environment (build 1.8.0-b132)
Java HotSpot(TM) 64-Bit Server VM (build 25.0-b70, mixed mode)
> java TestGetCallerClassName
Reflection: 0.194s.
Current Thread StackTrace: 3.887s.
Throwable StackTrace: 3.173s.
SecurityManager: 0.565s.
Klingt so, als würden Sie vermeiden, einen Verweis auf this
die Methode zu übergeben. Das Übergeben this
ist viel besser als das Auffinden des Anrufers über die aktuelle Stapelverfolgung. Das Refactoring zu einem OO-Design ist noch besser. Sie sollten den Anrufer nicht kennen müssen. Übergeben Sie gegebenenfalls ein Rückrufobjekt.
LoggerFactory.getLogger(MyClass.class)
bei der ich das Klassenliteral nicht weitergeben musste. Es ist immer noch selten das Richtige.
INotifyPropertyChanged
Schnittstelle. Obwohl dieses spezielle Beispiel nicht in Java enthalten ist, kann sich das gleiche Problem manifestieren, wenn versucht wird, Felder / Getter als Zeichenfolgen für Reflection zu modellieren.
JEP 259 bietet eine effiziente Standard-API für das Stack-Walking, mit der die Informationen in Stack-Traces einfach gefiltert und verzögert abgerufen werden können. Vor der Stack-Walking-API wurden häufig auf Stack-Frames zugegriffen:
Throwable::getStackTrace
undThread::getStackTrace
ein Array vonStackTraceElement
Objekten zurückgeben, die den Klassennamen und den Methodennamen jedes Stack-Trace-Elements enthalten.
SecurityManager::getClassContext
ist eine geschützte Methode, mit der eineSecurityManager
Unterklasse auf den Klassenkontext zugreifen kann.JDK-interne
sun.reflect.Reflection::getCallerClass
Methode, die Sie sowieso nicht verwenden sollten
Die Verwendung dieser APIs ist normalerweise ineffizient:
Diese APIs erfordern, dass die VM eifrig einen Snapshot des gesamten Stapels erfasst , und sie geben Informationen zurück, die den gesamten Stapel darstellen. Es gibt keine Möglichkeit, die Kosten für die Prüfung aller Frames zu vermeiden, wenn der Aufrufer nur an den obersten Frames auf dem Stapel interessiert ist.
Um die Klasse des unmittelbaren Anrufers zu finden, erhalten Sie zunächst Folgendes StackWalker
:
StackWalker walker = StackWalker
.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
Dann rufen Sie entweder an getCallerClass()
:
Class<?> callerClass = walker.getCallerClass();
oder walk
das StackFrame
s und bekomme das erste vorhergehende StackFrame
:
walker.walk(frames -> frames
.map(StackWalker.StackFrame::getDeclaringClass)
.skip(1)
.findFirst());
Diese Methode macht dasselbe, aber etwas einfacher und möglicherweise etwas performanter. Wenn Sie Reflektion verwenden, werden diese Frames automatisch übersprungen. Das einzige Problem ist, dass es möglicherweise nicht in Nicht-Sun-JVMs vorhanden ist, obwohl es in den Laufzeitklassen von JRockit 1.4 -> 1.6 enthalten ist. (Punkt ist, es ist keine öffentliche Klasse).
sun.reflect.Reflection
/** Returns the class of the method <code>realFramesToSkip</code>
frames up the stack (zero-based), ignoring frames associated
with java.lang.reflect.Method.invoke() and its implementation.
The first frame is that associated with this method, so
<code>getCallerClass(0)</code> returns the Class object for
sun.reflect.Reflection. Frames associated with
java.lang.reflect.Method.invoke() and its implementation are
completely ignored and do not count toward the number of "real"
frames skipped. */
public static native Class getCallerClass(int realFramesToSkip);
Was den realFramesToSkip
Wert der Sun java.lang.System
1.5- und 1.6-VM-Versionen angeht, gibt es eine paketgeschützte Methode namens getCallerClass (), die aufgerufen wird. sun.reflect.Reflection.getCallerClass(3)
In meiner Hilfsprogrammklasse habe ich jedoch 4 verwendet, da der Hilfsrahmen der Hilfsklasse hinzugefügt wurde Aufruf.
/**
* 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 = new Throwable().getStackTrace();
//System. out.println(ste[ste.length-depth].getClassName()+"#"+ste[ste.length-depth].getMethodName());
return ste[ste.length - depth].getMethodName();
}
Wenn Sie beispielsweise versuchen, die aufrufende Methodenzeile für
Debugzwecke abzurufen , müssen Sie die Utility-Klasse überschreiten, in der Sie diese statischen Methoden codieren : (alter Java1.4-Code, nur um eine mögliche Verwendung von StackTraceElement zu veranschaulichen)
/**
* Returns the first "[class#method(line)]: " of the first class not equal to "StackTraceUtils". <br />
* From the Stack Trace.
* @return "[class#method(line)]: " (never empty, first class past StackTraceUtils)
*/
public static String getClassMethodLine()
{
return getClassMethodLine(null);
}
/**
* Returns the first "[class#method(line)]: " of the first class not equal to "StackTraceUtils" and aclass. <br />
* Allows to get past a certain class.
* @param aclass class to get pass in the stack trace. If null, only try to get past StackTraceUtils.
* @return "[class#method(line)]: " (never empty, because if aclass is not found, returns first class past StackTraceUtils)
*/
public static String getClassMethodLine(final Class aclass)
{
final StackTraceElement st = getCallingStackTraceElement(aclass);
final String amsg = "[" + st.getClassName() + "#" + st.getMethodName() + "(" + st.getLineNumber()
+")] <" + Thread.currentThread().getName() + ">: ";
return amsg;
}
/**
* Returns the first stack trace element of the first class not equal to "StackTraceUtils" or "LogUtils" and aClass. <br />
* Stored in array of the callstack. <br />
* Allows to get past a certain class.
* @param aclass class to get pass in the stack trace. If null, only try to get past StackTraceUtils.
* @return stackTraceElement (never null, because if aClass is not found, returns first class past StackTraceUtils)
* @throws AssertionFailedException if resulting statckTrace is null (RuntimeException)
*/
public static StackTraceElement getCallingStackTraceElement(final Class aclass)
{
final Throwable t = new Throwable();
final StackTraceElement[] ste = t.getStackTrace();
int index = 1;
final int limit = ste.length;
StackTraceElement st = ste[index];
String className = st.getClassName();
boolean aclassfound = false;
if(aclass == null)
{
aclassfound = true;
}
StackTraceElement resst = null;
while(index < limit)
{
if(shouldExamine(className, aclass) == true)
{
if(resst == null)
{
resst = st;
}
if(aclassfound == true)
{
final StackTraceElement ast = onClassfound(aclass, className, st);
if(ast != null)
{
resst = ast;
break;
}
}
else
{
if(aclass != null && aclass.getName().equals(className) == true)
{
aclassfound = true;
}
}
}
index = index + 1;
st = ste[index];
className = st.getClassName();
}
if(resst == null)
{
//Assert.isNotNull(resst, "stack trace should null"); //NO OTHERWISE circular dependencies
throw new AssertionFailedException(StackTraceUtils.getClassMethodLine() + " null argument:" + "stack trace should null"); //$NON-NLS-1$
}
return resst;
}
static private boolean shouldExamine(String className, Class aclass)
{
final boolean res = StackTraceUtils.class.getName().equals(className) == false && (className.endsWith("LogUtils"
) == false || (aclass !=null && aclass.getName().endsWith("LogUtils")));
return res;
}
static private StackTraceElement onClassfound(Class aclass, String className, StackTraceElement st)
{
StackTraceElement resst = null;
if(aclass != null && aclass.getName().equals(className) == false)
{
resst = st;
}
if(aclass == null)
{
resst = st;
}
return resst;
}
Ich habe das schon mal gemacht. Sie können einfach eine neue Ausnahme erstellen und die Stapelverfolgung darauf abrufen, ohne sie zu werfen, und dann die Stapelverfolgung untersuchen. Wie die andere Antwort jedoch sagt, ist es extrem kostspielig - tun Sie es nicht in einer engen Schleife.
Ich habe es bereits für ein Protokollierungsdienstprogramm in einer App getan, bei der die Leistung keine große Rolle spielte (Leistung spielt eigentlich selten eine große Rolle - solange Sie das Ergebnis einer Aktion wie einem schnellen Klicken auf eine Schaltfläche anzeigen).
Bevor Sie den Stack-Trace abrufen konnten, hatten Ausnahmen nur .printStackTrace (), sodass ich System.out in einen Stream meiner eigenen Erstellung umleiten musste, dann (new Exception ()). PrintStackTrace (); Leiten Sie System.out zurück und analysieren Sie den Stream. Lustige Sachen.
private void parseExceptionContents(
final Exception exception,
final OutputStream out)
{
final StackTraceElement[] stackTrace = exception.getStackTrace();
int index = 0;
for (StackTraceElement element : stackTrace)
{
final String exceptionMsg =
"Exception thrown from " + element.getMethodName()
+ " in class " + element.getClassName() + " [on line number "
+ element.getLineNumber() + " of file " + element.getFileName() + "]";
try
{
out.write((headerLine + newLine).getBytes());
out.write((headerTitlePortion + index++ + newLine).getBytes() );
out.write((headerLine + newLine).getBytes());
out.write((exceptionMsg + newLine + newLine).getBytes());
out.write(
("Exception.toString: " + element.toString() + newLine).getBytes());
}
catch (IOException ioEx)
{
System.err.println(
"IOException encountered while trying to write "
+ "StackTraceElement data to provided OutputStream.\n"
+ ioEx.getMessage() );
}
}
}
Hier ist ein Teil des Codes, den ich basierend auf den in diesem Thema gezeigten Hinweisen erstellt habe. Ich hoffe es hilft.
(Fühlen Sie sich frei, Vorschläge zur Verbesserung dieses Codes zu machen, bitte sagen Sie mir)
Der Zähler:
public class InstanceCount{
private static Map<Integer, CounterInstanceLog> instanceMap = new HashMap<Integer, CounterInstanceLog>();
private CounterInstanceLog counterInstanceLog;
public void count() {
counterInstanceLog= new counterInstanceLog();
if(counterInstanceLog.getIdHashCode() != 0){
try {
if (instanceMap .containsKey(counterInstanceLog.getIdHashCode())) {
counterInstanceLog= instanceMap .get(counterInstanceLog.getIdHashCode());
}
counterInstanceLog.incrementCounter();
instanceMap .put(counterInstanceLog.getIdHashCode(), counterInstanceLog);
}
(...)
}
Und das Objekt:
public class CounterInstanceLog{
private int idHashCode;
private StackTraceElement[] arrayStackTraceElements;
private int instanceCount;
private String callerClassName;
private StackTraceElement getProjectClasses(int depth) {
if(depth< 10){
getCallerClassName(sun.reflect.Reflection.getCallerClass(depth).getName());
if(getCallerClassName().startsWith("com.yourproject.model")){
setStackTraceElements(Thread.currentThread().getStackTrace());
setIdHashCode();
return arrayStackTraceElements[depth];
}
//+2 because one new item are added to the stackflow
return getProjectClasses(profundidade+2);
}else{
return null;
}
}
private void setIdHashCode() {
if(getNomeClasse() != null){
this.idHashCode = (getCallerClassName()).hashCode();
}
}
public void incrementaContador() {
this.instanceCount++;
}
//getters and setters
(...)
}
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
class DBConnection {
String createdBy = null;
DBConnection(Throwable whoCreatedMe) {
ByteArrayOutputStream os = new ByteArrayOutputStream();
PrintWriter pw = new PrintWriter(os);
whoCreatedMe.printStackTrace(pw);
try {
createdBy = os.toString();
pw.close();
os.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
public class ThrowableTest {
public static void main(String[] args) {
Throwable createdBy = new Throwable(
"Connection created from DBConnectionManager");
DBConnection conn = new DBConnection(createdBy);
System.out.println(conn.createdBy);
}
}
public static interface ICallback<T> { T doOperation(); }
public class TestCallerOfMethod {
public static <T> T callTwo(final ICallback<T> c){
// Pass the object created at callee to the caller
// From the passed object we can get; what is the callee name like below.
System.out.println(c.getClass().getEnclosingMethod().getName());
return c.doOperation();
}
public static boolean callOne(){
ICallback callBackInstance = new ICallback(Boolean){
@Override
public Boolean doOperation()
{
return true;
}
};
return callTwo(callBackInstance);
}
public static void main(String[] args) {
callOne();
}
}
Verwenden Sie diese Methode: -
StackTraceElement[] stacktrace = Thread.currentThread().getStackTrace();
stackTraceElement e = stacktrace[2];//maybe this number needs to be corrected
System.out.println(e.getMethodName());
Beispiel für einen Aufruf des Methodencodes Code ist hier: -
public class TestString {
public static void main(String[] args) {
TestString testString = new TestString();
testString.doit1();
testString.doit2();
testString.doit3();
testString.doit4();
}
public void doit() {
StackTraceElement[] stacktrace = Thread.currentThread().getStackTrace();
StackTraceElement e = stacktrace[2];//maybe this number needs to be corrected
System.out.println(e.getMethodName());
}
public void doit1() {
doit();
}
public void doit2() {
doit();
}
public void doit3() {
doit();
}
public void doit4() {
doit();
}
}