我们在Java程序中使用日志功能(JDK Log或者Log4J)的时候,会发现Log系统会自动帮我们打印出丰富的信息,格式一般如下:为了免去解析StackTrace字符串的麻烦,JDK1.4引入了一个新的类,StackTraceElement。

  一、问题的引入

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

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

  三、JDK1.4 Log的相关实现

  Log4J大获成功,Sun决定在JDK1.4中引入这个Log功能。

  为了免去解析StackTrace字符串的麻烦,JDK1.4引入了一个新的类,StackTraceElement。

  public final class StackTraceElement implements java.io.Serializable {

  // Normally initialized by VM (public constructor added in 1.5)

  private String declaringClass;

  private String methodName;

  private String fileName;

  private int lineNumber;

  可以看到,恰好包括类名、方法名、文件名、行号等信息。

  我们来看JDK1.4 Log的相关实现。

  LocationInfo.java 的infoCaller方法(推算调用者)

  // Private method to infer the callers class and method names

  private void inferCaller() {

  …

  // Get the stack trace.

  StackTraceElement stack[] = (new Throwable()).getStackTrace();

  // First, search back to a method in the Logger class.

  …. // 这里的代码省略

  // Now search for the first frame before the "Logger" class.

  while (ix

  StackTraceElement frame = stack[ix];

  String cname = frame.getClassName();

  if (!cname.equals("java.util.logging.Logger"))

  // Weve found the relevant frame.

  … // 这里的代码省略

  }

  // We haven found a suitable frame, so just punt. This is

  // OK as we are only committed to making a "best effort" here.

  }

  从注释中就可以看出实现思路。过程和Log4J异曲同工。只是免去了解析字符串的麻烦。

  四、Log4J 1.3 Alpha的相关实现

  既然JDK1.4中引入了StackTraceElement类,Log4J也要与时俱进。LocationInfo类也有了相应的变化。

  /**

  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)

  ...

  However, we can also deal with JIT compilers that "lose" the

  location information, especially between the parentheses.

  */

  public LocationInfo(Throwable t, String fqnOfInvokingClass) {

  if(PlatformInfo.hasStackTraceElement()) {

  StackTraceElementExtractor.extract(this, t, fqnOfInvokingClass);

  } else {

  LegacyExtractor.extract(this, t, fqnOfInvokingClass);

  }

  }

  可以看到,Log4J首先判断Java平台是否支持StackTraceElement,如果是,那么用StackTraceElementExtractor,否则使用原来的LegacyExtractor。

  下面来看StackTraceElementExtractor.java

  /**

  * A faster extractor based on StackTraceElements introduced in JDK 1.4.

  *

  * The present code uses reflection. Thus, it should compile on all platforms.

  *

  * @author Martin Schulz

  * @author Ceki Gülcü

  *

  */

  public class StackTraceElementExtractor {

  protected static boolean haveStackTraceElement = false;

  private static Method getStackTrace = null;

  private static Method getClassName = null;

  private static Method getFileName = null;

  private static Method getMethodName = null;

  private static Method getLineNumber = null;

  …. // 以下代码省略

  可以看到,Log4J 1.3仍然兼容JDK1.3,而且为JDK1.4也做了相应的优化。

  五、JDK1.5的Thread Stack Trace

  JDK1.5在Thread类里面引入了getStackTrace()和getAllStackTraces()两个方法。这下子,我们不用 (new Throwable()).getStackTrace ();可以调用

  Thread.getCurrentThread().getStackTrace()来获得当前线程的运行栈信息。不仅如此,只要权限允许,还可以获得其它线程的运行栈信息。

  /**

  * Returns an array of stack trace elements representing the stack dump

  * of this thread. This method will return a zero-length array if

  * this thread has not started or has terminated.

  * If the returned array is of non-zero length then the first element of

  * the array represents the top of the stack, which is the most recent

  * method invocation in the sequence. The last element of the array

  * represents the bottom of the stack, which is the least recent method

  * invocation in the sequence.

  *

  *

  If there is a security manager, and this thread is not

  * the current thread, then the security managers

  * checkPermissionmethod is called with a

  * RuntimePermission("getStackTrace")permission

  * to see if its ok to get the stack trace.

  *

  *

  Some virtual Machines may, under some circumstances, omit one

  * or more stack frames from the stack trace. In the extreme case,

  * a virtual machine that has no stack trace information concerning

  * this thread is permitted to return a zero-length array from this

  * method.

  *

  * @return an array of StackTraceElement,

  * each represents one stack frame.

  *

  * @since 1.5

  */

  public StackTraceElement[] getStackTrace() {

  if (this != Thread.currentThread()) {

  // check for getStackTrace permission

  SecurityManager security = System.getSecurityManager();

  if (security != null) {

  security.checkPermission(

  SecurityConstants.GET_STACK_TRACE_PERMISSION);

  }

  }

  if (!isAlive()) {

  return EMPTY_STACK_TRACE;

  }

  Thread[] threads = new Thread[1];

  threads[0] = this;

  StackTraceElement[][] result = dumpThreads(threads);

  return result[0];

  }

  /**

  * Returns a map of stack traces for all live threads.

  *

  * @since 1.5

  */

  public static Map getAllStackTraces() {

  // check for getStackTrace permission

  // Get a snapshot of the list of all threads

  }

  六、总结

  从总的发展趋势来看,JDK不仅提供越来越多、越来越强的功能,而且暴露给用户的控制方法越来越多,越来越强大。

Java高级--Java线程运行栈信息的获取 getStackTrace()的更多相关文章

  1. Android 利用线程运行栈StackTraceElement设计Android日志模块

    如果你想在你的Android程序中自动打印MainActivity.onCreate(line:37)这种类名.方法名(行数)的日志该如何实现呢? 1.引入Java的线程运行栈 Java.lang包中 ...

  2. Java高级之线程同步

    本文来自http://blog.csdn.net/liuxian13183/ ,引用必须注明出处! 关于实现多线程的意义,"从业四年看并发"一文已经讲述,而本篇主要讲一下常用的设计 ...

  3. java高级---->Java动态代理的原理

    Java动态代理机制的出现,使得 Java 开发人员不用手工编写代理类,只要简单地指定一组接口及委托类对象,便能动态地获得代理类.代理类会负责将所有的方法调用分派到委托对象上反射执行,在分派执行的过程 ...

  4. Java Spring 在线程中或其他位置获取 ApplicationContext 或 ServiceBean

    部分一转载自:http://blog.csdn.net/yang123111/article/details/32099329 via @yang123111 部分二转载自:http://www.cn ...

  5. java高级---->Java观察者的原理

    观察者模式定义了一种一对多的依赖关系,让多个观察者对象同时监听某一个主题对象.这个主题对象在状态上发生变化时,会通知所有观察者对象,让他们能够自动更新自己.今天我们通过模拟按钮的处理事件来深入Java ...

  6. JAVA高级--java泛型

    类型的参数化 泛型类可以同时设置多个参数 泛型类可以继承泛型类 泛型类可以实现泛型接口 示例--泛型类 package com.date; public class GenericDemo { pub ...

  7. java高级 - java利用listener实现回调,即观察者模式

    https://blog.csdn.net/lin_sir6/article/details/70052954

  8. Java并发3-多线程面试题

    1) 什么是线程? 线程是操作系统能够进行运算调度的最小单位,它被包含在进程之中,是进程中的实际运作单位.程序员可以通过它进行多处理器编程,你可以使用多线程对运算密集型任务提速. 2) 线程和进程有什 ...

  9. Java并发--Java线程面试题 Top 50

    原文链接:http://www.importnew.com/12773.html 不管你是新程序员还是老手,你一定在面试中遇到过有关线程的问题.Java语言一个重要的特点就是内置了对并发的支持,让Ja ...

随机推荐

  1. ASP.NET Web API 控制器创建过程(二)

    ASP.NET Web API 控制器创建过程(二) 前言 本来这篇随笔应该是在上周就该写出来发布的,由于身体跟不上节奏感冒发烧有心无力,这种天气感冒发烧生不如死,也真正的体会到了什么叫病来如山倒,病 ...

  2. Material Design入门(三)

    本文主要包括 CollapsingToolbarLayout实现滚动动画效果 ViewPager+tabLayout实现左右类Tab效果 控件介绍 这次需要用到得新控件比较多,主要有以下几个: Coo ...

  3. Android仿计算器界面

    代码如下: <?xml version="1.0" encoding="utf-8"?> <TableLayout xmlns:android ...

  4. OracleINSERT提示IGNORE_ROW_ON_DUPKEY_INDEX

    OracleINSERT提示IGNORE_ROW_ON_DUPKEY_INDEX insert提示IGNORE_ROW_ON_DUPKEY_INDEX 在 insert into table a() ...

  5. ControlsFX8.0.2中对话框无法判断是否显示的修改

    在org.controlsfx.dialog.FXDialog.java中加入 public abstract boolean isShowing(); 在org.controlsfx.dialog. ...

  6. 微软IOC容器Unity简单代码示例1

    @(编程) 1. 通过Nuget下载Unity 这个就不介绍了 2. 接口代码 namespace UnityDemo { interface ILogIn { void Login(); } } 3 ...

  7. 【BZOJ 2440】[中山市选2011]完全平方数

    Description 小 X 自幼就很喜欢数.但奇怪的是,他十分讨厌完全平方数.他觉得这些数看起来很令人难受.由此,他也讨厌所有是完全平方数的正整数倍的数.然而这丝毫不影响他对其他数的热爱. 这天是 ...

  8. 阿里云oss总是提示SignatureDoesNotMatch错误怎么办

    网上的所有阿里云oss(C#)的例子几乎试遍了,为什么还是提示SignatureDoesNotMatch错误?什么原因?怎么办?下载一个阿里云提供的windows客户端发现,依然提示签名错误. 开始怀 ...

  9. My Answer in Regex Golf

    Warm Up Answer: foo Point(3) Anchors Answer: k$ Point(2) It never ends $ not allowed Answer: fu\b Po ...

  10. scheduleAtFixedRate 与 scheduleWithFixedDelay 的区别

    总结: scheduleAtFixedRate ,是以上一个任务开始的时间计时,period时间过去后,检测上一个任务是否执行完毕,如果上一个任务执行完毕,则当前任务立即执行,如果上一个任务没有执行完 ...