关于UtilTimerStack类的使用--XWork2、Struts2内置性能诊断类

关于UtilTimerStack类的使用--XWork2、Struts2内置性能诊断类

一、UtilTimerStack做什么用的？
这个本来是Xwork2（Struts2的核心）的相关的工具类，可以用来测试一些逻辑操作所消耗的时间（以毫秒为单位），其本身使用一个 ArrayList作为存放ProfilingTimerBean的容器，而行为以Stack栈（后入先出）为主。在打印的时候支持缩进显示，显示相关的 调用关系。类ProfilingTimerBean主要是用来记录一些相关的信息，例如主要标识、开始时间、结束时间。

二、UtilTimerStack如何使用？
UtilTimerStack的调用方法不多且都为静态函数，但在调用之前必须先开启诊断功能，

主要有以下三种方法开启：

•    在启动时加入参数： -Dxwork.profile.activate=true

•    在使用前、或者静态代码区、或者Servlet的初始化、或者Filter的初始化 加入代码：

                           UtilTimerStack.setActivate(true);
                      或者 System.setProperty("xwork.profile.activate", "true");
                      或者 System.setProperty(UtilTimerStack.ACTIVATE_PROPERTY, "true");

•    也支持xml来定义相关拦截器（必须开启dev模式和加入Profiling拦截器）：

                     <action ... > 
                      ...
                      <interceptor-ref name="profiling">
                          <param name="profilingKey">profiling</param>
                      </interceptor-ref>
                      ...
                     </action>
                     再通过URL访问： http://host:port/context/namespace/someAction.action?profiling=true
                     或者通过代码加入请求参数： ActionContext.getContext().getParameters().put("profiling", "true);

指定超时打印功能，只有当运行时间超过时才会进行记录，开启方法：

•     在启动时加入参数： -Dxwork.profile.mintime=1000
•     或者代码加入：System.setProperty(UtilTimerStack.MIN_TIME, "" + 1000);

例子代码：

public static void main(String[] args) throws InterruptedException {
    String name = "test used time:";
    UtilTimerStack.setActive(true);  //开启诊断功能
    System.setProperty(UtilTimerStack.MIN_TIME, "" + 1000); //设置最小的超时记录时间
    UtilTimerStack.push(name); //顶节点的记录Bean
    subMethod(0);
    UtilTimerStack.pop(name);//对应的出栈操作,名称与入栈时相同
}
public static void subMethod(int i) throws InterruptedException{
    System.out.println(i + "");
    UtilTimerStack.push(i + " times");
    if(i<3) subMethod(i+1); //递归调用，会产生缩进，最后调用i=3时不足1000，不记录
    Thread.sleep(i * 300);
    UtilTimerStack.pop(i + " times");
}

代码输出：
0
1
2
3
2010-3-21 16:16:52 com.opensymphony.xwork2.util.logging.commons.CommonsLogger info
信息: [1828ms] - test used time:
  [1828ms] - 0 times
    [1828ms] - 1 times
      [1516ms] - 2 times
 


三、UtilTimerStack内部机制？

ProfilingTimerBean类结构
    主要成员：
    List<ProfilingTimerBean> children;//记录子节点为，打印时需要
    ProfilingTimerBean parent = null;//记录父节点，顶点的父节点为null
    String resource;//主要标识，名称
    long startTime;//开始时间
    long totalTime;//结束时间


UtilTimerStack的压栈（push）动作：

public static void push(String name)
{
    if (!isActive())  //判断是否开启诊断功能
        return;
    //创建新的记录Bean,并用setStartTime方法开始记录
    ProfilingTimerBean newTimer = new ProfilingTimerBean(name);
    newTimer.setStartTime();
    //判断如果有父节点,则添加到父节点的Child中.
    ProfilingTimerBean currentTimer = (ProfilingTimerBean) current.get();
    if (currentTimer != null)
    {
        currentTimer.addChild(newTimer);
    }
    //再把新建的节点设置为当前的线程的局部变量current中.
    current.set(newTimer);
}

   

UtilTimerStack的出栈（pop）动作:

public static void pop(String name)
{
    if (!isActive())
        return;
    //获取当前线程的变量current.get()返回顶部记录Bean
    ProfilingTimerBean currentTimer = (ProfilingTimerBean) current.get();
    //if the timers are matched up with each other (ie push("a"); pop("a"));
    //测试出栈的记录Bean是否与要求的对应,如果不对应则log下错误,并打印栈里的记录Bean信息
    //如果与要求的标识对应,则把父节点设置为当前节点.
    if (currentTimer != null && name != null && name.equals(currentTimer.getResource()))
    {
        currentTimer.setEndTime();
        ProfilingTimerBean parent = currentTimer.getParent();
        //如果当前节点为根节点,则开始打印这个栈里面的记录Bean信息
        if (parent == null)
        {
            printTimes(currentTimer);
            //清理当前的线程局部变量,防止一些容器使用线程池的方式处理请求.
            current.set(null);
        }
        else
        {
            //设置父节点为当前节点.
            current.set(parent);
        }
    }
    else
    {
        //当出栈的顺序不对称时,把剩下的都打印出来
        if (currentTimer != null)
        {
            printTimes(currentTimer);
            current.set(null);
            LOG.warn("Unmatched Timer.  Was expecting " + currentTimer.getResource() + ", instead got " + name);
        }
    }

}