Log信息獲取調用類和調用方法名的實現原理

2019-11-18 12:03:10

字體：大中小

來源：轉載

供稿：網友

　　Sun JDK 源代碼下載 http://wwws.sun.com/software/communitysource/
　　先注冊并登錄到“Sun Community Source Licensing”，然后下載J2SE（幾十兆）或者J2EE（幾百兆）。
　　
　　Log能夠把代碼運行時間，類名，方法名，還有信息，全部都打印出來。
　　一個直觀的例子，每次啟動Tomcat（缺省配置）的時候。一般可以看到
　　Jul 9, 2004 11:22:29 AM org.apache.struts.util.PRopertyMessageResources
　　INFO: Initializing, config='org.apache.webapp.admin.applicationResources', returnNull=true
　　Jul 9, 2004 11:22:41 AM org.apache.coyote.http11.Http11Protocol start
　　INFO: Starting Coyote HTTP/1.1 on port 8080
　　
　　時間，類名，方法名，信息都打印了出來。
　　那么，log是如何獲取調用自身的這個類和這個方法名的呢？
　　
　　后面給出的代碼是JDK1.4的源代碼，和Log4J的源代碼。說明其實現原理。
　　獲得調用類，和方法名，就是需要獲得當前運行棧的結構。
　　new Throwable().getStackTrace() 會返回當前運行棧的結構層次。
　　利用這種原理，可以獲得整個運行棧的調用關系。
　　
　　JDK1.4的java.util.logging包，通過Throwable.getStackTrace()方法實現的。
　　// Get the stack trace.
　　StackTraceElement stack[] = (new Throwable()).getStackTrace();
　　
　　完整的代碼在JDK1.4的源代碼里面，java.util.logging.LogRecord類的inferCaller方法。
　　
　　java代碼:
　　2　// Private method to infer the caller's class and method names
　　3　private void inferCaller() {
　　...}
　　4　needToInferCaller = false;
　　5　// Get the stack trace.
　　6　StackTraceElement stack[] = (new Throwable()).getStackTrace();
　　7　// First, search back to a method in the Logger class.
　　8　int ix = 0;
　　9　while (ix < stack.length) {
　　...}
　　10 StackTraceElement frame = stack[ix];
　　11 String cname = frame.getClassName();
　　12 if (cname.equals("java.util.logging.Logger")) {
　　...}
　　13 break;
　　14 }
　　15 ix++;
　　16 }
　　17 // Now search for the first frame before the "Logger" class.
　　18 while (ix < stack.length) {
　　...}
　　19 StackTraceElement frame = stack[ix];
　　20 String cname = frame.getClassName();
　　21 if (!cname.equals("java.util.logging.Logger")) {
　　...}
　　22 // We've found the relevant frame.
　　23 setSourceClassName(cname);
　　24 setSourceMethodName(frame.getMethodName());
　　25 return;
　　26 }
　　27 ix++;
　　28 }
　　29 // We haven't found a suitable frame, so just punt. This is
　　30 // OK as we are only commited to making a "best effort" here.
　　31 }
　　32
　　
　　Log4j有異曲同工之妙。
　　org.apache.log4j.spi.LocationInfo類。
　　先用Throwable.printStackTrace()方法把Exception信息打印到一個字符串里。
　　然后按行分析這個字符串。抽出調用類和方法。參見LocationInfo類的構造函數。
　　
　　java代碼:
　　1
　　2　/**
　　3　Instantiate location information based on a Throwable. We
　　4　eXPect the Throwable t, to be in the format
　　5
　　6　


　　7　java.lang.Throwable
　　8　...
　　9　at org.apache.log4j.PatternLayout.format(PatternLayout.java:413)
　　10 at org.apache.log4j.FileAppender.doAppend(FileAppender.java:183)
　　11 at org.apache.log4j.Category.callAppenders(Category.java:131)
　　12 at org.apache.log4j.Category.log(Category.java:512)
　　13 at callers.fully.qualified.className.methodName(FileName.java:74)
　　14 ...
　　15

　　16
　　17

上一篇：應用Java技術實現數據庫應用系統

下一篇：我來說說Bean的使用方法