一、問(wèn)題的引入

我們?cè)?a href="http://www.companysz.com/article.asp?typeid=160">java程序中使用日志功能（JDK Log或者Log4J）的時(shí)候，會(huì)發(fā)現(xiàn)Log系統(tǒng)會(huì)自動(dòng)幫我們打印出豐富的信息，格式一般如下：

[運(yùn)行時(shí)間] [當(dāng)前類名] [方法名]

INFO: [用戶信息]

具體例子如Tomcat啟動(dòng)信息：

Jul 9, 2004 11:22:41 AM org.apache.coyote.http11.Http11PRotocol start

INFO: Starting Coyote HTTP/1.1 on port 8080

看起來(lái)這毫無(wú)神奇之處，不就是打印了一條信息嗎？但假如好奇心重一點(diǎn)，追尋后面的實(shí)現(xiàn)原理，會(huì)發(fā)現(xiàn)這確實(shí)很神奇。上面的Log信息的[當(dāng)前類名] [方法名]部分 不是用戶自己添加的，而是Log系統(tǒng)自動(dòng)添加的。這意味著Log系統(tǒng)能夠自動(dòng)判定當(dāng)前執(zhí)行語(yǔ)句是哪個(gè)類的哪個(gè)方法。這是如何做到的？

我們翻遍java.lang.reflection package，幻想著找到一個(gè)Statement語(yǔ)句級(jí)別的Reflection類，通過(guò)這個(gè)Statement對(duì)象獲得Method，然后通過(guò)這個(gè)Method獲得declared Class。這不就獲得對(duì)應(yīng)的Class和Method信息了嗎？這是一個(gè)不錯(cuò)的構(gòu)想，但也只能是一個(gè)構(gòu)想；因?yàn)闆](méi)有這個(gè)Statement對(duì)象。

再想一下。對(duì)了，Java不是有一個(gè)Thread類嗎？Thread.currentThread()方法獲取當(dāng)前線程，我們能不能通過(guò)這個(gè)當(dāng)前線程獲取當(dāng)前運(yùn)行的Method和Class呢？很遺憾，假如你還在用JDK1.4或以下版本，那么找不到這樣的方法。（JDK1.5的情況后面會(huì)講）

再想一下。對(duì)了，我們都有很深刻的印象，當(dāng)系統(tǒng)拋出Exception的時(shí)候，總是打印出一串的信息，告訴我們Exception發(fā)生的位置，和一層一層的調(diào)用關(guān)系。我們也可以自己調(diào)用Exception的printStackTrace()方法來(lái)打印這些信息。這不就是當(dāng)前線程運(yùn)行棧的信息嗎？找到了，就是它。

Exception的printStackTrace()方法繼續(xù)自Throwable，那么我們來(lái)看一下，JDK的Throwable的printStackTrace()方法是如何實(shí)現(xiàn)的。

我們先來(lái)看JDK1.3的源代碼，會(huì)發(fā)現(xiàn)Throwable.printStackTrace()方法調(diào)用了一個(gè)native printStackTrace0()方法。我們找不到任何線索，可以用在我們自己的Java代碼中。

那怎么辦？Throwable.printStackTrace()的輸出結(jié)果字符串里面不是包含了當(dāng)前線程運(yùn)行棧的所有信息嗎？我們可以從這個(gè)字符串中抽取自己需要的信息。JDK1.3的時(shí)代，也只能這么做了。

二、Log4J 1.2的相關(guān)實(shí)現(xiàn)

Log4J 1.2是JDK1.3時(shí)代的作品。我們來(lái)看相關(guān)源代碼。

[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]

這里我們可以看到整體的實(shí)現(xiàn)思路。

首先，t.printStackTrace(pw); 獲得stack trace字符串。這個(gè)t是 new Throwable()的結(jié)果。用戶程序調(diào)用Log4J方法之后，Log4J自己又進(jìn)行了4次調(diào)用，然后才獲得了 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行，就可以回到用戶程序本身的調(diào)用信息：

at callers.fully.qualified.className.methodName(FileName.java:74)

這一行里面，類名、方法名、文件名、行號(hào)等信息全有了。解析這一行，就可以獲得需要的所有信息。