一、問題的引入
我們在java程序中使用日志功能(JDK Log或者Log4J)的時候,會發現Log系統會自動幫我們打印出豐富的信息,格式一般如下:
[運行時間] [當前類名] [方法名]
INFO: [用戶信息]
具體例子如Tomcat啟動信息:
Jul 9, 2004 11:22:41 AM org.apache.coyote.http11.Http11PRotocol start
INFO: Starting Coyote HTTP/1.1 on port 8080
看起來這毫無神奇之處,不就是打印了一條信息嗎?但假如好奇心重一點,追尋后面的實現原理,會發現這確實很神奇。上面的Log信息的[當前類名] [方法名]部分 不是用戶自己添加的,而是Log系統自動添加的。這意味著Log系統能夠自動判定當前執行語句是哪個類的哪個方法。這是如何做到的?
我們翻遍java.lang.reflection package,幻想著找到一個Statement語句級別的Reflection類,通過這個Statement對象獲得Method,然后通過這個Method獲得declared Class。這不就獲得對應的Class和Method信息了嗎?這是一個不錯的構想,但也只能是一個構想;因為沒有這個Statement對象。
再想一下。對了,Java不是有一個Thread類嗎?Thread.currentThread()方法獲取當前線程,我們能不能通過這個當前線程獲取當前運行的Method和Class呢?很遺憾,假如你還在用JDK1.4或以下版本,那么找不到這樣的方法。(JDK1.5的情況后面會講)
再想一下。對了,我們都有很深刻的印象,當系統拋出Exception的時候,總是打印出一串的信息,告訴我們Exception發生的位置,和一層一層的調用關系。我們也可以自己調用Exception的printStackTrace()方法來打印這些信息。這不就是當前線程運行棧的信息嗎?找到了,就是它。
Exception的printStackTrace()方法繼續自Throwable,那么我們來看一下,JDK的Throwable的printStackTrace()方法是如何實現的。
我們先來看JDK1.3的源代碼,會發現Throwable.printStackTrace()方法調用了一個native printStackTrace0()方法。我們找不到任何線索,可以用在我們自己的Java代碼中。
那怎么辦?Throwable.printStackTrace()的輸出結果字符串里面不是包含了當前線程運行棧的所有信息嗎?我們可以從這個字符串中抽取自己需要的信息。JDK1.3的時代,也只能這么做了。
二、Log4J 1.2的相關實現
Log4J 1.2是JDK1.3時代的作品。我們來看相關源代碼。
[code]
/**
Instantiate location information based on a Throwable. We
eXPect the Throwable t
, to be in the format
java.lang.Throwable
...
at org.apache.log4j.PatternLayout.format(PatternLayout.java:413)
at org.apache.log4j.FileAppender.doAppend(FileAppender.java:183)
at org.apache.log4j.Category.callAppenders(Category.java:131)
at org.apache.log4j.Category.log(Category.java:512)
at callers.fully.qualified.className.methodName(FileName.java:74)
...
*/
public LocationInfo(Throwable t, String fqnOfCallingClass) {
String s;
…
t.printStackTrace(pw);
s = sw.toString();
sw.getBuffer().setLength(0);
…. // 這里的代碼省略
}
[/code]
這里我們可以看到整體的實現思路。
首先,t.printStackTrace(pw); 獲得stack trace字符串。這個t是 new Throwable()的結果。用戶程序調用Log4J方法之后,Log4J自己又進行了4次調用,然后才獲得了 t = new Throwable() :
at org.apache.log4j.PatternLayout.format(PatternLayout.java:413)
at org.apache.log4j.FileAppender.doAppend(FileAppender.java:183)
at org.apache.log4j.Category.callAppenders(Category.java:131)
at org.apache.log4j.Category.log(Category.java:512)
那么,往下走4行,就可以回到用戶程序本身的調用信息:
at callers.fully.qualified.className.methodName(FileName.java:74)
這一行里面,類名、方法名、文件名、行號等信息全有了。解析這一行,就可以獲得需要的所有信息。
新聞熱點
疑難解答