Saya perlu menemukan penelepon metode. Apakah mungkin menggunakan stacktrace atau refleksi?
DontNameYourMethodFooException
jika metode panggilan bernama foo.
Saya perlu menemukan penelepon metode. Apakah mungkin menggunakan stacktrace atau refleksi?
DontNameYourMethodFooException
jika metode panggilan bernama foo.
Jawaban:
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace()
Menurut Javadocs:
Elemen terakhir dari array mewakili bagian bawah tumpukan, yang merupakan permohonan metode terbaru dalam urutan.
Sebuah StackTraceElement
memiliki getClassName()
, getFileName()
, getLineNumber()
dan getMethodName()
.
Anda harus bereksperimen untuk menentukan indeks mana yang Anda inginkan (mungkin stackTraceElements[1]
atau [2]
).
Solusi alternatif dapat ditemukan dalam komentar untuk permintaan peningkatan ini . Ia menggunakan getClassContext()
metode kustom SecurityManager
dan tampaknya lebih cepat daripada metode jejak tumpukan.
Program berikut menguji kecepatan berbagai metode yang disarankan (bit paling menarik adalah di kelas batin 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.");
}
}
Contoh output dari 2,4 GHz Intel Core 2 Duo MacBook saya yang menjalankan Java 1.6.0_17:
Reflection: 10.195 ms.
Current Thread StackTrace: 5886.964 ms.
Throwable StackTrace: 4700.073 ms.
SecurityManager: 1046.804 ms.
Metode Refleksi internal jauh lebih cepat daripada yang lain. Mendapatkan jejak stack dari yang baru dibuat Throwable
lebih cepat daripada mendapatkannya dari saat ini Thread
. Dan di antara cara-cara non-internal untuk menemukan kelas pemanggil kebiasaan SecurityManager
tampaknya menjadi yang tercepat.
Seperti yang ditunjukkan oleh lyomi dalam komentar ini , sun.reflect.Reflection.getCallerClass()
metode ini telah dinonaktifkan secara default di Java 7 pembaruan 40 dan dihapus sepenuhnya di Java 8. Baca lebih lanjut tentang ini dalam masalah ini di database bug Java .
Seperti yang ditemukan zammbi , Oracle terpaksa mundur dari perubahan yang menghapus sun.reflect.Reflection.getCallerClass()
. Ini masih tersedia di Java 8 (tetapi sudah usang).
3 tahun setelah: Pembaruan tepat waktu dengan JVM saat ini.
> 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.
Kedengarannya seperti Anda mencoba menghindari melewatkan referensi ke this
dalam metode. Melewati this
lebih baik daripada menemukan penelepon melalui jejak tumpukan saat ini. Refactoring ke desain yang lebih OO bahkan lebih baik. Anda tidak perlu tahu penelepon. Lewati objek panggilan balik jika perlu.
LoggerFactory.getLogger(MyClass.class)
mana saya tidak harus lulus dalam literal kelas. Masih jarang hal yang benar untuk dilakukan.
INotifyPropertyChanged
antarmuka .NET . Meskipun contoh khusus ini tidak ada di Jawa, masalah yang sama dapat muncul dengan sendirinya ketika mencoba memodelkan bidang / getter sebagai string untuk Reflection.
JEP 259 menyediakan API standar yang efisien untuk tumpukan berjalan yang memungkinkan penyaringan mudah, dan akses malas ke, informasi dalam jejak tumpukan. Sebelum Stack-Walking API, cara umum mengakses frame stack adalah:
Throwable::getStackTrace
danThread::getStackTrace
mengembalikan arrayStackTraceElement
objek, yang berisi nama kelas dan nama metode setiap elemen stack-trace.
SecurityManager::getClassContext
adalah metode yang dilindungi, yang memungkinkanSecurityManager
subkelas untuk mengakses konteks kelas.
sun.reflect.Reflection::getCallerClass
Metode internal JDK yang seharusnya tidak Anda gunakan
Menggunakan API ini biasanya tidak efisien:
API ini membutuhkan VM untuk dengan penuh semangat menangkap snapshot dari seluruh tumpukan , dan mereka mengembalikan informasi yang mewakili seluruh tumpukan. Tidak ada cara untuk menghindari biaya memeriksa semua frame jika penelepon hanya tertarik pada beberapa frame teratas di stack.
Untuk menemukan kelas pemanggil langsung, pertama-tama dapatkan StackWalker
:
StackWalker walker = StackWalker
.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
Kemudian panggil getCallerClass()
:
Class<?> callerClass = walker.getCallerClass();
atau walk
yang StackFrame
s dan yang pertama sebelumnya StackFrame
:
walker.walk(frames -> frames
.map(StackWalker.StackFrame::getDeclaringClass)
.skip(1)
.findFirst());
Metode ini melakukan hal yang sama tetapi sedikit lebih sederhana dan mungkin sedikit lebih berkinerja dan jika Anda menggunakan refleksi, ia melompati frame-frame itu secara otomatis. Satu-satunya masalah adalah itu mungkin tidak hadir dalam JVM non-Sun, meskipun itu termasuk dalam kelas runtime dari JRockit 1.4 -> 1.6. (Intinya, ini bukan kelas publik ).
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);
Sejauh apa realFramesToSkip
nilainya, versi Sun 1.5 dan 1.6 VM java.lang.System
, ada metode paket terproteksi yang disebut getCallerClass () yang memanggil sun.reflect.Reflection.getCallerClass(3)
, tetapi di kelas utilitas pembantu saya, saya menggunakan 4 karena ada bingkai tambahan dari kelas pembantu doa.
/**
* 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();
}
Misalnya, jika Anda mencoba untuk mendapatkan garis metode pemanggilan untuk tujuan debug, Anda harus melewati kelas Utilitas tempat Anda mengkode metode statis tersebut:
(kode java1.4 lama, hanya untuk menggambarkan potensi penggunaan 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;
}
Saya pernah melakukan ini sebelumnya. Anda bisa membuat pengecualian baru dan ambil jejak tumpukan tanpa membuangnya, lalu periksa jejak tumpukan tersebut. Seperti jawaban lain mengatakan, itu sangat mahal - jangan lakukan itu dalam lingkaran yang ketat.
Saya telah melakukannya sebelumnya untuk utilitas pencatatan pada aplikasi yang kinerjanya tidak terlalu berarti (Kinerja jarang penting sama sekali, sebenarnya - selama Anda menampilkan hasilnya pada tindakan seperti klik tombol dengan cepat).
Itu sebelum Anda bisa mendapatkan jejak stack, pengecualian baru saja. PrintStackTrace () jadi saya harus mengarahkan System.out ke aliran kreasi saya sendiri, lalu (Pengecualian baru ()). PrintStackTrace (); Redirect System.out kembali dan parsing aliran. Hal menyenangkan.
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() );
}
}
}
Berikut adalah bagian dari kode yang saya buat berdasarkan petunjuk yang ditunjukkan dalam topik ini. Semoga ini bisa membantu.
(Jangan ragu untuk membuat saran untuk meningkatkan kode ini, tolong beri tahu saya)
Penghitung:
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);
}
(...)
}
Dan obyeknya:
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();
}
}
gunakan metode ini: -
StackTraceElement[] stacktrace = Thread.currentThread().getStackTrace();
stackTraceElement e = stacktrace[2];//maybe this number needs to be corrected
System.out.println(e.getMethodName());
Kode contoh metode penelepon ada di sini: -
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();
}
}