ฉันต้องการค้นหาผู้เรียกใช้ของวิธีการ เป็นไปได้โดยใช้ stacktrace หรือ reflect?
DontNameYourMethodFooException
ถ้าวิธีการโทรชื่อ foo
ฉันต้องการค้นหาผู้เรียกใช้ของวิธีการ เป็นไปได้โดยใช้ stacktrace หรือ reflect?
DontNameYourMethodFooException
ถ้าวิธีการโทรชื่อ foo
คำตอบ:
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace()
อ้างอิงจาก Javadocs:
องค์ประกอบสุดท้ายของอาร์เรย์แสดงถึงด้านล่างของสแต็กซึ่งเป็นการเรียกใช้วิธีล่าสุดอย่างน้อยที่สุดในลำดับ
StackTraceElement
มีgetClassName()
, getFileName()
, และgetLineNumber()
getMethodName()
คุณจะต้องทดสอบเพื่อกำหนดดัชนีที่คุณต้องการ (อาจจะstackTraceElements[1]
หรือ[2]
)
วิธีการแก้ปัญหาทางเลือกที่สามารถพบได้ในความคิดเห็นที่คำขอนี้สำหรับการเพิ่มประสิทธิภาพ มันใช้getClassContext()
วิธีการของการกำหนดเอง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 GHz 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 เป็นสตริงสำหรับการสะท้อน
JEP 259มี API มาตรฐานที่มีประสิทธิภาพสำหรับการเดินสแต็กที่อนุญาตให้กรองได้ง่ายและเข้าถึงข้อมูลในร่องรอยสแต็กได้อย่างง่ายดาย ก่อน Stack-Walking API วิธีการเข้าถึงเฟรมสแต็กทั่วไปคือ:
Throwable::getStackTrace
และThread::getStackTrace
ส่งกลับอาร์เรย์ของอStackTraceElement
อบเจกต์ซึ่งมีชื่อคลาสและชื่อเมธอดขององค์ประกอบการติดตามสแต็กแต่ละตัว
SecurityManager::getClassContext
เป็นวิธีการป้องกันซึ่งช่วยให้SecurityManager
subclass เข้าถึงบริบทของชั้นเรียน
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
StackFrame
walker.walk(frames -> frames
.map(StackWalker.StackFrame::getDeclaringClass)
.skip(1)
.findFirst());
Oneliner :
Thread.currentThread().getStackTrace()[2].getMethodName()
โปรดทราบว่าคุณอาจต้องแทนที่ 2 ด้วย 1
วิธีนี้ทำในสิ่งเดียวกัน แต่ก็ง่ายขึ้นและอาจมีประสิทธิภาพมากกว่าเล็กน้อยและในกรณีที่คุณใช้การสะท้อนมันจะข้ามเฟรมเหล่านั้นโดยอัตโนมัติ ปัญหาเดียวคือมันอาจไม่มีใน 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();
}
ตัวอย่างเช่นถ้าคุณพยายามรับบรรทัดวิธีการโทรเพื่อจุดประสงค์ในการแก้ไขปัญหาคุณจะต้องผ่านคลาสยูทิลิตี้ที่คุณใช้รหัสวิธีการคงที่เหล่านั้น:
(รหัส 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;
}
ฉันเคยทำมาก่อน คุณสามารถสร้างข้อยกเว้นใหม่และคว้าการติดตามสแต็กโดยไม่ทิ้งมันจากนั้นตรวจสอบสแต็กการติดตาม อย่างที่คำตอบอื่นบอกไว้ว่ามันมีค่าใช้จ่ายสูงมาก - อย่าทำอย่างนั้น
ฉันเคยทำมาก่อนแล้วสำหรับยูทิลิตี้การบันทึกในแอปที่ประสิทธิภาพไม่ได้สำคัญอะไรมาก (ประสิทธิภาพไม่ค่อยสำคัญเท่าไหร่จริง ๆ แล้ว - ตราบใดที่คุณแสดงผลการดำเนินการเช่นการคลิกปุ่มอย่างรวดเร็ว)
ก่อนหน้านี้คุณจะได้รับ stack trace ยกเว้นว่ามี. printStackTrace () ดังนั้นฉันจึงต้องเปลี่ยนเส้นทาง System.out ไปยังกระแสการสร้างของฉันเองจากนั้น (new Exception ()) printStackTrace (); เปลี่ยนเส้นทาง System.out back และวิเคราะห์กระแสข้อมูล สิ่งที่สนุก.
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();
}
}