Мені потрібно знайти абонента методу. Чи можливо за допомогою стек-трактування або відображення?
DontNameYourMethodFooException
якщо метод виклику називається foo.
Мені потрібно знайти абонента методу. Чи можливо за допомогою стек-трактування або відображення?
DontNameYourMethodFooException
якщо метод виклику називається foo.
Відповіді:
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace()
Відповідно до Javadocs:
Останній елемент масиву являє собою нижню частину стека, що є найменшим викликом методу в послідовності.
StackTraceElement
Має getClassName()
, getFileName()
, getLineNumber()
і getMethodName()
.
Вам доведеться поекспериментувати, щоб визначити, який індекс ви хочете (можливо, stackTraceElements[1]
чи [2]
).
Альтернативне рішення можна знайти в коментарі до цього запиту щодо вдосконалення . Він використовує getClassContext()
метод custom SecurityManager
і здається, що він швидший, ніж метод стеження стека.
Наступна програма тестує швидкість різних запропонованих методів (найцікавіший біт - у внутрішньому класі 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.");
}
}
Приклад виходу з мого 2,4-ГГц Intel Core 2 Duo MacBook під керуванням Java 1.6.0_17:
Reflection: 10.195 ms.
Current Thread StackTrace: 5886.964 ms.
Throwable StackTrace: 4700.073 ms.
SecurityManager: 1046.804 ms.
Метод внутрішнього відображення набагато швидший, ніж інші. Отримання сліду стека від новоствореного Throwable
швидше, ніж отримання його з поточного Thread
. І серед не внутрішніх способів пошуку класу виклику звичай SecurityManager
здається найшвидшим.
Як lyomi вказує на цей коментарsun.reflect.Reflection.getCallerClass()
метод був відключений за замовчуванням в Java 7 оновлень 40 і повністю видалені в Java 8. Більш детально про це в цьому питанні в базі даних помилок Java .
Як з'ясували zammbi , Oracle змушений був відмовитися від змін, які усунули sun.reflect.Reflection.getCallerClass()
. Він все ще доступний у Java 8 (але він застарілий).
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.
Здається, ви намагаєтеся уникати посилання this
на метод. Пройти this
набагато краще, ніж знайти абонента через поточний слід стека. Реконструкція на більш OO дизайн ще краще. Вам не потрібно знати особу, що телефонує. Якщо потрібно, передайте об'єкт зворотного дзвінка.
LoggerFactory.getLogger(MyClass.class)
де мені не довелося проходити в класі буквально. Це все ще рідко правильно робити.
INotifyPropertyChanged
інтерфейсу .NET . Хоча цей конкретний приклад відсутній у Java, та сама проблема може проявлятися при спробі моделювати поля / getters як рядки для Reflection.
JEP 259 забезпечує ефективний стандартний API для ходіння по стеках, що дозволяє легко фільтрувати інформацію та ледачий доступ до інформації у стеках стеків. Перед API Stack-Walking поширеними способами доступу до фреймів стека були:
Throwable::getStackTrace
іThread::getStackTrace
повернути масивStackTraceElement
об'єктів, який містить ім'я класу та ім'я кожного елемента стека-сліду.
SecurityManager::getClassContext
це захищений метод, який дозволяєSecurityManager
підкласу отримати доступ до контексту класу.Внутрішній
sun.reflect.Reflection::getCallerClass
метод JDK, який ви не повинні використовувати
Використання цих API зазвичай неефективне:
Ці API вимагають від VM охоче робити знімок всього стека , і вони повертають інформацію, що представляє весь стек. Неможливо уникнути витрат на вивчення всіх кадрів, якщо абонента цікавлять лише перші кілька кадрів на стеку.
Для того, щоб знайти клас безпосереднього абонента, спочатку отримайте StackWalker
:
StackWalker walker = StackWalker
.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
Тоді або телефонуйте getCallerClass()
:
Class<?> callerClass = walker.getCallerClass();
або walk
в StackFrame
s і отримати перший попередній StackFrame
:
walker.walk(frames -> frames
.map(StackWalker.StackFrame::getDeclaringClass)
.skip(1)
.findFirst());
Цей метод робить те саме, але трохи простіше і, можливо, трохи ефективніше, і якщо ви використовуєте роздуми, він автоматично пропускає ці кадри. Єдине питання полягає в тому, що він може бути відсутнім у JVM, що не є Sun, хоча він включений до класів виконання JRockit 1.4 -> 1.6. (Справа в тому, що це не громадський клас).
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
, існує захищений пакунком метод, який називається getCallerClass (), який викликає sun.reflect.Reflection.getCallerClass(3)
, але в моєму допоміжному класі я використовував 4, оскільки є доданий кадр допоміжного класу. виклик.
/**
* 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, в якому ви
кодуєте ці статичні методи: (старий код java1.4, просто для ілюстрації потенційного використання StackTraceElement)
/**
* 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;
}
Я робив це раніше. Ви можете просто створити новий виняток і захопити слід стека на ньому, не кидаючи його, а потім вивчити слід стека. Як говорить інша відповідь, це надзвичайно дорого - не робіть цього в тісному циклі.
Я робив це раніше для утиліти журналу в додатку, де продуктивність не мала великого значення (продуктивність рідко має значення багато, насправді - поки ви показуєте результат такої дії, як швидке натискання кнопки).
Це було раніше, ніж ви могли отримати трасування стека, винятки просто мали .printStackTrace (), тому мені довелося перенаправити System.out на потік мого власного створення, тоді (новий виняток ()). PrintStackTrace (); Перенаправляйте System.out назад і розбирайте потік. Веселі речі.
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() );
}
}
}
Ось частина коду, яку я склав на підставі підказок, показаних у цій темі. Сподіваюся, це допомагає.
(Не соромтеся робити будь-які пропозиції щодо вдосконалення цього коду, будь ласка, скажіть мені)
Лічильник:
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
(...)
}
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();
}
}
використовувати цей метод: -
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();
}
}