线程运行栈信息的获取(1)

一、问题的引入

我们在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)

这一行里面，类名、方法名、文件名、行号等信息全有了。解析这一行，就可以获得需要的所有信息。