Eu preciso encontrar o chamador de um método. É possível usar stacktrace ou reflexão?
DontNameYourMethodFooException
se o método de chamada é nomeado foo.
Eu preciso encontrar o chamador de um método. É possível usar stacktrace ou reflexão?
DontNameYourMethodFooException
se o método de chamada é nomeado foo.
Respostas:
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace()
De acordo com os Javadocs:
O último elemento da matriz representa a parte inferior da pilha, que é a invocação de método menos recente na sequência.
Um StackTraceElement
tem getClassName()
, getFileName()
, getLineNumber()
e getMethodName()
.
Você precisará experimentar para determinar qual índice deseja (provavelmente stackTraceElements[1]
ou [2]
).
Uma solução alternativa pode ser encontrada em um comentário a esta solicitação de aprimoramento . Ele usa o getClassContext()
método de um costume SecurityManager
e parece ser mais rápido que o método de rastreamento de pilha.
O programa a seguir testa a velocidade dos diferentes métodos sugeridos (o bit mais interessante está na classe interna 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.");
}
}
Um exemplo da saída do meu MacBook Intel Core 2 Duo de 2,4 GHz executando Java 1.6.0_17:
Reflection: 10.195 ms.
Current Thread StackTrace: 5886.964 ms.
Throwable StackTrace: 4700.073 ms.
SecurityManager: 1046.804 ms.
O método interno de reflexão é muito mais rápido que os outros. Obter um rastreamento de pilha de um recém-criado Throwable
é mais rápido do que obtê-lo do atual Thread
. E entre as formas não internas de encontrar a classe de quem chama, o costume SecurityManager
parece ser o mais rápido.
Como lyomi aponta neste comentário, o sun.reflect.Reflection.getCallerClass()
método foi desativado por padrão na atualização 40 do Java 7 e removido completamente no Java 8. Leia mais sobre isso nesta edição no banco de dados de erros do Java .
Como o zammbi descobriu, a Oracle foi forçada a desistir da mudança que removeu o sun.reflect.Reflection.getCallerClass()
. Ele ainda está disponível no Java 8 (mas está obsoleto).
3 anos depois: Atualização sobre o tempo com a JVM atual.
> 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.
Parece que você está tentando evitar passar uma referência para this
o método. Passar this
é muito melhor do que encontrar o chamador através do rastreamento de pilha atual. Refatorar para um design mais OO é ainda melhor. Você não precisa conhecer o chamador. Passe um objeto de retorno de chamada, se necessário.
LoggerFactory.getLogger(MyClass.class)
qual eu não precisei passar na classe literal. Ainda raramente é a coisa certa a fazer.
INotifyPropertyChanged
interface .NET . Embora este exemplo específico não esteja em Java, o mesmo problema pode se manifestar ao tentar modelar campos / getters como seqüências de caracteres para o Reflection.
O JEP 259 fornece uma API padrão eficiente para movimentação de pilha que permite filtragem fácil e acesso lento às informações nos rastreamentos de pilha. Antes da API Stack-Walking, formas comuns de acessar quadros de pilha eram:
Throwable::getStackTrace
eThread::getStackTrace
retorne uma matriz deStackTraceElement
objetos, que contém o nome da classe e o nome do método de cada elemento de rastreamento de pilha.
SecurityManager::getClassContext
é um método protegido, que permite que umaSecurityManager
subclasse acesse o contexto da classe.
sun.reflect.Reflection::getCallerClass
Método interno do JDK que você não deve usar de qualquer maneira
O uso dessas APIs geralmente é ineficiente:
Essas APIs exigem que a VM capture um instantâneo de toda a pilha e retorne informações que representam a pilha inteira. Não há como evitar o custo de examinar todos os quadros se o chamador estiver interessado apenas nos poucos quadros superiores da pilha.
Para encontrar a classe do chamador imediato, primeiro obtenha um StackWalker
:
StackWalker walker = StackWalker
.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
Em seguida, ligue para getCallerClass()
:
Class<?> callerClass = walker.getCallerClass();
ou walk
os StackFrame
e obtenha o primeiro precedente StackFrame
:
walker.walk(frames -> frames
.map(StackWalker.StackFrame::getDeclaringClass)
.skip(1)
.findFirst());
Esse método faz a mesma coisa, mas um pouco mais simples e possivelmente um pouco mais eficiente e, no caso de você estar usando reflexão, ele pula esses quadros automaticamente. O único problema é que ele pode não estar presente em JVMs que não são da Sun, embora esteja incluído nas classes de tempo de execução do JRockit 1.4 -> 1.6. (O ponto é que não é uma classe pública ).
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);
Quanto ao realFramesToSkip
valor, nas versões Sun 1.5 e 1.6 VM de java.lang.System
, existe um método protegido por pacote chamado getCallerClass () que chama sun.reflect.Reflection.getCallerClass(3)
, mas, na minha classe de utilitário auxiliar, usei 4, pois há o quadro adicional da classe auxiliar invocação.
/**
* 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();
}
Por exemplo, se você tentar obter a linha do método de chamada para fins de depuração, precisará passar pela classe Utility na qual codifica esses métodos estáticos:
(código java1.4 antigo, apenas para ilustrar um uso potencial de 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;
}
Eu já fiz isso antes. Você pode simplesmente criar uma nova exceção e pegar o rastreamento de pilha sem lançá-lo e, em seguida, examinar o rastreamento de pilha. Como a outra resposta diz, é extremamente caro - não faça isso em um loop apertado.
Eu já fiz isso antes para um utilitário de registro em um aplicativo em que o desempenho não importava muito (o desempenho raramente importa muito, na verdade - desde que você mostre o resultado de uma ação como clicar rapidamente em um botão).
Foi antes que você pudesse obter o rastreamento de pilha, as exceções tinham apenas .printStackTrace (), então eu tive que redirecionar System.out para um fluxo de minha própria criação, depois (new Exception ()). PrintStackTrace (); Redirecione System.out para trás e analise o fluxo. Coisas divertidas.
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() );
}
}
}
Aqui está uma parte do código que eu criei com base nas dicas mostradas neste tópico. Espero que ajude.
(Sinta-se à vontade para fazer sugestões para melhorar esse código, informe-me)
O contador:
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);
}
(...)
}
E o objeto:
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();
}
}
use este método: -
StackTraceElement[] stacktrace = Thread.currentThread().getStackTrace();
stackTraceElement e = stacktrace[2];//maybe this number needs to be corrected
System.out.println(e.getMethodName());
Exemplo de chamada do método Code is here: -
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();
}
}