web-dev-qa-db-ja.com

スタックトレースまたはリフレクションを使用してメソッドの呼び出し元を見つける方法は?

メソッドの呼び出し元を見つける必要があります。スタックトレースまたはリフレクションを使用しても可能ですか?

366
Sathish
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace()

Javadocsによると:

配列の最後の要素は、スタックの最後を表します。これは、シーケンス内で最も新しいメソッドの呼び出しです。

StackTraceElementgetClassName()getFileName()getLineNumber()そしてgetMethodName()を持ちます。

どのインデックスが欲しいかを決めるために実験する必要があります(おそらくstackTraceElements[1]または[2])。

391
Adam Paynter

代替の解決策は、 この機能強化の要求 へのコメントにあります。これはカスタムSecurityManagergetClassContext()メソッドを使用しており、スタックトレースメソッドよりも高速です。

次のプログラムは、さまざまな推奨メソッドの速度をテストします(最も興味深いのは内部クラス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.");
  }
}

Java 1.6.0_17を実行している私の2.4 GHz Intel Core 2 Duo MacBookからの出力の例:

Reflection: 10.195 ms.
Current Thread StackTrace: 5886.964 ms.
Throwable StackTrace: 4700.073 ms.
SecurityManager: 1046.804 ms.

内部のReflectionメソッドは他のものよりはるかに高速です。新しく作成されたThrowableからスタックトレースを取得することは、現在のThreadから取得するよりも高速です。そして、呼び出し側クラスを見つけるための非内部的な方法の中では、カスタムのSecurityManagerが最も速いようです。

更新

lyomiこのコメント で指摘しているように、Java 7 update 40ではSun.reflect.Reflection.getCallerClass()メソッドはデフォルトで無効にされ、Java 8では完全に削除されました Javaバグデータベースのこの問題

アップデート2

zammbiが発見したように、Oracleは 変更を取り消すことを余儀なくされましたSun.reflect.Reflection.getCallerClass()を削除しました。それはまだJava 8で利用可能です(しかしそれは非推奨です)。

アップデート3

3年後:現在の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.
207
Johan Kaving

メソッドにthisへの参照を渡さないようにしているようです。 thisを渡すことは、現在のスタックトレースを通して呼び出し元を見つけるよりもずっと優れています。 もっとOOデザインにリファクタリングすることはさらに良いです。呼び出し側を知る必要はないはずです。必要に応じてコールバックオブジェクトを渡します。

34
Craig P. Motlin

Java 9 - JEP 259:スタックウォーキングAPI

JEP 259 は、スタックトレース内の情報を簡単にフィルタリングし、それに遅延アクセスすることを可能にする効率的なスタックウォーキング用標準APIを提供します。 Stack-Walking APIが登場する前は、スタックフレームにアクセスする一般的な方法は次のとおりです。

Throwable::getStackTraceThread::getStackTraceは、各スタックトレース要素のクラス名とメソッド名を含むStackTraceElementオブジェクトの配列を返します。

SecurityManager::getClassContextはprotectedメソッドで、SecurityManagerサブクラスがクラスコンテキストにアクセスできるようにします。

とにかく使うべきではないJDK内部のSun.reflect.Reflection::getCallerClassメソッド

これらのAPIを使用することは通常非効率的です。

これらのAPIは、スタック全体のスナップショットを積極的にキャプチャするためにVMを必要とし、スタック全体を表す情報を返します。呼び出し側がスタックの一番上の数フレームだけに関心がある場合は、すべてのフレームを調べるコストを回避する方法はありません。

直接の呼び出し元のクラスを見つけるために、まずStackWalkerを取得します。

StackWalker walker = StackWalker
                           .getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);

その後、getCallerClass()を呼び出します。

Class<?> callerClass = walker.getCallerClass();

またはwalkStackFramesにして、最初の先行するStackFrameを取得します。

walker.walk(frames -> frames
      .map(StackWalker.StackFrame::getDeclaringClass)
      .skip(1)
      .findFirst());
25
Ali Dehghani

オネリナー

Thread.currentThread().getStackTrace()[2].getMethodName()

2を1に置き換える必要があるかもしれないことに注意してください。

11
Andro Secy

この方法でも同じことができますが、もう少し単純で、場合によってはもう少しパフォーマンスがよくなります。リフレクションを使用している場合は、これらのフレームは自動的にスキップされます。唯一の問題は、Sun以外のJVMには存在しない可能性があることです。ただし、JRockit 1.4 - > 1.6の実行時クラスには含まれています。 (要は、publicクラスではありません)。

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);

realFramesToSkipの値、Sun 1.5および1.6 VMバージョンのJava.lang.Systemには、Sun.reflect.Reflection.getCallerClass(3)を呼び出すgetCallerClass()というパッケージ保護メソッドがありますが、私のヘルパーユーティリティクラスでは4を使用しています。ヘルパークラス呼び出しの追加フレーム.

10
Nicholas
     /**
       * 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();
      }

たとえば、デバッグ目的で呼び出しメソッド行を取得しようとした場合は、これらの静的メソッドをコーディングするUtilityクラスを通過する必要があります。
(潜在的なStackTraceElementの使用法を説明するためだけの古いJava 1.4コード)

        /**
          * 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;
      }
6
VonC

私は前にこれをやった。新しい例外を作成し、それをスローせずにスタックトレースを取得してから、スタックトレースを調べることができます。しかし他の答えが言うように、それは非常に高価です - きついループでそれをしないでください。

パフォーマンスがあまり問題にならないアプリのロギングユーティリティに対して以前に行ったことがあります(実際には、ボタンクリックなどのアクションに結果を表示する限り、パフォーマンスはあまり重要ではありません)。

それはあなたがスタックトレースを取得することができる前でした、例外はちょうど.printStackTrace()を持っていたので、私はSystem.outを私自身の作成のストリームにリダイレクトしなければなりませんでした、そして(new Exception())。printStackTrace(); System.outをリダイレクトしてストリームを解析します。楽しいもの.

6
Bill K
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() );
         }
      }
   }
1
AZ_

これは、このトピックで示したヒントに基づいて作成したコードの一部です。それが役に立てば幸い。

(このコードを改善するための提案を遠慮なくしてください、教えてください)

カウンタ:

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);
    }

    (...)
}

そしてオブジェクト:

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

    (...)



}
0
Pmt

この方法を使用します: -

 StackTraceElement[] stacktrace = Thread.currentThread().getStackTrace();
 stackTraceElement e = stacktrace[2];//maybe this number needs to be corrected
 System.out.println(e.getMethodName());

メソッド例の呼び出し元は以下のとおりです。 -

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();
    }
}
0
Reegan Miranda
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);
    }
}

OR

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();
    }
}
0